Variables de entorno del Agent

En el Agent v5, consulta el repositorio GitHub del Docker Agent.

Información general

En el Agent v6, la mayoría de las opciones de configuración del archivo de configuración principal del Agent (datadog.yaml) se pueden ajustar mediante variables de entorno.

Recomendaciones

Datadog recomienda utilizar el etiquetado de servicios unificado al asignar etiquetas (tags). Este sistema asocia toda la telemetría de Datadog mediante el uso de tres etiquetas estándar: env, service y version. Para saber cómo configurar tu entorno con el etiquetado unificado, consulta la documentación sobre el etiquetado de servicios unificado.

Uso general

En general, puedes utilizar las siguientes reglas:

  • Los nombres de las opciones deben ir 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 un formato JSON:

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

Prioridad de definición de la propiedad

  • Si una propiedad está definida en el archivo de configuración global (datadog.yaml) y también en una variable de entorno, la variable de entorno tiene prioridad.
  • La especificación de 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. Para ver más detalles, consulta la documentación del proxy del Agent.

Excepciones

  • No todas las opciones de datadog.yaml están disponibles con variables de entorno. Consulta config.go en el repositorio GitHub del Datadog Agent. Las opciones con variables de entorno comienzan por config.BindEnv*.

  • También pueden ser compatibles las variables de entorno específicas del componente que no aparezcan en config.go.

Uso de variables de entorno en unidades systemd

En los sistemas operativos que utilizan systemd para gestionar servicios, las variables de entorno globales (por ejemplo, /etc/environment) o basadas en sesiones (por ejemplo, export VAR=value) no suelen estar disponibles para servicios, a menos que se configuren para ello. Consulta la página de ejecución manual de systemd para obtener más información.

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

  1. Crea /etc/datadog-agent/environment si no existe.
  2. Define asignaciones de variables de entorno separadas por nuevas líneas. Por ejemplo:
GODEBUG=x509ignoreCN=0,x509sha1=1
DD_HOSTNAME=myhost.local
DD_TAGS=env:dev,service:foo
  1. Reinicia el servicio para que se apliquen los cambios

Referencias adicionales