rafalwilinski / cloudwatch-public-metrics Goto Github PK

Expose AWS Cloudwatch Metrics as a public HTML page using AWS Lambda and server-side rendering

JavaScript 100.00%

aws aws-lambda aws-cloudwatch nodejs serverless server-side-rendering serverless-framework metrics

cloudwatch-public-metrics's Introduction

Expose AWS Cloudwatch Metrics as a public HTML page using AWS Lambda and server-side rendering, for free. Inspired by Yan Cui's concept & status.github.com

Demo

Todo - my AWS account estimated charges

Usage

First, ensure that you have Serverless Framework installed. If not, install it:

$ npm install serverless -g

Clone the repo, install dependencies and deploy function:

$ git clone https://github.com/RafalWilinski/cloudwatch-public-metrics
$ npm install
$ npm run deploy

Config

cloudwatch-public-metrics can be configured in two ways:

Using config.yml file:

METRIC_NAME: <Use "Namespace//MetricName" format e.g.: AWS/Billing//EstimatedCharges>   *required*
METRIC_TITLE: <Add custom title like: "Total AWS Charges">
METRIC_DURATION: <EndDate - StartDate e.g: "7 days">                                    *required*
METRIC_STATISTIC: <One of: ["Average", "Sum", "SampleCount", "Minimum", "Maximum"]>     *required*
METRIC_DIMENSIONS: <Comma separated array of Name=Value pair e.g.: "Currency=USD,InstanceId=123">
METRIC_SUFFIX: <For instance "%", "ms" or "$">
USAGE_PLAN: <Rate limiting configuration, see: https://serverless.com/framework/docs/providers/aws/guide/serverless.yml/>

Using CLI flags:

$ npm run deploy -- \
 --metricName AWS/Billing//EstimatedCharges \
 --metricTitle Estimated\ Charges \
 --metricDuration 15\ days \
 --metricStatistic Average \
 --metricDimensions Currency\=USD \
 --metricSuffix \$

Development

AWS_REGION=us-east-1 npm run watch

License

MIT © Rafal Wilinski

Credits

Logo by Dinosoft Labs

cloudwatch-public-metrics's People

Contributors

Stargazers

Watchers

Forkers

toketunji anibus

cloudwatch-public-metrics's Issues

Add interactivity to chart

Right now whole page is 100% static and does not allow any interactions.

Question: Do you believe that adding interactions to chart would be beneficial?

Decrease artifact size

Right now service zip file is 17.25 MB which is definitely too big for such simple app.

Update lambda runtime to latest LTS

Support using `--flags` as configuration option

Instead of using config.yml it should be possible to specify cfg values using flags with npm run deploy command.

Add rate limiting

To prevent DDoS attacks, it should be possible to config rate limiting. It is possible to setup it inside API Gateway options but does Serverless framework supports that? Need to check.

Add eslint setup

To prevent basic bugs and enforce consistent codestyle, eslint should be added.

Add ability to expose multiple metrics at once

As title says. Building simple dashboards should be also possible.

I have a notion that it would require change the way how config is passed to lambda function. Instead of using env variables which are a bit primitive, config should be hardcoded before deployment and expressed in .js file?

Fix lambda permissions

After deploying function to AWS, seems like Lambda has incorrect IAM policies attached:

AccessDenied: User: arn:aws:sts::085108115628:assumed-role/lambda-dashboard-dev-us-east-1-lambdaRole/lambda-dashboard-dev-main is not authorized to perform: cloudwatch:GetMetricStatistics
    at Request.extractError (/var/runtime/node_modules/aws-sdk/lib/protocol/query.js:47:29)
    at Request.callListeners (/var/runtime/node_modules/aws-sdk/lib/sequential_executor.js:105:20)
    at Request.emit (/var/runtime/node_modules/aws-sdk/lib/sequential_executor.js:77:10)
    at Request.emit (/var/runtime/node_modules/aws-sdk/lib/request.js:683:14)
    at Request.transition (/var/runtime/node_modules/aws-sdk/lib/request.js:22:10)
    at AcceptorStateMachine.runTo (/var/runtime/node_modules/aws-sdk/lib/state_machine.js:14:12)

Change line interpolation method

https://monosnap.com/file/sMWnbYY8aSREVoaRXVoGAHjiMdDznK

Due to current interpolation method some values are represented inaccurately.

Add tests

Preferably using Jest.