framework-datadog_javaagent.md

Datadog APM Javaagent Framework

The Datadog APM Javaagent Framework installs an agent that allows your application to be dynamically instrumented by dd-java-agent.jar.

For this functionality to work, you must also use this feature in combination with the Datadog Cloudfoundry Buildpack. The Datadog Cloudfoundry Buildpack must run first, so that it can supply the components to which the Datadog APM agent will talk. Please make sure you follow the instructions on the README for the Datadog Cloudfoundry Buildpack to enable and configure it.

The framework will configure the Datadog agent for correct use in most situations, however you may adjust its behavior by setting additional environment variables. For a complete list of Datadog Agent configuration options, please see the Datadog Documentation.

Detection Criterion	All must be true: The Datadog Buildpack must be included DD_API_KEY defined and contain your API key Optionally, you may set DD_APM_ENABLED to false to force the framework to not contribute the agent.
Tags	datadog-javaagent=<version>

Tags are printed to standard output by the buildpack detect script

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension. The framework uses the Repository utility support and so it supports the version syntax defined there.

The javaagent can be configured directly via environment variables or system properties as defined in the Configuration of Datadog Javaagent documentation.

Name	Description
repository_root	The URL of the Datadog Javaagent repository index (details).
version	The dd-java-agent version to use. Candidate versions can be found in this listing.