@middy/cloudwatch-metrics

Middy CloudWatch metrics middleware

Metrics middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

You can read the documentation at: https://middy.js.org/docs/middlewares/cloudwatch-metrics

This middleware hydrates lambda's context.metrics property with an instance of MetricLogger. This instance can be used to easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on 3rd party software.

Metrics collected with this logger are then available for querying within AWS CloudWatch Log Insights

You can explore all the MetricLogger APIs following aws-embedded-metrics documentation.

Install

To install this middleware you can use NPM:

npm install --save @middy/cloudwatch-metrics

Options

• namespace (string) (default aws-embedded-metrics): Sets the CloudWatch namespace that extracted metrics should be published to.
• dimensions (Record<String, String>[]): Defaults to

  [
      {"ServiceName": "myLambdaFunctionName"},
      {"ServiceType": "AWS::Lambda::Function"},
      {"LogGroupName": "logGroupNameUsedByMyLambda"},
  ]
  

  Explicitly override all dimensions. This will remove the default dimensions. You can provide an empty array to record all metrics without dimensions.

Sample usage

import middy from '@middy/core'
import cloudwatchMetrics from '@middy/cloudwatch-metrics'

const handler = middy((event, context) => {
    context.metrics.putMetric("ProcessingLatency", 100, "Milliseconds");
    context.metrics.setProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8")
})

handler.use(cloudwatchMetrics({
    namespace: "myAppliction",
    dimensions: [
        { "Action": "Buy" }
    ]
}))

Middy documentation and examples

For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2018 Luciano Mammino and the Middy team.