serverless-cloudwatch-dashboard

A serverless plugin for generating a cloudwatch dashboard with widgets for the resources defined in the serverless.yml file.

Install

npm install serverless-cloudwatch-dashboard

Usage

serverless.yml

In the serverless.yml file the plugin needs to be added.

1plugins:
2  - serverless-cloudwatch-dashboard

This will add the plugin and dashboards will be created. If you want to configure the widgets that are created, you will in addition need to add a custom config. This must be done under the custom property.

1custom:
2  serverless-cloudwatch-dashboard:
3    dynamodb:
4      metrics:
5        - ReturnedBytes

If you don't specify the metrics it will use default metrics for the resource. The defaults is listed below.

Supported resources

Lambda

The functions that are created by serverless is fully supported. The following metrics are supported:

• Invocations
• Errors
• Dead Letter Errors
• Duration
• Throttles
• IteratorAge
• ConcurrentExceptions
• UnreservedConcurrentExceptions

Defaults:

• Invocations
• Errors
• Duration

To view documentation on the metrics, please see the official AWS documentation here:
https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions-metrics.html

DynamoDb

DynamoDb is fully supported. The following metrics are supported:

• ConditionalCheckFailedRequests
• ConsumedReadCapacityUnits
• ConsumedWriteCapacityUnits
• ReadThrottleEvents
• ReturnedBytes
• ReturnedItemCount
• ReturnedRecordsCount
• SuccessfulRequestLatency
• SystemErrors
• TimeToLiveDeletedItemCount
• ThrottledRequests
• UserErrors
• WriteThrottleEvent

Defaults:

• ConsumedReadCapacityUnits
• ConsumedWriteCapacityUnits

To view documentation on the metrics, please see the official AWS documentation here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/dynamo-metricscollected.html

EC2

EC2 is fully supported. Please note that not all metrics is available for all instances. Please consult official documentation on which metrics that are available for which instance. These metrics are supported:

• CPUCreditUsage
• CPUCreditBalance
• CPUSurplusCreditBalance
• CPUSurplusCreditsCharged
• CPUUtilization
• DiskReadOps
• DiskWriteOps
• DiskReadBytes
• DiskWriteBytes
• NetworkIn
• NetworkOut
• NetworkPacketsIn
• NetworkPacketsOut
• EBSReadOps
• EBSWriteOps
• EBSReadBytes
• EBSWriteBytes
• EBSIOBalance%
• EBSByteBalance%

Defaults:

• CPUUtilization

To view documentation on the metrics, please see the official AWS documentation here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ec2-metricscollected.html

S3

S3 is fully supported. The following metrics are supported:

• BucketSizeBytes
• NumberOfObjects
• AllRequests
• GetRequests
• PutRequests
• DeleteRequests
• HeadRequests
• PostRequests
• SelectRequests
• ListRequests
• BytesDownloaded
• BytesUploaded
• 4xxErrors
• 5xxErrors
• FirstByteLatency
• TotalRequestLatency

Defaults:

• GetRequests
• PutRequests

To view documentation on the metrics, please see the official AWS documentation here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/s3-metricscollected.html

Example

Example yaml file.

1service: test
2
3frameworkVersion: ">=1.1.0"
4
5custom:
6  bucket: test 
7  serverless-cloudwatch-dashboard:
8    dynamodb:
9      metrics:
10        - ReturnedBytes
11plugins:
12  - serverless-cloudwatch-dashboard
13
14provider:
15  name: aws
16  runtime: nodejs4.3
17  stage: dev
18  region: eu-west-1
19  iamRoleStatements:
20    - Effect: Allow
21      Action:
22        - s3:PutObject
23      Resource: "arn:aws:s3:::${self:custom.bucket}/*"
24
25functions:
26  save:
27    handler: handler.save
28    environment:
29      BUCKET: ${self:custom.bucket}
30resources:
31  Resources:
32    ec2:
33      Type: AWS::EC2::Instance
34      Properties: 
35        InstanceType: t2.micro
36        ImageId: ami-7dbc4004
37    testtable:
38      Type: AWS::DynamoDB::Table
39      Properties:
40        AttributeDefinitions:
41          - AttributeName: firstName
42            AttributeType: S
43        KeySchema:
44          - AttributeName: firstName
45            KeyType: HASH
46        ProvisionedThroughput:
47          ReadCapacityUnits: 1
48          WriteCapacityUnits: 1
49        TableName: test
50    tests3:
51      Type: AWS::S3::Bucket
52      Properties: 
53        BucketName: somebucket

Current limitations

• You must specify table name or bucket name when defining s3/dynamodb resources.
• It is not possible to have different metrics for different resources of the same type.
• A lot of resources is not supported.
• It's impossible to customize the layout of the dashboard. Some of these issues may be resolved in the future.

If you find a bug, please add it to the issues on github.