sbt-datadog

This project is highly inspired by the fantastic sbt-newrelic project.

We want to thanks Gilt for their work on sbt-newrelic that allowed us to create this project really quickly.

Prerequisites

The plugin assumes that sbt-native-packager has been included in your SBT build configuration. This can be done by adding the plugin following instructions at http://www.scala-sbt.org/sbt-native-packager/ or by adding another plugin that includes and initializes it (e.g. the SBT plugin for Play 2.6.x).

Installation

Add the following to your project/plugins.sbt file:

addSbtPlugin("com.colisweb" % "sbt-datadog" % "2.1.0")

To enable the Datadog APM for your project, add the DatadogAPM auto-plugin to your project.

enablePlugins(DatadogAPM)

Configuration

datadogApmVersion

To use a specific Datadog Java APM Agent version, add the following to your build.sbt file:

datadogApmVersion := "0.74.1"

datadogServiceName

By default, the agent will use the sbt project name value as service.name.

To use another value, add the following to your build.sbt file:

datadogServiceName := "another name"

You can use your host (where you code run) environment variables in the value:

datadogServiceName := "another name ${MY_HOST_ENV_VAR}"

datadogAgentHost

By default, the agent agent.host value is localhost.

To use another value, add the following to your build.sbt file:

datadogAgentHost := "127.0.0.1"

You can use your host (where you code run) environment variables in the value:

datadogAgentHost := "${MY_DD_HOST_IP}"

datadogAgentPort

By default, the agent agent.port value is "8126".

To use another value, add the following to your build.sbt file:

datadogAgentPort := "9999"

You can use your host (where you code run) environment variables in the value:

datadogAgentPort := "${MY_DD_PORT}"

datadogEnableNetty

Netty Http Server and Client Instrumentation. Default value is false.

To use another value, add the following to your build.sbt file:

datadogEnableNetty := true

datadogEnableAkkaHttp

Akka-Http Server and Lagom Framework Instrumentation. Default value is false.

To use another value, add the following to your build.sbt file:

datadogEnableAkkaHttp := true

datadogEnableDebug

To return debug level application logs, enable debug mode with this flag. Default value is false.

To use another value, add the following to your build.sbt file:

datadogEnableDebug := true

datadogGlobalTags

A list of default tags to be added to every span and every JMX metric. Default value is an empty list.

To add global tags:

datadogGlobalTags := Map("env" -> "testing", "version" -> "testing-4c84587e")

Other possible settings

For more configuration option, look at the Datadog Java APM agent documentation: https://docs.datadoghq.com/tracing/setup/java/