This page is not yet available in Spanish. We are working on its translation. If you have any questions or feedback about our current translation project, feel free to reach out to us!
The Datadog Docker Agent is the containerized version of the host Agent. The Docker Agent supports Docker, containerd, and Podman runtimes. The official Docker image is available on Docker Hub, GCR, and ECR-Public.
Docker Hub is subject to image pull rate limits. If you are not a Docker Hub customer, Datadog recommends that you update your Datadog Agent and Cluster Agent configuration to pull from GCR or ECR. For instructions, see Changing your container registry.
Images are available for 64-bit x86 and Arm v8 architectures.
If you haven’t installed the Docker Agent, follow the in-app installation instructions or see below. For supported versions, see the Agent documentation. Use the one-step install command. Replace <YOUR_DATADOG_API_KEY> with your Datadog API key, and <DATADOG_SITE> with datadoghq.com.
Note: If you’re using a different registry besides GCR or ECR-public, make sure to update the image.
Note: For some features provided by system-probe, including network monitoring, security agent, and oom_kill check, you must also mount the /etc/os-release file with -v /etc/os-release:/host/etc/os-release:ro. If your Linux distribution does not include an /etc/os-release file, mount the equivalent one provided, for example /etc/redhat-release or /etc/fedora-release.
The Agent’s main configuration file is datadog.yaml. For the Docker Agent, datadog.yaml configuration options are passed in with environment variables.
Hostname to use for metrics (if autodetection fails).
DD_HOSTNAME_FILE
In some environments, auto-detection of the hostname is not adequate, and you cannot set the value with environment variables. In these cases, you can use a file on the host to provide an appropriate value. If DD_HOSTNAME is set to a non-empty value, this option is ignored.
DD_TAGS
Host tags separated by spaces. For example: key1:value1 key2:value2.
DD_SITE
Destination site for your metrics, traces, and logs. Set your Datadog site to: datadoghq.com. Defaults to datadoghq.com.
DD_DD_URL
Optional setting to override the URL for metric submission.
DD_URL (6.36+/7.36+)
Alias for DD_DD_URL. Ignored if DD_DD_URL is already set.
DD_CHECK_RUNNERS
The Agent runs all checks concurrently by default (default value = 4 runners). To run the checks sequentially, set the value to 1. If you need to run a high number of checks (or slow checks), the collector-queue component may fall behind and fail the health check. You can increase the number of runners to run checks in parallel.
DD_APM_ENABLED
Enables trace collection. Defaults to true. For more information about additional trace collection environment variables, see Tracing Docker Applications.
DD_LOGS_CONFIG_EXPECTED_TAGS_DURATION
In some environments, the initial logs from hosts might not include the correct tags. If you’re missing tags on new hosts in your logs, include this environment variable and set it to "10m".
Datadog automatically collects common tags from Docker, Kubernetes, ECS, Swarm, Mesos, Nomad, and Rancher. To extract even more tags, use the following options:
Env Variable
Description
DD_CONTAINER_LABELS_AS_TAGS
Extract container labels. This env is equivalent to the old DD_DOCKER_LABELS_AS_TAGS env.
DD_CONTAINER_ENV_AS_TAGS
Extract container environment variables. This env is equivalent to the old DD_DOCKER_ENV_AS_TAGS env.
DD_COLLECT_EC2_TAGS
Extract custom EC2 tags without using the AWS integration.
Integration credentials can be stored in Docker or Kubernetes secrets and used in Autodiscovery templates. For more information, see the Secrets Management documentation.
Exclude containers from logs collection, metrics collection, and Autodiscovery. Datadog excludes Kubernetes and OpenShift pause containers by default. These allowlists and blocklists apply to Autodiscovery only; traces and DogStatsD are not affected. The value for these environment variables support regular expressions.
Env Variable
Description
DD_CONTAINER_INCLUDE
Allowlist of containers to include (separated by spaces). Use .* to include all. For example: "image:image_name_1 image:image_name_2", image:.* When using ImageStreams inside OpenShift environments, use the container name instead of image. For example:“name:container_name_1 name:container_name_2”, name:.*
DD_CONTAINER_EXCLUDE
Blocklist of containers to exclude (separated by spaces). Use .* to exclude all. For example: "image:image_name_3 image:image_name_4" (Note: This variable is only honored for Autodiscovery.), image:.*
DD_CONTAINER_INCLUDE_METRICS
Allowlist of containers whose metrics you wish to include.
DD_CONTAINER_EXCLUDE_METRICS
Blocklist of containers whose metrics you wish to exclude.
DD_CONTAINER_INCLUDE_LOGS
Allowlist of containers whose logs you wish to include.
DD_CONTAINER_EXCLUDE_LOGS
Blocklist of containers whose logs you wish to exclude.
DD_AC_INCLUDE
Deprecated. Allowlist of containers to include (separated by spaces). Use .* to include all. For example: "image:image_name_1 image:image_name_2", image:.*
DD_AC_EXCLUDE
Deprecated. Blocklist of containers to exclude (separated by spaces). Use .* to exclude all. For example: "image:image_name_3 image:image_name_4" (Note: This variable is only honored for Autodiscovery.), image:.*
Note: The kubernetes.containers.running, kubernetes.pods.running, docker.containers.running, .stopped, .running.total and .stopped.total metrics are not affected by these settings. All containers are counted. This does not affect your per-container billing.
Note: When using containerd, it’s possible to ignore containers by namespace using DD_CONTAINERD_NAMESPACES and DD_CONTAINERD_EXCLUDE_NAMESPACES. Both are a space-separated list of namespaces. When DD_CONTAINERD_NAMESPACES is set, the agent reports data for the containers that belong to a namespace present in the list. When DD_CONTAINERD_EXCLUDE_NAMESPACES is set, the agent reports data for all the containers except the ones that belong to a namespace of the list.
Additional Autodiscovery listeners to run. They are added in addition to the variables defined in the listeners section of the datadog.yaml configuration file.
DD_CONFIG_PROVIDERS
The providers the Agent should call to collect checks configurations. The default provider is docker. The Docker provider handles templates embedded in container labels.
DD_EXTRA_CONFIG_PROVIDERS
Additional Autodiscovery configuration providers to use. They are added in addition to the variables defined in the config_providers section of the datadog.yaml configuration file.
Overrides container source auto-detection to force a single source. e.g "docker", "ecs_fargate", "kubelet". This is no longer needed since Agent v7.35.0.
DD_HEALTH_PORT
Set this to 5555 to expose the Agent health check at port 5555.
By default, the Docker Agent collects metrics with the following core checks. To collect metrics from other technologies, see the Integrations section.
If you installed the Datadog Docker Agent with Single Step APM Instrumentation, and you want to uninstall the Agent, you need to run additional commands to uninstall APM Instrumentation.
