Dynamic Instrumentation is a feature of supporting Datadog tracing libraries. If you are already using APM to collect traces for your application, ensure your Agent and tracing library are on the required version, and go directly to enabling Dynamic Instrumentation in step 4.

Requirements

The Datadog Dynamic Instrumentation library is supported in JDK version 8 and above.

Installation

  1. Install or upgrade your Agent to version 7.44.0 or higher.

  2. If you don’t already have APM enabled, in your Agent configuration, set the DD_APM_ENABLED environment variable to true and listening to the port 8126/TCP.

  3. Download dd-java-agent.jar:

    wget -O dd-java-agent.jar 'https://dtdg.co/latest-java-tracer'
    
    curl -Lo dd-java-agent.jar 'https://dtdg.co/latest-java-tracer'
    
    ADD 'https://dtdg.co/latest-java-tracer' dd-java-agent.jar
    

    Note: Dynamic Instrumentation is available in the dd-java-agent.jar library in versions 1.24.0 and later.

  4. Run your service with Dynamic Instrumentation enabled by setting -Ddd.dynamic.instrumentation.enabled flag or DD_DYNAMIC_INSTRUMENTATION_ENABLED environment variable to true. Specify dd.service, dd.env, and dd.version Unified Service Tags so you can filter and group your probes and target active clients across these dimensions.

    Example service startup command:

    java \
        -javaagent:dd-java-agent.jar \
        -Ddd.service=<YOUR_SERVICE> \
        -Ddd.env=<YOUR_ENVIRONMENT> \
        -Ddd.version=<YOUR_VERSION> \
        -Ddd.dynamic.instrumentation.enabled=true \
        -jar <YOUR_SERVICE>.jar <YOUR_SERVICE_FLAGS>
    
    export DD_SERVICE=<YOUR_SERVICE>
    export DD_ENV=<YOUR_ENV>
    export DD_VERSION=<YOUR_VERSION>
    export DD_DYNAMIC_INSTRUMENTATION_ENABLED=true
    java \
        -javaagent:dd-java-agent.jar \
        -jar <YOUR_SERVICE>.jar <YOUR_SERVICE_FLAGS>
    

    Note: The -javaagent argument needs to be before -jar, adding it as a JVM option rather than an application argument. For more information, see the Oracle documentation:

    # Good:
    java -javaagent:dd-java-agent.jar ... -jar my-service.jar -more-flags
    # Bad:
    java -jar my-service.jar -javaagent:dd-java-agent.jar ...
    
  5. After starting your service with Dynamic Instrumentation enabled, you can start using Dynamic Instrumentation on the APM > Dynamic Instrumentation page.

Configuration

Configure Dynamic Instrumentation using the following environment variables:

Environment variableTypeDescription
DD_DYNAMIC_INSTRUMENTATION_ENABLEDBooleanAlternate for -Ddd.dynamic.instrumentation.enabled argument. Set to true to enable Dynamic Instrumentation.
DD_SERVICEStringThe service name, for example, web-backend.
DD_ENVStringThe environment name, for example: production.
DD_VERSIONStringThe version of your service.
DD_TAGSStringTags to apply to produced data. Must be a list of <key>:<value> separated by commas such as: layer:api,team:intake.

What to do next

See Dynamic Instrumentation for information about setting snapshot and metric probes and browsing and indexing the data.

Further Reading

Additional helpful documentation, links, and articles: