Esta página explica cómo recopilar registros desde los archivos de registro de Kubernetes.

Cuando tus aplicaciones en contenedores escriben sus registros en la salida estándar y de error (stdout/stderr), el runtime del contenedor y Kubernetes gestionan automáticamente los registros por ti. El patrón predeterminado es que Kubernetes almacena estos flujos de registro como archivos en el host en la carpeta /var/log/pods y subcarpetas para cada pod y contenedor.

El Datadog Agent puede recoger estos archivos de registro de Kubernetes para estos contenedores utilizando las instrucciones a continuación. Esta opción se adapta bien a la naturaleza efímera de los pods que crea Kubernetes y es más eficiente en recursos que recoger registros del socket de Docker. Datadog recomienda este método para la recolección de registros en Kubernetes.

Alternativamente, el Datadog Agent también puede recoger registros mediante solicitudes repetidas a la API de Docker a través del socket de Docker. Sin embargo, esto requiere Docker como el tiempo de ejecución del contenedor para tu clúster de Kubernetes. Esto también es más intensivo en recursos que usar archivos de registro. Para ver cómo recolectar registros utilizando el socket de Docker, consulte Recolección de registros con el socket de Docker. Si tus aplicaciones en contenedores están escribiendo en archivos de registro almacenados en el contenedor, esto puede complicar la recolección de registros. Vea la recolección de registros desde un archivo.

Configuración

Recolección de registros

Antes de comenzar a recolectar los registros de la aplicación, asegúrate de que estás ejecutando el Datadog Agent en tu clúster de Kubernetes.

Para configurar la recolección de registros manualmente en el DaemonSet, consulta Recolección de registros del DaemonSet. De lo contrario, sigue las instrucciones a continuación:

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <DATADOG_API_KEY>

  features:
    logCollection:
      enabled: true
      containerCollectAll: true

kubectl apply -n $DD_NAMESPACE -f datadog-agent.yaml

datadog:
  logs:
    enabled: true
    containerCollectAll: true

Sin privilegios

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <DATADOG_API_KEY>

  features:
    logCollection:
      enabled: true
      containerCollectAll: true

  override:
    nodeAgent:
      securityContext:
        runAsUser: <USER_ID>
        supplementalGroups:
          - <DOCKER_GROUP_ID>

datadog:
  securityContext:
    runAsUser: <USER_ID>
    supplementalGroups:
      - <DOCKER_GROUP_ID>

Descubrimiento de registros

El Agente de Datadog en Kubernetes se despliega mediante un DaemonSet (gestionado por el Operador de Datadog o Helm). Este DaemonSet programa una réplica del Pod del Agente en cada nodo del clúster. Cada Pod del Agente es responsable de reportar los registros de los otros Pods y contenedores en su respectivo nodo. Cuando “Container Collect All” está habilitado, el Agente informa los registros de cada contenedor descubierto con un conjunto de etiquetas predeterminado.

Filtrado

Cuando “Container Collect All” está habilitado, puedes configurar de qué contenedores deseas recopilar registros. Esto puede ser útil para evitar la recopilación de los registros del Agente de Datadog, si así se desea. Puedes hacer esto pasando configuraciones al Agente de Datadog para controlar lo que extrae, o pasando configuraciones al Pod de Kubernetes para excluir ciertos registros de manera más explícita.

Al filtrar registros a través de métodos como DD_CONTAINER_EXCLUDE_LOGS o ad.datadoghq.com/logs_exclude, el Agente ignora la recopilación de registros independientemente de las configuraciones de recopilación de registros definidas explícitamente en anotaciones de Autodescubrimiento o archivos de configuración de Autodescubrimiento.

Cuando “Container Collect All” está deshabilitado (por defecto), no necesitas agregar ningún filtrado porque todo se excluye por defecto. Para incluir la colección solo para los pods seleccionados, puedes habilitar la configuración de registro mediante anotaciones de Autodiscovery o archivos de configuración de Autodiscovery para los pods deseados.

Consulta Gestión de Descubrimiento de Contenedores para aprender más sobre el filtrado.

Etiquetado

El Agente de Datadog etiqueta los registros de los contenedores de Kubernetes con las etiquetas por defecto de Kubernetes, así como cualquier etiqueta extraída personalizada. Cuando “Container Collect All” está habilitado, el Agente informa los registros de un contenedor con las etiquetas source y service que coinciden con el nombre corto de la imagen del contenedor. Por ejemplo, los registros de un contenedor que utiliza la imagen de contenedor gcr.io/owner/example-image:latest tendrían example-image como el valor de las etiquetas source, service y short_image.

La etiqueta service también puede ser establecida por la etiqueta de Pod tags.datadoghq.com/service: "<SERVICE>" de Unified Service Tagging. Para más información sobre los atributos source y service, consulta Atributos Reservados.

La etiqueta source puede ser importante para tus registros, ya que las canalizaciones de registro listas para usar se filtran utilizando esta etiqueta. Sin embargo, estas canalizaciones pueden ser completamente personalizadas según se desee. Puedes ver los pasos en la sección Registros de Integración a continuación para personalizar aún más las etiquetas en tus registros.

