serverless-plugin-datadog

What is serverless-plugin-datadog?

The serverless-plugin-datadog npm package is designed to integrate Datadog monitoring and observability features into Serverless Framework applications. It allows you to automatically instrument your AWS Lambda functions with Datadog, enabling you to monitor performance, track metrics, and set up alerts.

What are serverless-plugin-datadog's main functionalities?

Automatic Instrumentation

This feature automatically instruments your AWS Lambda functions with Datadog. By adding the plugin to your Serverless Framework configuration and setting the appropriate custom options, you can enable Datadog layers, flush metrics to logs, and set the log level.

{
  "plugins": ["serverless-plugin-datadog"],
  "custom": {
    "datadog": {
      "addLayers": true,
      "flushMetricsToLogs": true,
      "logLevel": "info"
    }
  }
}

Custom Metrics

This feature allows you to enable custom metrics for your Lambda functions. By setting the `customMetrics` option to true, you can send custom metrics from your Lambda functions to Datadog.

{
  "custom": {
    "datadog": {
      "customMetrics": true
    }
  }
}

Tracing

This feature enables tracing for your Lambda functions. By setting `enableXrayTracing` and `enableDDTracing` to true, you can enable AWS X-Ray and Datadog tracing, respectively, to get detailed insights into your function's performance.

{
  "custom": {
    "datadog": {
      "enableXrayTracing": true,
      "enableDDTracing": true
    }
  }
}

Other packages similar to serverless-plugin-datadog

serverless-plugin-splunk

The serverless-plugin-splunk package integrates Splunk logging and monitoring with Serverless Framework applications. It provides similar functionalities to serverless-plugin-datadog, such as automatic instrumentation and custom metrics, but it is tailored for Splunk's monitoring and observability tools.

serverless-plugin-aws-alerts

The serverless-plugin-aws-alerts package allows you to set up AWS CloudWatch alerts for your Serverless Framework applications. While it does not provide the same level of integration with a third-party monitoring service like Datadog, it offers a way to monitor and alert on AWS Lambda function performance using AWS-native tools.

README

Datadog Serverless Plugin

Datadog recommends the Serverless Framework Plugin for developers using the Serverless Framework to deploy their serverless applications. The plugin automatically configures ingestion of metrics, traces, and logs from your serverless applications by:

• Installing and configuring the Datadog Lambda library for your Python and Node.js Lambda functions.
• Enabling the collection of enhanced Lambda metrics and custom metrics from your Lambda functions.
• Managing subscriptions from the Datadog Forwarder to your Lambda function log groups.

Getting started

To quickly get started, follow the installation instructions for Python or Node.js, and view your function's enhanced metrics, traces, and logs in Datadog. These instructions will get you a basic working setup.

More configuration options

To further configure your plugin, use the following custom parameters in your serverless.yml:

Parameter	Description
flushMetricsToLogs	Send custom metrics by using logs with the Datadog Forwarder Lambda function (recommended). Defaults to true. If you disable this parameter, it's required to set the parameters site and apiKey (or apiKMSKey if encrypted).
site	Set which Datadog site to send data, only needed when flushMetricsToLogs is false. Defaults to datadoghq.com. Set to datadoghq.eu for the Datadog EU site.
apiKey	Datadog API Key, only needed when flushMetricsToLogs is false. For more information about getting a Datadog API key, see the API key documentation.
apiKMSKey	Datadog API Key encrypted using KMS. Use this parameter in place of apiKey when flushMetricsToLogs is false, and you are using KMS encryption.
addLayers	Whether to install the Datadog Lambda library as a layer. Defaults to true. Set to false when you plan to package the Datadog Lambda library to your function's deployment package on your own so that you can install a specific version of the Datadog Lambda library (Python or Node.js).
logLevel	The log level, set to DEBUG for extended logging. Defaults to info.
enableXrayTracing	Set true to enable X-Ray tracing on the Lambda functions and API Gateway integrations. Defaults to false.
enableDDTracing	Enable Datadog tracing on the Lambda function. Defaults to true. When enabled, it's required to set the forwarder parameter.
forwarder	Setting this parameter subscribes the Lambda functions' CloudWatch log groups to the given Datadog forwarder Lambda function. Required when enableDDTracing is set to true.
enableTags	When set, automatically tag the Lambda functions with the service and env tags using the service and stage values from the serverless application definition. It does NOT override if a service or env tag already exists. Defaults to true.
injectLogContext	When set, the lambda layer will automatically patch console.log with Datadog's tracing ids. Defaults to true.

To use any of these parameters, add a custom > datadog section to your serverless.yml similar to this example:

custom:
  datadog:
    flushMetricsToLogs: true
    apiKey: "{Datadog_API_Key}"
    apiKMSKey: "{Encripted_Datadog_API_Key}"
    addLayers: true
    logLevel: "info"
    enableXrayTracing: false
    enableDDTracing: true
    forwarder: arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder
    enableTags: true
    injectLogContext: true

Note: If you use webpack, Datadog recommends using the prebuilt layers by setting addLayers to true, which is the default, and add datadog-lambda-js and dd-trace to the externals section of your webpack config.

TypeScript

If you are using serverless-typescript, make sure that serverless-datadog is above the serverless-typescript entry in your serverless.yml. The plugin will automatically detect .ts files.

plugins:
  - serverless-plugin-datadog
  - serverless-typescript

If you use TypeScript, you may encounter the error of missing type definitions. A missing type definition happens when you use the prebuilt layers (for example, set addLayers to true, which is the default) and need to import helper functions from the datadog-lambda-js and dd-trace packages to submit custom metrics or instrument a specific function. To resolve the error, add datadog-lambda-js and dd-trace to the devDependencies list of your project's package.json.

Opening Issues

If you encounter a bug with this package, let us know by filing an issue! Before opening a new issue, please search the existing issues to avoid duplicates.

When opening an issue, include your Serverless Framework version, Python/Node.js version, and stack trace if available. Also, please include the steps to reproduce when appropriate.

You can also open an issue for a feature request.

Contributing

If you find an issue with this package and have a fix, please feel free to open a pull request following the procedures.

License

Unless explicitly stated otherwise, all files in this repository are licensed under the Apache License Version 2.0.

This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2019 Datadog, Inc.