Descripción general

A partir de OpenTelemetry Collector Contrib modules v0.129.0 y versiones posteriores, la extensión de Datadog se incluye en las distribuciones Contrib de OpenTelemetry Collector. También está disponible para compilación personalizada de OpenTelemetry Collector. En el DDOT Collector, la extensión se habilita automáticamente.

La extensión de Datadog le permite visualizar la configuración y la información de compilación del OpenTelemetry Collector directamente en Datadog mediante Fleet Automation, la Lista de infraestructura y Resource Catalog. La extensión funciona con la configuración recomendada del exportador OTLP HTTP y con el exportador de Datadog.

Características clave

• Visibilidad de la configuración del Collector: visualice la configuración completa de cualquier OTel Collector en su infraestructura.
• Información de compilación: vea la versión del Collector, los detalles de compilación y la información de los componentes.
• Punto de conexión de inspección local: utilice un punto de conexión HTTP para la depuración local y la verificación de la configuración.
• Gestión de flotas: haga un seguimiento y gestione su flota de OpenTelemetry Collector desde la interfaz de usuario de Datadog.

Configuración

1. Agregue la extensión de Datadog a su configuración del Collector

Configure la extensión de Datadog en su archivo de configuración de OpenTelemetry Collector:

extensions:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    # hostname: "my-collector-host"  # Optional: must match the hostname in exported telemetry

service:
  extensions: [datadog]

2. Configure un pipeline de telemetría activo

Configure al menos un pipeline de telemetría activo y exporte sus datos a Datadog. Para la configuración recomendada, utilice la configuración del exportador OTLP HTTP.

La extensión utiliza metadatos del Collector y del servidor para asociar la configuración reportada con el servidor correspondiente en Datadog.

3. (Opcional) Agregue atributos de recurso personalizados

La extensión de Datadog recopila automáticamente los atributos de recurso de la telemetría interna del colector y los incluye en la carga útil de metadatos que envía a Datadog. Para adjuntar atributos personalizados como el entorno de despliegue, el equipo o el nombre del clúster de Kubernetes, establézcalos bajo service.telemetry.resource:

service:
  telemetry:
    resource:
      deployment.environment.name: production
      team.name: platform
      k8s.cluster.name: prod-us-east1-cluster-a

El Collector adjunta automáticamente service.name, service.version y service.instance.id (un UUID generado aleatoriamente) a su telemetría interna. No necesita configurarlos manualmente.

4. (Opcional) Configure la topología de puerta de enlace (vista previa)

Cuando tiene una configuración de puerta de enlace de OpenTelemetry Collector que reenvía telemetría a través de uno o más colectores de puerta de enlace antes de llegar a Datadog, la extensión de Datadog puede publicar la topología para que aparezca como un gráfico de canalización conectado en Fleet Automation:

Para habilitar esta vista, configure cada Collector en la canalización:

• Establezca deployment_type en daemonset para los Collectors de agente o DaemonSet y en gateway para los Collectors de puerta de enlace.
• Establezca gateway_destination en los Collectors que reenvían a una puerta de enlace descendente. El valor es el servicio de Kubernetes de la puerta de enlace receptora, en forma de <namespace>/<service>.
• Establezca gateway_service en los colectores de puerta de enlace. El valor es el servicio de Kubernetes que está frente a los pods de la puerta de enlace.
• Una puerta de enlace intermedia en una canalización de varias capas establece ambos gateway_service (su propio servicio) y gateway_destination (la siguiente puerta de enlace).
• Establezca k8s.cluster.name bajo service.telemetry.resource en cada Collector de la canalización. Esto es obligatorio: junto con gateway_service y gateway_destination, forma la clave de unión que Fleet Automation utiliza para reconstruir el gráfico de la canalización.
• Habilite las métricas internas del Collector para que la extensión pueda atribuir los datos de volumen de registros, métricas o trazas a cada borde en el gráfico con el interruptor Mostrar tráfico. Consulte Métricas de estado del OpenTelemetry Collector.

