Datadog is a hosted infrastructure monitoring platform. This chart adds the Datadog Agent to all nodes in your cluster via a DaemonSet. It also optionally depends on the kube-state-metrics chart. For more information about monitoring Kubernetes with Datadog, please refer to the Datadog documentation website.
Datadog offers two variants, switch to a -jmx tag if you need to run JMX/java integrations. The chart also supports running the standalone dogstatsd image.
See the Datadog JMX integration to learn more.
Kubernetes 1.4+ or OpenShift 3.4+, note that:
- the Datadog Agent supports Kubernetes 1.3+
- The Datadog chart's defaults are tailored to Kubernetes 1.7.6+, see Datadog Agent legacy Kubernetes versions documentation for adjustments you might need to make for older versions
By default, the Datadog Agent runs in a DaemonSet. It can alternatively run inside a Deployment for special use cases.
Note: simultaneous DaemonSet + Deployment installation within a single release will be deprecated in a future version, requiring two releases to achieve this.
To install the chart with the release name <RELEASE_NAME>, retrieve your Datadog API key from your Agent Installation Instructions and run:
helm install --name <RELEASE_NAME> \
--set datadog.apiKey=<DATADOG_API_KEY> stable/datadogBy default, this Chart creates a Secret and puts an API key in that Secret.
However, you can use manually created secret by setting the datadog.apiKeyExistingSecret value. After a few minutes, you should see hosts and metrics being reported in Datadog.
Read about the Datadog Cluster Agent in the official documentation.
Run the following if you want to deploy the chart with the Datadog Cluster Agent:
helm install --name datadog-monitoring \
--set datadog.apiKey=<DATADOG_API_KEY> \
--set datadog.appKey=<DATADOG_APP_KEY \
--set clusterAgent.enabled=true \
--set clusterAgent.metricsProvider.enabled=true \
stable/datadogNote: Specifying clusterAgent.metricsProvider.enabled=true enables the External Metrics Server.
If you want to learn to use this feature, you can check out this Datadog Cluster Agent walkthrough.
The Leader Election is enabled by default in the chart for the Cluster Agent. Only the Cluster Agent(s) participate in the election, in case you have several replicas configured (using clusterAgent.replicas.
You can specify the Datadog Cluster Agent token used to secure the communication between the Cluster Agent(s) and the Agents with clusterAgent.token.
If you don't specify a token, a random one is generated at each deployment so you must use --recreate-pods to ensure all pod use the same token. seeDatadog Chart notes to learn more.
Version 1.19.0 introduces the use of release name as full name if it contains the chart name(datadog in this case).
E.g. with a release name of datadog, this renames the DaemonSet from datadog-datadog to datadog.
The suggested approach is to delete the release and reinstall it.
Starting with version 1.0.0, this chart does not support deploying Agent 5.x anymore. If you cannot upgrade to Agent 6.x, you can use a previous version of the chart by calling helm install with --version 0.18.0.
See 0.18.1's README to see which options were supported at the time.
To uninstall/delete the <RELEASE_NAME> deployment:
helm delete <RELEASE_NAME> --purgeThe command removes all the Kubernetes components associated with the chart and deletes the release.
As a best practice, a YAML file that specifies the values for the chart parameters should be provided to configure the chart:
- Copy the default
datadog-values.yamlvalue file. - Set the
apiKeyparameter with your Datadog API key. - Upgrade the Datadog Helm chart with the new
datadog-values.yamlfile:
helm upgrade -f datadog-values.yaml <RELEASE_NAME> stable/datadog --recreate-podsSee the All configuration options section to discover all possibilities offered by the Datadog chart.
Update your datadog-values.yaml file with the following log collection configuration:
datadog:
(...)
logsEnabled: true
logsConfigContainerCollectAll: true
then upgrade your Datadog Helm chart:
helm upgrade -f datadog-values.yaml <RELEASE_NAME> stable/datadog --recreate-podsUpdate your datadog-values.yaml file with the process collection configuration:
datadog:
(...)
processAgentEnabled: true
then upgrade your Datadog Helm chart:
helm upgrade -f datadog-values.yaml <RELEASE_NAME> stable/datadog --recreate-podsUse the Datadog Cluster Agent to collect Kubernetes events. Please read the official documentation for more context.
Alternatively set the datadog.leaderElection, datadog.collectEvents and rbac.create options to true in order to enable Kubernetes event collection.
The Datadog entrypoint copies files with a .yaml extension found in /conf.d and files with .py extension in /check.d to /etc/datadog-agent/conf.d and /etc/datadog-agent/checks.d respectively.
The keys for datadog.confd and datadog.checksd should mirror the content found in their respective ConfigMaps. Update your datadog-values.yaml file with the check configurations:
datadog:
confd:
redisdb.yaml: |-
ad_identifiers:
- redis
- bitnami/redis
init_config:
instances:
- host: "%%host%%"
port: "%%port%%"
jmx.yaml: |-
ad_identifiers:
- openjdk
instance_config:
instances:
- host: "%%host%%"
port: "%%port_0%%"
redisdb.yaml: |-
init_config:
instances:
- host: "outside-k8s.example.com"
port: 6379then upgrade your Datadog Helm chart:
helm upgrade -f datadog-values.yaml <RELEASE_NAME> stable/datadog --recreate-podsFor more details, please refer to the documentation.
To map Kubernetes pod labels and annotations to Datadog tags, provide a dictionary with kubernetes labels/annotations as keys and Datadog tags key as values in your datadog-values.yaml file:
podAnnotationsAsTags:
iam.amazonaws.com/role: kube_iamrolepodLabelsAsTags:
app: kube_app
release: helm_releasethen upgrade your Datadog Helm chart:
helm upgrade -f datadog-values.yaml <RELEASE_NAME> stable/datadog --recreate-podsAs of the version 6.6.0, the Datadog Agent supports collecting metrics from any container runtime interface used in your cluster. Configure the location path of the socket with datadog.criSocketPath and make sure you allow the socket to be mounted into the pod running the agent by setting datadog.useCriSocketVolume to True.
Standard paths are:
- Containerd socket:
/var/run/containerd/containerd.sock - Cri-o socket:
/var/run/crio/crio.sock
The following table lists the configurable parameters of the Datadog chart and their default values. Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
helm install --name <RELEASE_NAME> \
--set datadog.apiKey=<DATADOG_API_KEY>,datadog.logLevel=DEBUG \
stable/datadog| Parameter | Description | Default |
|---|---|---|
datadog.apiKey |
Your Datadog API key | Nil You must provide your own key |
datadog.apiKeyExistingSecret |
If set, use the secret with a provided name instead of creating a new one | nil |
datadog.appKey |
Datadog APP key required to use metricsProvider | Nil You must provide your own key |
datadog.appKeyExistingSecret |
If set, use the secret with a provided name instead of creating a new one | nil |
image.repository |
The image repository to pull from | datadog/agent |
image.tag |
The image tag to pull | 6.10.1 |
image.pullPolicy |
Image pull policy | IfNotPresent |
image.pullSecrets |
Image pull secrets | nil |
nameOverride |
Override name of app | nil |
fullnameOverride |
Override full name of app | nil |
rbac.create |
If true, create & use RBAC resources | true |
rbac.serviceAccount |
existing ServiceAccount to use (ignored if rbac.create=true) | default |
daemonset.podLabels |
labels to add to each pod | nil |
datadog.name |
Container name if Daemonset or Deployment | datadog |
datadog.site |
Site ('datadoghq.com' or 'datadoghq.eu') | nil |
datadog.dd_url |
Datadog intake server | nil |
datadog.env |
Additional Datadog environment variables | nil |
datadog.logsEnabled |
Enable log collection | nil |
datadog.logsConfigContainerCollectAll |
Collect logs from all containers | nil |
datadog.logsPointerHostPath |
Host path to store the log tailing state in | /var/lib/datadog-agent/logs |
datadog.apmEnabled |
Enable tracing from the host | nil |
datadog.processAgentEnabled |
Enable live process monitoring | nil |
datadog.checksd |
Additional custom checks as python code | nil |
datadog.confd |
Additional check configurations (static and Autodiscovery) | nil |
datadog.criSocketPath |
Path to the container runtime socket (if different from Docker) | nil |
datadog.tags |
Set host tags | nil |
datadog.nonLocalTraffic |
Enable statsd reporting from any external ip | False |
datadog.useCriSocketVolume |
Enable mounting the container runtime socket in Agent containers | True |
datadog.dogstatsdOriginDetection |
Enable origin detection for container tagging | False |
datadog.useDogStatsDSocketVolume |
Enable dogstatsd over Unix Domain Socket | False |
datadog.volumes |
Additional volumes for the daemonset or deployment | nil |
datadog.volumeMounts |
Additional volumeMounts for the daemonset or deployment | nil |
datadog.podAnnotationsAsTags |
Kubernetes Annotations to Datadog Tags mapping | nil |
datadog.podLabelsAsTags |
Kubernetes Labels to Datadog Tags mapping | nil |
datadog.resources.requests.cpu |
CPU resource requests | 200m |
datadog.resources.limits.cpu |
CPU resource limits | 200m |
datadog.resources.requests.memory |
Memory resource requests | 256Mi |
datadog.resources.limits.memory |
Memory resource limits | 256Mi |
datadog.securityContext |
Allows you to overwrite the default securityContext applied to the container | nil |
datadog.livenessProbe |
Overrides the default liveness probe | http port 5555 |
datadog.hostname |
Set the hostname (write it in datadog.conf) | nil |
datadog.acInclude |
Include containers based on image name | nil |
datadog.acExclude |
Exclude containers based on image name | nil |
daemonset.podAnnotations |
Annotations to add to the DaemonSet's Pods | nil |
daemonset.tolerations |
List of node taints to tolerate (requires Kubernetes >= 1.6) | nil |
daemonset.nodeSelector |
Node selectors | nil |
daemonset.affinity |
Node affinities | nil |
daemonset.useHostNetwork |
If true, use the host's network | nil |
daemonset.useHostPID. |
If true, use the host's PID namespace | nil |
daemonset.useHostPort |
If true, use the same ports for both host and container | nil |
daemonset.priorityClassName |
Which Priority Class to associate with the daemonset | nil |
datadog.leaderElection |
Enable the leader Election feature | false |
datadog.leaderLeaseDuration |
The duration for which a leader stays elected. | 60 sec, 15 if Cluster Checks enabled |
datadog.collectEvents |
Enable Kubernetes event collection. Requires leader election. | false |
deployment.affinity |
Node / Pod affinities | {} |
deployment.tolerations |
List of node taints to tolerate | [] |
deployment.priorityClassName |
Which Priority Class to associate with the deployment | nil |
kubeStateMetrics.enabled |
If true, create kube-state-metrics | true |
kube-state-metrics.rbac.create |
If true, create & use RBAC resources for kube-state-metrics | true |
kube-state-metrics.rbac.serviceAccount |
existing ServiceAccount to use (ignored if rbac.create=true) for kube-state-metrics | default |
clusterAgent.enabled |
Use the cluster-agent for cluster metrics (Kubernetes 1.10+ only) | false |
clusterAgent.token |
A cluster-internal secret for agent-to-agent communication. Must be 32+ characters a-zA-Z | Generates a random value |
clusterAgent.containerName |
The container name for the Cluster Agent | cluster-agent |
clusterAgent.image.repository |
The image repository for the cluster-agent | datadog/cluster-agent |
clusterAgent.image.tag |
The image tag to pull | 1.2.0 |
clusterAgent.image.pullPolicy |
Image pull policy | IfNotPresent |
clusterAgent.image.pullSecrets |
Image pull secrets | nil |
clusterAgent.metricsProvider.enabled |
Enable Datadog metrics as a source for HPA scaling | false |
clusterAgent.clusterChecks.enabled |
Enable Cluster Checks on both the Cluster Agent and the Agent daemonset | false |
clusterAgent.confd |
Additional check configurations (static and Autodiscovery) | nil |
clusterAgent.resources.requests.cpu |
CPU resource requests | 200m |
clusterAgent.resources.limits.cpu |
CPU resource limits | 200m |
clusterAgent.resources.requests.memory |
Memory resource requests | 256Mi |
clusterAgent.resources.limits.memory |
Memory resource limits | 256Mi |
clusterAgent.tolerations |
List of node taints to tolerate | [] |
clusterAgent.livenessProbe |
Overrides the default liveness probe | http port 443 if external metrics enabled |
clusterAgent.readinessProbe |
Overrides the default readiness probe | http port 443 if external metrics enabled |
clusterchecksDeployment.enabled |
Enable Datadog agent deployment dedicated for running Cluster Checks. It allows having different resources (Request/Limit) for Cluster Checks agent pods. | false |
clusterchecksDeployment.env |
Additional Datadog environment variables for Cluster Checks Deployment | nil |
clusterchecksDeployment.resources.requests.cpu |
CPU resource requests | 200m |
clusterchecksDeployment.resources.limits.cpu |
CPU resource limits | 200m |
clusterchecksDeployment.resources.requests.memory |
Memory resource requests | 256Mi |
clusterchecksDeployment.resources.limits.memory |
Memory resource limits | 256Mi |
clusterchecksDeployment.nodeSelector |
Node selectors | nil |
clusterchecksDeployment.affinity |
Node affinities | avoid running pods on the same node |
clusterchecksDeployment.livenessProbe |
Overrides the default liveness probe | http port 5555 |
clusterchecksDeployment.rbac.dedicated |
If true, use dedicated RBAC resources for clusterchecks agent's pods | false |
clusterchecksDeployment.rbac.serviceAccount |
existing ServiceAccount to use (ignored if rbac.create=true) for clusterchecks | default |