Datadog APM es compatible con NGINX en dos configuraciones:

• NGINX funcionaba como proxy con el rastreo proporcionado por el módulo de Datadog.
• NGINX como controlador Ingress para Kubernetes.

NGINX con el módulo de Datadog

Datadog proporciona un módulo NGINX para el rastreo distribuido.

Instalación del módulo

Para instalar el módulo NGINX de Datadog, sigue las siguientes instrucciones:

1. Descarga la versión adecuada del último lanzamiento de Nginx-Datadog en GitHub
2. Elige el archivo .tar correspondiente a la versión de NGINX y a la arquitectura de CPU específicas.

Cada versión incluye dos archivos .tar por cada combinación de la versión de NGINX y la arquitectura de CPU. El archivo .tar principal contiene un único archivo, ngx_http_datadog_module.so, que es el módulo NGINX de Datadog. El segundo contiene símbolos de depuración y es opcional.

Para simplificar el proceso, el siguiente script sólo descarga el módulo de la última versión:

get_latest_release() {
  curl --silent "https://api.github.com/repos/$1/releases/latest" | jq --raw-output .tag_name
}

get_architecture() {
  case "$(uname -m)" in
    aarch64|arm64)
      echo "arm64"
      ;;
    x86_64|amd64)
      echo "amd64"
      ;;
    *)
      echo ""
      ;;
  esac
}

ARCH=$(get_architecture)

if [ -z "$ARCH" ]; then
    echo 1>&2 "ERROR: Architecture $(uname -m) is not supported."
    exit 1
fi

NGINX_VERSION="1.26.0"
RELEASE_TAG=$(get_latest_release DataDog/nginx-datadog)
TARBALL="ngx_http_datadog_module-${ARCH}-${NGINX_VERSION}.so.tgz"

curl -Lo ${TARBALL} "https://github.com/DataDog/nginx-datadog/releases/download/${RELEASE_TAG}/${TARBALL}"

Extrae el archivo ngx_http_datadog_module.so del tarball descargado mediante tar y colócalo en el directorio de módulos de NGINX, situado normalmente en /usr/lib/nginx/modules.

Configuración de NGINX con el módulo de Datadog

En la sección superior de configuración de NGINX, carga el módulo de Datadog.

load_module modules/ngx_http_datadog_module.so;

La configuración por defecto se conecta a un Datadog Agent local y produce trazas para todas las localizaciones de NGINX. Especifica una configuración personalizada utilizando las directivas exclusivas datadog_* descritas en la documentación de la API del módulo de Datadog.

Por ejemplo, la siguiente configuración de NGINX define el nombre del servicio como usage-internal-nginx y la frecuencia de muestreo en 10%.

load_module modules/ngx_http_datadog_module.so;

http {
  datadog_service_name usage-internal-nginx;
  datadog_sample_rate 0.1;

  # servidores, localizaciones...
}

Controlador Ingress-NGINX para Kubernetes

Datadog ofrece soporte para monitorizar el controlador Ingress-NGINX en Kubernetes. Elige entre los siguientes métodos de instrumentación en función de la versión y los requisitos de tu controlador:

• v1.10.0+ con las características de Datadog.
• v1.10.0+ con OpenTelemetry.
• v1.9.0 y anteriores.

Controlador v1.10.0+ con las características de Datadog

Este método de instrumentación utiliza nginx-datadog y aprovecha el mecanismo init-container de Kubernetes para instalar el módulo dentro de la instancia del controlador Ingress-NGINX.

Para instrumentar Ingress-NGINX v1.10.0+ mediante el módulo de Datadog, sigue estos pasos:

    spec:
      template:
        spec:
          initContainers:
            - name: init-datadog
              image: datadog/ingress-nginx-injection:<MY_INGRESS_NGINX_VERSION>
              command: ['/datadog/init_module.sh', '/opt/datadog-modules']
              volumeMounts:
                - name: nginx-module
                  mountPath: /opt/datadog-modules
          containers:
            - name: controller
              image: registry.k8s.io/ingress-nginx/controller:<MY_INGRESS_NGINX_VERSION>
              env:
                - ...
                - name: DD_AGENT_HOST
                  valueFrom:
                    fieldRef:
                      fieldPath: status.hostIP

    kind: ConfigMap
    apiVersion: v1
    ...
    data:
      enable-opentelemetry: "false"
      error-log-level: notice
      main-snippet: |
        load_module /opt/datadog-modules/ngx_http_datadog_module.so;        

