serverless-dashboard v1.0.0
serverless-dashboard-plugin
Serverless plugin to generate AWS CloudWatch dashboard for deployed Lambdas and API Gateway.
Requirements:
- Serverless v1.12.x or higher
- AWS provider
Setup
Installation
Install via npm in the root of your Serverless service:
npm install --save-dev serverless-dashboard
Then inside your project's serverless.yml file add following entry to the plugins section: serverless-dashboard
. If there is no plugin section you will need to add it to the file.
It should look something like this:
plugins:
- serverless-dashboard
Configuration
The plugin can be configured by adding a property called serverlessDashboard
to the custom properties of the Serverless
service. Following widgets are currently supported:
- Lambda Widget
- API Gateway Widget
Lambda Widgets
Lambda widgets can be globally deactivated for all functions by adding an enabled
flag to the configuration and setting it to false
. By default they are enabled.
serverlessDashboard:
lambda:
enabled: false
API Gateway Widget
One widget is created for API Gateway resource, even if there are many Lambdas triggered by HTTP events. This widget can be globally deactivated by adding an enabled
flag to the configuration and setting it to false
. By default they are enabled for applications which have HTTP triggered Lambdas.
serverlessDashboard:
apiGateway:
enabled: false
Command line options
--dashboardLambda Set to true or false, overrides enabled flag in serverless.yml
--dashboardApiGateway Set to true or false, overrides enabled flag in serverless.yml
Options passed on the command line override YAML options.
Usage
Once configured the plugin will run each time you deploy your serverless app and update CloudWatch dashboard to the current structure of the app.
The message seen after deploy
Created Dashboard
On deleting the stack from the command line, the plugin will delete the dashboard.
AWS Permissions
Listed below are AWS permissions needed for a sucessful deploy with serverless-dashboard-plugin
cloudwatch:PutDashboard
to be able to create or modify dashboardscloudwatch:DeleteDashboards
to be able to delete dashboardsapigateway:GET
to be able to check for available APIs
To view the dashboard afterwards following permissions are required
cloudwatch:GetDashboard
cloudwatch:ListDashboards
AWS Dashboard limits
Reaching these limits is improbable.
Up to 100 metrics per dashboard widget. Up to 500 metrics per dashboard, across all widgets.
These quotas include all metrics retrieved for use in metric math functions, even if those metrics are not displayed on the graph.
These quotas cannot be changed.
See the full list of CloudWatch Service Quotas
AWS CloudWatch pricing
See the full list of Amazon CloudWatch pricing
4 years ago