Variables de entorno del Agent

Para el Agent v5, consulte el repositorio de GitHub del Docker Agent.

Descripción general

Para el Agent v6, la mayoría de las opciones de configuración en el archivo de configuración principal del Agent (datadog.yaml) pueden establecerse a través de variables de entorno. Consulte los archivos de configuración de ejemplo en el repositorio de GitHub de Datadog Agent para obtener una referencia completamente comentada de todos los ajustes datadog.yaml disponibles.

Recomendaciones

Como mejor práctica, Datadog recomienda usar unified service tagging al asignar etiquetas. Unified service tagging vincula la telemetría de Datadog mediante el uso de tres etiquetas estándar: env, service y version. Para aprender cómo configurar su entorno con unified service tagging, consulte la documentación de unified service tagging.

Uso general

En general, utilice las siguientes reglas:

  • Los nombres de las opciones deben estar en mayúsculas con el prefijo DD_: hostname -> DD_HOSTNAME

  • Los valores de la lista deben estar separados por espacios (las reglas de inclusión admiten expresiones regulares y se definen como una lista de cadenas separadas por comas):

       container_include:
         - "image:cp-kafka"
         - "image:k8szk"
       # DD_CONTAINER_INCLUDE="image:cp-kafka image:k8szk"
    
  • El anidamiento de opciones de configuración con claves predefinidas debe separarse con un guion bajo:

       cluster_agent:
         cmd_port: 5005
       # DD_CLUSTER_AGENT_CMD_PORT=5005
    
  • El anidamiento de opciones de configuración con claves definidas por el usuario debe tener formato JSON:

       container_env_as_tags:
         ENVVAR_NAME: tag_name
       # DD_CONTAINER_ENV_AS_TAGS='{"ENVVAR_NAME": "tag_name"}'
    

Prioridad de definición de propiedades

  • Si una propiedad se define tanto en el archivo de configuración global (datadog.yaml) como en una variable de entorno, la variable de entorno tiene prioridad.
  • Especificar una opción anidada con una variable de entorno anula todas las opciones anidadas especificadas bajo la opción de configuración. La excepción a esta regla es la opción de configuración proxy. Consulte la documentación del proxy del Agent para obtener más detalles.

Excepciones

Uso de variables de entorno en unidades de systemd

En los sistemas operativos que utilizan systemd para administrar servicios, las variables de entorno (globales, por ejemplo, /etc/environment, o basadas en sesiones, por ejemplo, export VAR=value) generalmente no están disponibles para los servicios a menos que se configuren para ello. Consulte la página del manual de systemd Exec para obtener más detalles.

A partir de Datadog Agent 7.45, el servicio Datadog Agent (unidad datadog-agent.service) puede cargar opcionalmente asignaciones de variables de entorno desde un archivo (<ETC_DIR>/environment).

  1. Cree /etc/datadog-agent/environment si no existe.
  2. Defina las asignaciones de variables de entorno separadas por saltos de línea. Ejemplo:
GODEBUG=x509ignoreCN=0,x509sha1=1
DD_HOSTNAME=myhost.local
DD_TAGS=env:dev service:foo
  1. Reinicie el servicio para que los cambios surtan efecto.

Lecturas adicionales