Single Step APM Instrumentation (Beta)

In one command, you can install, configure, and start the Agent with APM and Remote Configuration enabled, and set up automatic instrumentation of your services.

For an Ubuntu host:

1. Run the one-line install command:

   DD_API_KEY=<YOUR_DD_API_KEY> DD_SITE="<YOUR_DD_SITE>" DD_APM_INSTRUMENTATION_ENABLED=host bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent7.sh)"
   

   Replace <YOUR_DD_API_KEY> with your Datadog API. Replace <YOUR_DD_SITE> with your Datadog site.

2. Restart the services on the host or VM.

3. Explore the performance observability of your services in Datadog.

   You can optionally set an environment for your services and other telemetry that pass through the Agent. Read tagging observability data by environment to learn how.

For a Docker Linux container:

1. Install the library injector:

   bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_docker_injection.sh)"
   

2. Configure the Agent in Docker:

   docker run -d --name dd-agent \  
     -e DD_API_KEY=${YOUR_DD_API_KEY} \
     -e DD_APM_ENABLED=true \
     -e DD_APM_NON_LOCAL_TRAFFIC=true \
     -e DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true \
     -e DD_APM_RECEIVER_SOCKET=/opt/datadog/apm/inject/run/apm.socket \
     -e DD_DOGSTATSD_SOCKET=/opt/datadog/apm/inject/run/dsd.socket \
     -v /opt/datadog/apm:/opt/datadog/apm \
     -v /var/run/docker.sock:/var/run/docker.sock:ro \
     gcr.io/datadoghq/agent:7
   

   Replace <YOUR_DD_API_KEY> with your Datadog API.

3. Restart the Docker containers.

4. Explore the performance observability of your services in Datadog.

   You can optionally set an environment for your services and other telemetry that pass through the Agent. Read tagging observability data by environment to learn how.

You can enable APM by installing the Agent with the Datadog Helm chart. This deploys the Datadog Agent across all nodes in your Linux-based Kubernetes cluster with a DaemonSet.

Requirements

• Make sure you have Helm installed.

Installation

To enable single step instrumentation with Helm:

1. Add the Helm Datadog repo:

    helm repo add datadog https://helm.datadoghq.com
    helm repo update
   

2. Create a Kubernetes secret to store your Datadog API key:

   kubectl create secret generic datadog-secret --from-literal api-key=$DD_API_KEY
   

3. Create datadog-values.yaml and add the following configuration:

   datadog:
    apiKeyExistingSecret: datadog-secret
    site: <DATADOG_SITE>
    apm:
      instrumentation:
         enabled: true
   

   Replace <DATADOG_SITE> with your Datadog site.

   Here you can also optionally configure the following:

   • Enabling or disabling instrumentation for namespaces.
   • Specifying tracing library versions.
   • Tagging observability data by environment.

4. Run the following command:

   helm install datadog-agent -f datadog-values.yaml
   

Enabling or disabling instrumentation for namespaces

You can choose to selectively instrument specific namespaces or choose to not instrument them.

To enable instrumentation for specific namespaces, replace enabled: true with enabledNamespaces configuration in your datadog-values.yaml file:

      datadog:
        apiKeyExistingSecret: datadog-secret
        site: <DATADOG_SITE>
        apm:
          instrumentation:
            enabledNamespaces: # Add namespaces to instrument
               - namespace_1
               - namespace_2
 

To disable instrumentation for specific namespaces, add the disabledNamespaces configuration to your datadog-values.yaml file:

   datadog:
     apiKeyExistingSecret: datadog-secret
     site: <DATADOG_SITE>
     apm:
       instrumentation:
         enabled: true
         disabledNamespaces: # Add namespaces to not instrument
            - namespace_1
            - namespace_2

Specifying tracing library versions

You can optionally set specific tracing library versions to use. If you don’t specify a version, it defaults to the latest version. To find the latest version for a library, go to Releases in the dd-trace-<language> GitHub repo. For example, dd-trace-dotnet releases.

To set specific tracing library versions, add the following configuration to your datadog-values.yaml file:

   datadog:
     apiKeyExistingSecret: datadog-secret
     site: <DATADOG_SITE>
     apm:
       instrumentation:
         enabled: true
         libVersions: # Add any versions you want to set
            dotnet: v2.40.0
            python: v1.20.6
            java: v1.22.0
            js: v4.17.0
            ruby: v1.15.0 

1. Add the DD_INSTRUMENT_SERVICE_WITH_APM environment variable to the service startup command:

   DD_INSTRUMENT_SERVICE_WITH_APM=false <service_start_command>
   

2. Restart the service.

1. Add the DD_INSTRUMENT_SERVICE_WITH_APM environment variable to the service startup command:

   docker run -e DD_INSTRUMENT_SERVICE_WITH_APM=false <service_start_command>
   

2. Restart the service.

1. Set the admission.datadoghq.com/enabled: label to "false" for the pod spec:

   spec:
     template:
       metadata:
         labels:
           admission.datadoghq.com/enabled: "false"
   

2. Apply the configuration:

   kubectl apply -f /path/to/your/deployment.yaml
   

3. Restart the services you want to remove instrumentation for.

1. Run:

   dd-host-install --uninstall
   

2. Restart your host.

1. Uninstall local library injection:

   dd-container-install --uninstall
   

2. Restart Docker:

   systemctl restart docker
   

   Or use the equivalent for your environment.

1. Under apm:, remove instrumentation: and all following configuration in datadog-values.yaml.
2. Run the following command:

   helm upgrade datadog-agent -f datadog-values.yaml datadog/datadog
   

3. Restart your services.