search

alexcasalboni / aws-lambda-power-tuning

AWS Lambda Power Tuning is an open-source tool that can help you visualize and fine-tune the memory/power configuration of Lambda functions. It runs in your own AWS account - powered by AWS Step Functions - and it supports three optimization strategies: cost, speed, and balanced.
Apache License 2.0
5.5k stars 379 forks source link

Add optional description field for output report #188

Open alexcasalboni opened 1 year ago

alexcasalboni commented 1 year ago

This could be as simple as an optional "description" or "notes" field in the state machine intput, that will be passed as is to the state machine output, mainly to explain the context/configuration of the power-tuning execution.

dougtoppin commented 1 year ago

Including the note/description in the results page would be useful. This allows a record of what the conditions of the test were without having to refer back to the execution output. An example would be if the payload for the Lambda might refer to large or small data to be processed

alexcasalboni commented 1 year ago

@dougtoppin then it's a job for https://github.com/matteo-ronchetti/aws-lambda-power-tuning-ui (plus some integration code in the analyzer.js function).

So far, I've been hesitant to add too much information to the visualization page to avoid issues related to privacy. That page doesn't need any sensitive/confidential information to be rendered (Account IDs, ARNs, etc.).

A generic description isn't necessarily sensitive, but it could contain confidential information. In that case, organizations might become more careful with sharing those public visualization URLs.

Thoughts?