El ejemplo a continuación cubre el caso común de dos capas: un DaemonSet local al nodo reenvía a un Deployment de puerta de enlace, el cual envía a Datadog con el Datadog Exporter.

Cada Collector expone sus propias métricas de estado en un punto de conexión de extracción de Prometheus a través de service.telemetry.metrics, extrae ese punto de conexión con un receptor prometheus/internal y enruta el resultado a través de la misma canalización de métricas que la telemetría de la aplicación. Esto es lo que completa cada nodo y borde en la visualización de topología.

DaemonSet Collector

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
  prometheus/internal:
    config:
      scrape_configs:
        - job_name: otelcol-internal
          scrape_interval: 10s
          static_configs:
            - targets: ['localhost:8888']

exporters:
  otlp:
    endpoint: otelcol-gateway.monitoring.svc.cluster.local:4317
    tls:
      insecure: true

extensions:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    deployment_type: daemonset
    gateway_destination: monitoring/otelcol-gateway

service:
  telemetry:
    metrics:
      level: normal
      readers:
        - pull:
            exporter:
              prometheus:
                host: 0.0.0.0
                port: 8888
                without_type_suffix: true
                without_units: true
    resource:
      k8s.cluster.name: my-cluster
      k8s.node.name: ${env:K8S_NODE_NAME}
      k8s.pod.name: ${env:K8S_POD_NAME}
  extensions: [datadog]
  pipelines:
    metrics:
      receivers: [otlp, prometheus/internal]
      exporters: [otlp]
    traces:
      receivers: [otlp]
      exporters: [otlp]
    logs:
      receivers: [otlp]
      exporters: [otlp]

La canalización metrics del DaemonSet incluye prometheus/internal para que las propias métricas de estado del Collector viajen a través de OTLP a la puerta de enlace junto con la telemetría de la aplicación, llegando a Datadog a través del Datadog Exporter de la puerta de enlace.

Gateway Collector

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
  prometheus/internal:
    config:
      scrape_configs:
        - job_name: otelcol-internal
          scrape_interval: 10s
          static_configs:
            - targets: ['localhost:8888']

exporters:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    metrics:
      resource_attributes_as_tags: true
    sending_queue:
      batch:
        flush_timeout: 10s

extensions:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    deployment_type: gateway
    gateway_service: monitoring/otelcol-gateway

service:
  telemetry:
    metrics:
      level: normal
      readers:
        - pull:
            exporter:
              prometheus:
                host: 0.0.0.0
                port: 8888
                without_type_suffix: true
                without_units: true
    resource:
      k8s.cluster.name: my-cluster
      k8s.node.name: ${env:K8S_NODE_NAME}
      k8s.pod.name: ${env:K8S_POD_NAME}
  extensions: [datadog]
  pipelines:
    metrics:
      receivers: [otlp, prometheus/internal]
      exporters: [datadog]
    traces:
      receivers: [otlp]
      exporters: [datadog]
    logs:
      receivers: [otlp]
      exporters: [datadog]

La canalización metrics de la puerta de enlace acepta tanto la telemetría reenviada (desde el DaemonSet a través de OTLP) como sus propias métricas internas desde prometheus/internal, luego exporta todo a Datadog.

Canalizaciones de puerta de enlace de múltiples capas

Para canalizaciones con más de una capa de puerta de enlace, configure gateway_service y gateway_destination juntos en la capa intermedia. Por ejemplo, en una topología de tres capas con una puerta de enlace de Capa 2 entre el DaemonSet y una puerta de enlace de Capa 1, la extensión de la puerta de enlace de Capa 2 se configura de la siguiente manera:

extensions:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    deployment_type: gateway
    gateway_service: monitoring/otelcol-gateway-l2
    gateway_destination: monitoring/otelcol-gateway-l1

El DaemonSet reenvía a monitoring/otelcol-gateway-l2, la puerta de enlace de Capa 2 reenvía a monitoring/otelcol-gateway-l1, y la puerta de enlace de Capa 1 envía a Datadog. Cada Collector informa el mismo k8s.cluster.name.