Registros de integración

Autodiscovery te permite usar plantillas para configurar la recopilación de registros (y otras capacidades) en contenedores. Esto se puede usar para habilitar la recolección de registros, personalizar el etiquetado y agregar reglas de recolección avanzadas. Para configurar la recolección de registros para una integración con Autodiscovery, puedes optar por:

• Especificar una configuración de registro como Anotaciones de Autodiscovery en un Pod dado, para configurar las reglas para un contenedor dado (Recomendado)
• Especificar una configuración de registro como un archivo de configuración, para configurar las reglas para cada contenedor coincidente por imagen.

Como mínimo, estas configuraciones de registro requieren una etiqueta source y service. Es posible que desees hacer coincidir la etiqueta source con una de las canalizaciones de registro listas para usar de Datadog para ayudar a enriquecer automáticamente tus registros. También puedes encontrar una biblioteca de canalizaciones en Datadog.

Anotaciones de Autodiscovery

Con Autodiscovery, el Agent busca automáticamente todas las anotaciones de Pod para plantillas de integración.

Para aplicar una configuración específica a un contenedor dado, agrega la anotación ad.datadoghq.com/<CONTAINER_NAME>.logs a tu Pod con la configuración de registro en formato JSON.

Nota: Las anotaciones de Autodiscovery identifican contenedores por nombre, no por imagen. Intenta hacer coincidir <CONTAINER_NAME> con el .spec.containers[i].name, no con .spec.containers[i].image.

Configura un solo contenedor

Para configurar la recolección de registros para un contenedor dado dentro de tu Pod, agrega las siguientes anotaciones a tu Pod:

apiVersion: v1
kind: Pod
# (...)
metadata:
  name: '<POD_NAME>'
  annotations:
    ad.datadoghq.com/<CONTAINER_NAME>.logs: '[<LOG_CONFIG>]'
    # (...)
spec:
  containers:
    - name: '<CONTAINER_NAME>'
# (...)

Ejemplo de anotaciones de Autodiscovery de registros

La siguiente anotación de Pod define la plantilla de integración para un contenedor de ejemplo. Se define dentro de las anotaciones de la plantilla de Pod, en lugar de en el Despliegue mismo. Esta configuración de registro establece todos los registros del contenedor app con las etiquetas source:java, service:example-app y la etiqueta adicional foo:bar.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: example
  labels:
    app: example-app
spec:
  selector:
    matchLabels:
      app: example-app
  template:
    metadata:
      labels:
        app: example-app
      annotations:
        ad.datadoghq.com/app.logs: '[{"source":"java", "service":"example-app", "tags":["foo:bar"]}]'
    spec:
      containers:
        - name: app
          image: owner/example-image:latest

Configura dos contenedores diferentes

Para aplicar dos plantillas de integración diferentes a dos contenedores diferentes dentro de tu Pod, <CONTAINER_NAME_1> y <CONTAINER_NAME_2>, agrega las siguientes anotaciones a tu Pod:

apiVersion: v1
kind: Pod
# (...)
metadata:
  name: '<POD_NAME>'
  annotations:
    ad.datadoghq.com/<CONTAINER_NAME_1>.logs: '[<LOG_CONFIG_1>]'
    # (...)
    ad.datadoghq.com/<CONTAINER_NAME_2>.logs: '[<LOG_CONFIG_2>]'
spec:
  containers:
    - name: '<CONTAINER_NAME_1>'
    # (...)
    - name: '<CONTAINER_NAME_2>'
# (...)

Archivos de configuración de Autodiscovery

Puedes proporcionar al Agente de Datadog archivos de configuración para que el Agente ejecute una integración específica cuando descubra un contenedor utilizando el identificador de imagen correspondiente. Esto te permite crear una configuración de registro genérica que se aplica a un conjunto de imágenes de contenedor.

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  #(...)
  override:
    nodeAgent:
      extraConfd:
        configDataMap:
          <INTEGRATION_NAME>.yaml: |-
            ad_identifiers:
            - <CONTAINER_IMAGE>
        
            logs:
            - source: example-source
              service: example-service

datadog:
  #(...)
  confd:
    <INTEGRATION_NAME>.yaml: |-
      ad_identifiers:
      - <CONTAINER_IMAGE>
      
      logs:
      - source: example-source
        service: example-service

etcdctl mkdir /datadog/check_configs/redis
etcdctl set /datadog/check_configs/redis/logs '[{"source": "redis", "service": "redis", "tags": ["env:prod"]}]'

config_providers:
  - name: etcd
    polling: true
    template_dir: /datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    username:
    password:

  - name: consul
    polling: true
    template_dir: datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    ca_file:
    ca_path:
    cert_file:
    key_file:
    username:
    password:
    token:

  - name: zookeeper
    polling: true
    template_dir: /datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    username:
    password:

