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

warning

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

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

• https://github.com/DataDog/helm-charts/tree/main/charts/datadog
• https://github.com/DataDog/helm-charts/blob/main/charts/datadog/values.yaml
• https://github.com/DataDog/helm-charts/blob/main/examples/datadog/agent_basic_values.yaml
• https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release
• https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/?tab=helm

Requirements

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

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
datadog_agent	cloudposse/helm-release/aws	0.10.0
datadog_cluster_check_yaml_config	cloudposse/config/yaml	1.0.2
datadog_configuration	../../datadog-configuration/modules/datadog_keys	n/a
eks	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0
values_merge	cloudposse/config/yaml//modules/deepmerge	1.0.2

Resources

Name	Type
aws_eks_cluster_auth.eks	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional 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
atomic	If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used	bool	true	no
attributes	ID 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
chart	Chart 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 recommended	string	n/a	yes
chart_version	Specify the exact chart version to install. If this is not specified, the latest version is installed	string	null	no
cleanup_on_fail	Allow deletion of new resources created in this upgrade when upgrade fails	bool	true	no
cluster_checks_enabled	Enable Cluster Checks for the Datadog Agent	bool	false	no
context	Single 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_namespace	Create the Kubernetes namespace if it does not yet exist	bool	true	no
datadog_cluster_check_auto_added_tags	List of tags to add to Datadog Cluster Check	list(string)	[ "stage", "environment" ]	no
datadog_cluster_check_config_parameters	Map of parameters to Datadog Cluster Check configurations	map(any)	{}	no
datadog_cluster_check_config_paths	List of paths to Datadog Cluster Check configurations	list(string)	[]	no
datadog_tags	List of static tags to attach to every metric, event and service check collected by the agent	set(string)	[]	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
description	Release description attribute (visible in the history)	string	null	no
descriptor_formats	Describe 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_name	The name of the EKS component. Used to get the remote state	string	"eks/eks"	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
helm_manifest_experiment_enabled	Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan	bool	false	no
id_length_limit	Limit 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.	number	null	no
kube_data_auth_enabled	If 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.	bool	false	no
kube_exec_auth_aws_profile	The AWS config profile for aws eks get-token to use	string	""	no
kube_exec_auth_aws_profile_enabled	If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token	bool	false	no
kube_exec_auth_enabled	If 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.	bool	true	no
kube_exec_auth_role_arn	The role ARN for aws eks get-token to use	string	""	no
kube_exec_auth_role_arn_enabled	If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token	bool	true	no
kubeconfig_context	Context to choose from the Kubernetes config file. If supplied, kubeconfig_context_format will be ignored.	string	""	no
kubeconfig_context_format	A 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_version	The Kubernetes API version of the credentials returned by the exec auth plugin	string	"client.authentication.k8s.io/v1beta1"	no
kubeconfig_file	The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true	string	""	no
kubeconfig_file_enabled	If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster	bool	false	no
kubernetes_namespace	Kubernetes namespace to install the release into	string	n/a	yes
label_key_case	Controls 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.	string	null	no
label_order	The 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)	null	no
label_value_case	Controls 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.	string	null	no
labels_as_tags	Set 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
name	ID 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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	Terraform 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.	string	null	no
region	AWS Region	string	n/a	yes
repository	Repository URL where to locate the requested chart	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
timeout	Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds	number	null	no
values	Additional values to yamlencode as helm_release values.	any	{}	no
verify	Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart	bool	false	no
wait	Will 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 true	bool	null	no

Outputs

Name	Description
cluster_checks	Cluster Checks for the cluster
metadata	Block status of the deployed release

References

• Datadog's Kubernetes Agent documentation
• cloudposse/terraform-aws-components - Cloud Posse's upstream component

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.