Skip to main content

Component: datadog-agent

This component installs the datadog-agent for EKS clusters.

Usage

Stack Level: Regional

Use this in the catalog as default values.

components:
terraform:
datadog-agent:
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
eks_component_name: eks/cluster
name: "datadog"
description: "Datadog Kubernetes Agent"
kubernetes_namespace: "monitoring"
create_namespace: true
repository: "https://helm.datadoghq.com"
chart: "datadog"
chart_version: "3.29.2"
timeout: 1200
wait: true
atomic: true
cleanup_on_fail: true
cluster_checks_enabled: false
helm_manifest_experiment_enabled: false
secrets_store_type: SSM
tags:
team: sre
service: datadog-agent
app: monitoring
# datadog-agent shouldn't be deployed to the Fargate nodes
values:
agents:
affinity:
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: eks.amazonaws.com/compute-type
operator: NotIn
values:
- fargate
datadog:
env:
- name: DD_EC2_PREFER_IMDSV2 # this merges ec2 instances and the node in the hostmap section
value: "true"

Deploy this to a particular environment such as dev, prod, etc.

This will add cluster checks to a specific environment.

components:
terraform:
datadog-agent:
vars:
# Order affects merge order. Later takes priority. We append lists though.
datadog_cluster_check_config_paths:
- catalog/cluster-checks/defaults/*.yaml
- catalog/cluster-checks/dev/*.yaml
datadog_cluster_check_config_parameters: {}
# add additional tags to all data coming in from this agent.
datadog_tags:
- "env:dev"
- "region:us-west-2"
- "stage:dev"

Cluster Checks

Cluster Checks are configurations that allow us to setup external URLs to be monitored. They can be configured through the datadog agent or annotations on kubernetes services.

Cluster Checks are similar to synthetics checks, they are not as indepth, but significantly cheaper. Use Cluster Checks when you need a simple health check beyond the kubernetes pod health check.

Public addresses that test endpoints must use the agent configuration, whereas service addresses internal to the cluster can be tested by annotations.

Adding Cluster Checks

Cluster Checks can be enabled or disabled via the cluster_checks_enabled variable. We recommend this be set to true.

New Cluster Checks can be added to defaults to be applied in every account. Alternatively they can be placed in an individual stage folder which will be applied to individual stages. This is controlled by the datadog_cluster_check_config_parameters variable, which determines the paths of yaml files to look for cluster checks per stage.

Once they are added, and properly configured, the new checks show up in the network monitor creation under ssl and Http

Please note: the yaml file name doesn't matter, but the root key inside which is something.yaml does matter. this is following datadogs docs for <integration name>.yaml.

Sample Yaml

The key of a filename must match datadog docs, which is <INTEGRATION_NAME>.yaml

Cluster Checks can be used for external URL testing (loadbalancer endpoints), whereas annotations must be used for kubernetes services.

http_check.yaml:
cluster_check: true
init_config:
instances:
- name: "[${stage}] Echo Server"
url: "https://echo.${stage}.uw2.acme.com"
- name: "[${stage}] Portal"
url: "https://portal.${stage}.uw2.acme.com"
- name: "[${stage}] ArgoCD"
url: "https://argocd.${stage}.uw2.acme.com"

Monitoring Cluster Checks

Using Cloudposse's datadog-monitor component. The following yaml snippet will monitor all HTTP Cluster Checks, this can be added to each stage (usually via a defaults folder).

https-checks:
name: "(Network Check) ${stage} - HTTPS Check"
type: service check
query: |
"http.can_connect".over("stage:${stage}").by("instance").last(2).count_by_status()
message: |
HTTPS Check failed on <code>{{instance.name}}</code>
in Stage: <code>{{stage.name}}</code>
escalation_message: ""
tags:
managed-by: Terraform
notify_no_data: false
notify_audit: false
require_full_window: true
enable_logs_sample: false
force_delete: true
include_tags: true
locked: false
renotify_interval: 0
timeout_h: 0
evaluation_delay: 0
new_host_delay: 0
new_group_delay: 0
no_data_timeframe: 2
threshold_windows: {}
thresholds:
critical: 1
warning: 1
ok: 1

References

Requirements

NameVersion
terraform>= 1.0.0
aws>= 4.9.0
helm>= 2.7
kubernetes>= 2.14.0, != 2.21.0
utils>= 1.10.0

Providers

NameVersion
aws>= 4.9.0

Modules

NameSourceVersion
datadog_agentcloudposse/helm-release/aws0.10.0
datadog_cluster_check_yaml_configcloudposse/config/yaml1.0.2
datadog_configuration../../datadog-configuration/modules/datadog_keysn/a
ekscloudposse/stack-config/yaml//modules/remote-state1.5.0
iam_roles../../account-map/modules/iam-rolesn/a
thiscloudposse/label/null0.25.0
values_mergecloudposse/config/yaml//modules/deepmerge1.0.2

Resources

NameType
aws_eks_cluster_auth.eksdata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
atomicIf set, installation process purges chart on fail. The wait flag will be set automatically if atomic is usedbooltrueno
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
chartChart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommendedstringn/ayes
chart_versionSpecify the exact chart version to install. If this is not specified, the latest version is installedstringnullno
cleanup_on_failAllow deletion of new resources created in this upgrade when upgrade failsbooltrueno
cluster_checks_enabledEnable Cluster Checks for the Datadog Agentboolfalseno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
create_namespaceCreate the Kubernetes namespace if it does not yet existbooltrueno
datadog_cluster_check_auto_added_tagsList of tags to add to Datadog Cluster Checklist(string)
[
"stage",
"environment"
]
no
datadog_cluster_check_config_parametersMap of parameters to Datadog Cluster Check configurationsmap(any){}no
datadog_cluster_check_config_pathsList of paths to Datadog Cluster Check configurationslist(string)[]no
datadog_tagsList of static tags to attach to every metric, event and service check collected by the agentset(string)[]no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptionRelease description attribute (visible in the history)stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
eks_component_nameThe name of the EKS component. Used to get the remote statestring"eks/eks"no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
helm_manifest_experiment_enabledEnable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the planboolfalseno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
kube_data_auth_enabledIf true, use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled.
boolfalseno
kube_exec_auth_aws_profileThe AWS config profile for aws eks get-token to usestring""no
kube_exec_auth_aws_profile_enabledIf true, pass kube_exec_auth_aws_profile as the profile to aws eks get-tokenboolfalseno
kube_exec_auth_enabledIf true, use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled, overrides kube_data_auth_enabled.
booltrueno
kube_exec_auth_role_arnThe role ARN for aws eks get-token to usestring""no
kube_exec_auth_role_arn_enabledIf true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-tokenbooltrueno
kubeconfig_contextContext to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.
string""no
kubeconfig_context_formatA format string to use for creating the kubectl context name when
kubeconfig_file_enabled is true and kubeconfig_context is not supplied.
Must include a single %s which will be replaced with the cluster name.
string""no
kubeconfig_exec_auth_api_versionThe Kubernetes API version of the credentials returned by the exec auth pluginstring"client.authentication.k8s.io/v1beta1"no
kubeconfig_fileThe Kubernetes provider config_path setting to use when kubeconfig_file_enabled is truestring""no
kubeconfig_file_enabledIf true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS clusterboolfalseno
kubernetes_namespaceKubernetes namespace to install the release intostringn/ayes
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
regionAWS Regionstringn/ayes
repositoryRepository URL where to locate the requested chartstringnullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
timeoutTime in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 secondsnumbernullno
valuesAdditional values to yamlencode as helm_release values.any{}no
verifyVerify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chartboolfalseno
waitWill wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout. Defaults to trueboolnullno

Outputs

NameDescription
cluster_checksCluster Checks for the cluster
metadataBlock status of the deployed release

References

CHANGELOG

PR #814

Possible Breaking Change

Removed inputs iam_role_enabled and iam_policy_statements because the Datadog agent does not need an IAM (IRSA) role or any special AWS permissions because it works solely within the Kubernetes environment. (Datadog has AWS integrations to handle monitoring that requires AWS permissions.)

This only a breaking change if you were setting these inputs. If you were, simply remove them from your configuration.

Possible Breaking Change

Previously this component directly created the Kubernetes namespace for the agent when create_namespace was set to true. Now this component delegates that responsibility to the helm-release module, which better coordinates the destruction of resources at destruction time (for example, ensuring that the Helm release is completely destroyed and finalizers run before deleting the namespace).

Generally the simplest upgrade path is to destroy the Helm release, then destroy the namespace, then apply the new configuration. Alternatively, you can use terraform state mv to move the existing namespace to the new Terraform "address", which will preserve the existing deployment and reduce the possibility of the destroy failing and leaving the Kubernetes cluster in a bad state.

Cluster Agent Redundancy

In this PR we have defaulted the number of Cluster Agents to 2. This is because when there are no Cluster Agents, all cluster metrics are lost. Having 2 agents makes it possible to keep 1 agent running at all times, even when the other is on a node being drained.

DNS Resolution Enhancement

If Datadog processes are looking for where to send data and are configured to look up datadog.monitoring.svc.cluster.local, by default the cluster will make a DNS query for each of the following:

  1. datadog.monitoring.svc.cluster.local.monitoring.svc.cluster.local
  2. datadog.monitoring.svc.cluster.local.svc.cluster.local
  3. datadog.monitoring.svc.cluster.local.cluster.local
  4. datadog.monitoring.svc.cluster.local.ec2.internal
  5. datadog.monitoring.svc.cluster.local

due to the DNS resolver's search path. Because this lookup happens so frequently (several times a second in a production environment), it can cause a lot of unnecessary work, even if the DNS query is cached.

In this PR we have set ndots: 2 in the agent and cluster agent configuration so that only the 5th query is made. (In Kubernetes, the default value for ndots is 5. DNS queries having fewer than ndots dots in them will be attempted using each component of the search path in turn until a match is found, while those with more dots, or with a final dot, are looked up as is.)

Alternately, where you are setting the host name to be resolved, you can add a final dot at the end so that the search path is not used, e.g. datadog.monitoring.svc.cluster.local.

Note for Bottlerocket users

If you are using Bottlerocket, you will want to uncomment the following from vaules.yaml or add it to your values input:

criSocketPath: /run/dockershim.sock # Bottlerocket Only
env: # Bottlerocket Only
- name: DD_AUTOCONFIG_INCLUDE_FEATURES # Bottlerocket Only
value: "containerd" # Bottlerocket Only

See the Datadog documentation for details.