Opciones de configuración

Ejemplo de configuración completa con el exportador de Datadog

El siguiente ejemplo utiliza el exportador de Datadog. La extensión en sí no lo requiere; para la canalización recomendada, utilice la configuración del exportador HTTP de OTLP de Configurar OpenTelemetry Collector.

extensions:
  datadog:
    api:
      key: ${env:DD_API_KEY}
      site: 
    hostname: "my-collector-host"
    http:
      endpoint: "localhost:9875"
      path: "/metadata"
    proxy_url: "http://proxy.example.com:8080"
    timeout: 30s
    tls:
      insecure_skip_verify: false

exporters:
  datadog/exporter:
    api:
      key: ${env:DD_API_KEY}
      site: 
    hostname: "my-collector-host"
    sending_queue:
      batch:
        flush_timeout: 10s

service:
  extensions: [datadog]
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [datadog/exporter]
    metrics:
      receivers: [otlp]
      exporters: [datadog/exporter]

Visualización de la configuración del Collector

Una vez configurado, puede visualizar la configuración de su OpenTelemetry Collector y la información de compilación en varias ubicaciones:

Fleet Automation

1. Navegue a Integrations > Fleet Automation.
2. Filtre los servidores del OTel Collector usando las facetas del Collector y luego haga clic en un servidor.
3. En el panel lateral, seleccione la pestaña Info para visualizar la información de compilación.
4. Seleccione la pestaña Configurations para visualizar el archivo YAML completo o una visualización de la canalización de las configuraciones de su OTel Collector.

Lista de infraestructura (Lista de servidores)

1. Navegue a Infrastructure > Hosts en su cuenta de Datadog.
2. Haga clic en cualquier servidor que ejecute el OpenTelemetry Collector (Nota: filtre por field:apps:otel para mostrar solo las instancias del Collector).
3. En el panel de detalles del servidor, seleccione la pestaña OTel Collector para ver la información de compilación y la configuración completa del Collector.

Resource Catalog

1. Navegue a Infrastructure > Resource Catalog en su cuenta de Datadog
2. Filtre por servidores o busque sus instancias del Collector.
3. Haga clic en cualquier servidor que ejecute el OpenTelemetry Collector.
4. Desplácese hacia abajo hasta Collector para ver la información de compilación y la configuración completa del Collector.

Servidor HTTP local

La extensión de Datadog incluye un servidor HTTP local para depuración e inspección:

# Access collector metadata locally
curl http://localhost:9875/metadata

Este punto de conexión proporciona:

• Configuración del Collector (sin información confidencial)
• Información de compilación y detalles de la versión
• Lista de componentes activos
• Estado de la extensión

Solución de problemas

Configuración que no aparece en Datadog

1. Verificar la coincidencia del nombre de servidor: Confirme que el nombre de servidor de la extensión de Datadog coincida con el nombre de servidor en la telemetría exportada. Si utiliza el Datadog Exporter, confirme que su nombre de servidor también coincida.
2. Verificar la clave de API: Confirme que la clave de API sea válida y tenga los permisos adecuados.
3. Verificar los registros del Collector: Busque los registros de inicialización de la extensión y de envío de datos.
4. Confirmar que la extensión esté habilitada: Verifique que la extensión aparezca en la configuración del servicio.

Problemas del servidor HTTP

1. Conflictos de puerto: Asegúrese de que el puerto 9875 esté disponible o configure un puerto diferente.
2. Acceso a la red: Verifique que el servidor HTTP sea accesible desde su ubicación de depuración.
3. Verificar los registros: Revise los registros de la extensión para detectar problemas de inicio del servidor HTTP.

Lecturas adicionales

Documentación, enlaces y artículos útiles adicionales:

Configuración del OpenTelemetry CollectorDOCUMENTACIÓN Lista de infraestructuraDOCUMENTACIÓN Resource CatalogDOCUMENTACIÓN