/datadog/
  check_configs/
    <CONTAINER_IMAGE>/
      - logs: ["<LOGS_CONFIG>"]
    ...

Para hacer coincidir una configuración de registro a un conjunto de contenedores con más granularidad que la imagen corta del contenedor, consulta Identificadores de Contenedor de Autodetección.

Recolección avanzada de registros

Utilice etiquetas de registro de Autodiscovery para aplicar lógica de procesamiento de recolección avanzada de registros, por ejemplo:

• Filtrar registros antes de enviarlos a Datadog.
• Eliminar datos sensibles de tus registros.
• Proceder a la agregación de múltiples líneas.

Desde un archivo de registro local del contenedor

Datadog recomienda que utilices los flujos de salida stdout y stderr para aplicaciones en contenedores, para que puedas configurar automáticamente la recolección de registros.

Sin embargo, el Agent también puede recolectar registros directamente de un archivo basado en una anotación. Para recolectar estos registros, utiliza ad.datadoghq.com/<CONTAINER_NAME>.logs con una configuración de type: file y path. Los registros recolectados de archivos con tal anotación se etiquetan automáticamente con el mismo conjunto de etiquetas que los registros provenientes del contenedor mismo. Datadog recomienda que utilices los flujos de salida stdout y stderr para aplicaciones en contenedores, para que puedas configurar automáticamente la recolección de registros. Para más información, consulta las Configuraciones recomendadas.

Estas rutas de archivo son relativas al contenedor del Agent. Por lo tanto, el directorio que contiene el archivo de registro debe montarse tanto en la aplicación como en el contenedor del Agent para que el Agent tenga la visibilidad adecuada.

Por ejemplo, puedes hacer esto con un hostPath volumen compartido. El Pod a continuación está emitiendo registros en el archivo /var/log/example/app.log. Esto se realiza en el /var/log/example directorio, donde un volumen y un volumeMount han establecido esto como un hostPath.

apiVersion: v1
kind: Pod
metadata:
  name: logger
  annotations:
    ad.datadoghq.com/busybox.logs: |
      [{
          "type": "file",
          "path": "/var/log/example/app.log",
          "source": "example-source",
          "service": "example-service"
      }]
spec:
  containers:
   - name: busybox
     image: busybox
     command: [ "/bin/sh", "-c", "--" ]
     args: [ "while true; do sleep 1; echo `date` example file log >> /var/log/example/app.log; done;" ]
     volumeMounts:
     - name: applogs
       mountPath: /var/log/example
  volumes:
     - name: applogs
       hostPath:
         path: /var/log/example

La ruta equivalente de volumen y volumeMount debe establecerse en el contenedor del Agent para que pueda leer ese mismo archivo de registro.

  containers:
  - name: agent
    # (...)
    volumeMounts:
    - mountPath: /var/log/example
      name: applogs
    # (...)
  volumes:
  - name: applogs
    hostPath:
      path: /var/log/example
    # (...)

Configuraciones recomendadas

• Esta estrategia puede funcionar para un pod dado, pero puede volverse engorrosa con múltiples aplicaciones que utilizan esta estrategia. También puedes encontrar problemas si múltiples réplicas están utilizando la misma ruta de registro. Si es posible, Datadog recomienda aprovechar la variable de plantilla de Autodiscovery %%kube_pod_name%%. Por ejemplo, puedes configurar tu path para hacer referencia a esta variable: "path": "/var/log/example/%%kube_pod_name%%/app.log". Tu pod de aplicación también necesita escribir sus archivos de registro con respecto a esta nueva ruta. Puedes usar la API Descendente para ayudar a tu aplicación a determinar su nombre de Pod.

• Al usar este tipo de anotación con un contenedor, stdout y stderr los registros no se recopilan automáticamente del contenedor. Si se necesita la recopilación de ambas corrientes de salida del contenedor y del archivo, habilita esto explícitamente en la anotación. Por ejemplo:

  ad.datadoghq.com/<CONTAINER_IMAGE>.logs: |
    [
      {"type":"file","path":"/var/log/example/app.log","source":"file","service":"example-service"},
      {"source":"container","service":"example-service"}
    ]
  

• Al usar este tipo de combinación, source y service no tienen un valor predeterminado para los registros recopilados de un archivo y deben establecerse explícitamente en la anotación.

Solución de problemas

Para los pasos de solución de problemas, consulta Solución de problemas de recopilación de registros de contenedor.

Lectura adicional

Más enlaces, artículos y documentación útiles:

Monitorea los registros de Amazon EKS en Fargate con DatadogBLOG Recoge las trazas de tu aplicaciónDOCUMENTACIÓN Recoge tus métricas de PrometheusDOCUMENTACIÓN Recoge automáticamente las métricas y registros de tus aplicacionesDOCUMENTACIÓN Limita la recolección de datos a un subconjunto de contenedores solamenteDOCUMENTACIÓN Asigna etiquetas a todos los datos emitidos por un contenedorDOCUMENTACIÓN Solución de problemas de recolección de registros de contenedorDOCUMENTACIÓN