Datadog

Datadog is a hosted infrastructure monitoring platform.

Introduction

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.

Prerequisites

Kubernetes 1.4+ or OpenShift 3.4+ (1.3 support is currently partial, full support is planned for 6.4.0).

Installing the Chart

To install the chart with the release name my-release, retrieve your DataDog API key from your Agent Installation Instructions and run:

$ helm install --name my-release \
    --set datadog.apiKey=YOUR-KEY-HERE stable/datadog

After a few minutes, you should see hosts and metrics being reported in DataDog.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the Datadog chart and their default values.

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.5.2
image.pullPolicy	Image pull policy	IfNotPresent
image.pullSecrets	Image pull secrets	nil
rbac.create	If true, create & use RBAC resources	true
rbac.serviceAccount	existing ServiceAccount to use (ignored if rbac.create=true)	default
datadog.name	Container name if Deamonset or Deployment	datadog
datadog.env	Additional Datadog environment variables	nil
datadog.logsEnabled	Enable log collection	nil
datadog.logsConfigContainerCollectAll	Collect logs from all containers	nil
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.tags	Set host tags	nil
datadog.volumes	Additional volumes for the daemonset or deployment	nil
datadog.volumeMounts	Additional volumeMounts for the daemonset or deployment	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
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
datadog.leaderElection	Enable the leader Election feature	false
datadog.leaderLeaseDuration	The duration for which a leader stays elected.	nil
datadog.collectEvents	Enable Kubernetes event collection. Requires leader election.	false
deployment.affinity	Node / Pod affinities	{}
deployment.tolerations	List of node taints to tolerate	[]
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	Nil You must provide your own token
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	0.10.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.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

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
    --set datadog.apiKey=YOUR-KEY-HERE,datadog.logLevel=DEBUG \
    stable/datadog

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f my-values.yaml stable/datadog

Tip: You can copy and customize the default values.yaml

Image repository and tag

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.

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.

DaemonSet and Deployment

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.

Secret

By 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.

confd and checksd

The Datadog entrypoint will copy 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, ie

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: 6379

Kubernetes event collection

To enable event collection, you will need to set the datadog.leaderElection, datadog.collectEvents and rbac.create options to true.

Please read the official documentation for more context.