controller:
  config:
    main-snippet: "load_module /modules_mount/ngx_http_datadog_module.so;"
  opentelemetry:
    enabled: false
  extraModules:
    - name: nginx-datadog
      image:
        registry: docker.io
        image: datadog/ingress-nginx-injection
        # La etiqueta debe coincidir con la versión del controlador ingress-nginx
        # Por ejemplo, esto inyectará el módulo de Datadog para ingress v1.10.0
        # Comprueba <https://hub.docker.com/repository/docker/datadog/ingress-nginx-injection/tags>
        # para obtener la lista de todas las versiones admitidas.
        tag: "v1.10.0"
        distroless: false
  extraEnvs:
    - name: DD_AGENT_HOST
      valueFrom:
        fieldRef:
          fieldPath: status.hostIP

helm install my-release ingress-nginx/ingress-nginx -f values.yaml

Controlador v1.10.0+ con OpenTelemetry

- name: HOST_IP
  valueFrom:
    fieldRef:
      fieldPath: status.hostIP
- name: OTEL_EXPORTER_OTLP_ENDPOINT
  value: "http://$(HOST_IP):4317"

apiVersion: v1
kind: ConfigMap
metadata:
  name: ingress-nginx-controller
  namespace: ingress-nginx
data:
  enable-opentelemetry: "true"
  otel-sampler: AlwaysOn
  # Por defecto
  # otel-service-name: "nginx"
  # otel-sampler-ratio: 0.01

controller:
  opentelemetry:
    enabled: true
  config:
    otel-service-name: "nginx"
    otel-sampler: AlwaysOn
    otel-sampler-ratio: 0.01
  extraEnvs:
    - name: HOST_IP
      valueFrom:
        fieldRef:
          fieldPath: status.hostIP
    - name: OTEL_EXPORTER_OTLP_ENDPOINT
      value: "http://$(HOST_IP):4317"

helm install my-release ingress-nginx/ingress-nginx -f values.yaml

Controlador v1.9.0 y anteriores

Para habilitar el rastreo en Datadog, crea o edita un ConfigMap para configurarenable-opentracing: "true" y el datadog-collector-host al que se deben enviar trazas. El nombre del ConfigMap lo cita explícitamente el argumento de línea de comandos del contenedor del controlador Ingress-NGINX. Por defecto es --configmap=<POD_NAMESPACE>/nginx-configuration. Si ingress-nginx se ha instalado utilizando el chart Helm, el nombre del ConfigMap seguirá el patrón <RELEASE_NAME>-nginx-ingress-controller.

El controlador Ingress gestiona los archivos nginx.conf y /etc/nginx/opentracing.json. El rastreo está habilitado para todos los bloques de location.

kind: ConfigMap
apiVersion: v1
metadata:
  name: nginx-configuration
  namespace: ingress-nginx
  labels:
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: ingress-nginx
data:
  enable-opentracing: "true"
  datadog-collector-host: $HOST_IP
  # Por defecto
  # datadog-service-name: "nginx"
  # datadog-collector-port: "8126"
  # datadog-operation-name-override: "nginx.handle"
  # datadog-sample-rate: "1.0"

Además, asegúrate de que la especificación del pod de tu controlador tiene definida la variable de entorno HOST_IP. Añade esta entrada al bloque env: que contiene las variables de entorno POD_NAME y POD_NAMESPACE.

- name: HOST_IP
  valueFrom:
    fieldRef:
      fieldPath: status.hostIP

Para definir un nombre de servicio diferente por cada Ingress, utilizando anotaciones:

  nginx.ingress.kubernetes.io/configuration-snippet: |
      opentracing_tag "service.name" "custom-service-name";      

Lo anterior anula el nombre de servicio nginx-ingress-controller.ingress-nginx por defecto.

Referencias adicionales

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

Sitio web de NGINXSITIO EXTERNO OpenTelemetry para el controlador Ingress-NGINXSITIO EXTERNO