Los servicios a menudo manejan puntos de conexión cuyo tráfico puede que no desees trazar (por ejemplo, las verificaciones de salud). Esta guía explica los siguientes enfoques para excluir ese tráfico:

• Muestreo: Utiliza cuando deseas que las solicitudes permanezcan visibles en las métricas de traza, pero reducir el volumen de ingesta de traza.
• Filtrado en el Agente de Datadog: Utiliza para excluir solicitudes por completo (incluyendo de las métricas de traza) en todos los servicios que reportan al Agente.
• Configuración del rastreador: Utiliza cuando la lógica de filtrado debe aplicarse por servicio o depende del contexto específico de la aplicación (por ejemplo, atributos de solicitud o estado de ejecución).

Si necesitas asistencia para decidir cuál opción es la más relevante para tu caso de uso, contacta a soporte de Datadog.

Muestreo

Si deseas que el tramo esté incluido en las métricas de traza pero no quieres que sea ingerido, utiliza reglas de muestreo. Para más información sobre muestreo, consulta Controles de Ingesta.

Usando reglas de muestreo

El enfoque recomendado es utilizar reglas de muestreo, que te permiten muestrear trazas basadas en nombres de recursos, nombres de servicios, etiquetas y nombres de operaciones:

DD_TRACE_SAMPLING_RULES='[{"resource": "GET healthcheck", "sample_rate": 0.0}]'

O muestrear basado en etiquetas de URL HTTP:

DD_TRACE_SAMPLING_RULES='[{"tags": {"http.url": "http://.*/healthcheck$"}, "sample_rate": 0.0}]'

Filtrado en el Agente de Datadog

Si no deseas que el tramo se ingeste o se refleje en las métricas de traza, utiliza el filtrado en el Agente de Datadog.

El componente Trace Agent dentro del Agente de Datadog tiene dos métodos para evitar que ciertas trazas sean enviadas: filtrado por etiquetas de tramo o filtrado por recursos. Si las trazas son descartadas debido a estas configuraciones, las métricas de traza excluyen estas solicitudes.

Configurar el Trace Agent para ignorar ciertas trazas o recursos se aplica a todos los servicios que envían trazas a este Agente de Datadog. Si tienes requisitos específicos de la aplicación, utiliza la configuración del rastreador en su lugar.

Ignorando trazas basadas en etiquetas de tramo

A partir de Datadog Agent 6.27.0/7.27.0, la opción filter tags descarta trazas con tramos raíz que coinciden con las etiquetas de tramo especificadas. Esta opción se aplica a todos los servicios que envían trazas a este Datadog Agent. Las trazas que son descartadas debido a las etiquetas de filtro no se incluyen en las métricas de traza.

Comportamiento de coincidencia:

La opción de filtrar etiquetas requiere una coincidencia exacta de cadena. Para filtrado basado en regex, consulte Ignorando basado en recursos.

Cuando especificas múltiples etiquetas, el filtro utiliza lógica OR: las trazas son descartadas si el tramo raíz coincide con cualquiera de las etiquetas. Para coincidir múltiples condiciones simultáneamente, agrega una etiqueta personalizada que represente esos criterios combinados.

Configuración:

Puedes especificar etiquetas de tramo para requerir o rechazar utilizando una lista de claves y valores separados por espacios en las variables de entorno:

DD_APM_FILTER_TAGS_REQUIRE

Recoge solo trazas que tienen tramos raíz con una coincidencia exacta para las etiquetas y valores de tramo especificados. Si no coincide con esta regla, la traza se descarta. Por ejemplo, DD_APM_FILTER_TAGS_REQUIRE="key1:value1 key2:value2". En Datadog Agent 7.49+, se pueden proporcionar expresiones regulares con DD_APM_FILTER_TAGS_REGEX_REQUIRE.

DD_APM_FILTER_TAGS_REJECT

Rechaza trazas que tienen tramos raíz con una coincidencia exacta para las etiquetas y valores de tramo especificados. Si coincide con esta regla, la traza se descarta. Por ejemplo, DD_APM_FILTER_TAGS_REJECT="key1:value1 key2:value2". En Datadog Agent 7.49+, se pueden proporcionar expresiones regulares con DD_APM_FILTER_TAGS_REGEX_REJECT.

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  override:
    nodeAgent:
      containers:
        trace-agent:
          env:
            - name: DD_APM_FILTER_TAGS_REJECT
              value: tag_key1:tag_val2 tag_key2:tag_val2

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

agents:
  containers:
    traceAgent:
      env:
        - name: DD_APM_FILTER_TAGS_REJECT
          value: tag_key1:tag_val2 tag_key2:tag_val2

helm upgrade -f datadog-values.yaml <RELEASE NAME> datadog/datadog

apm_config:
  filter_tags:
    require: ["db:sql", "db.instance:mysql"]
    reject: ["outcome:success", "key2:value2"]

apm_config:
  filter_tags:
    reject: ["http.url:http://localhost:5050/healthcheck"]

Etiquetas de tramo disponibles

En el backend, Datadog crea las siguientes etiquetas de tramo en los tramos después de la ingestión.

Nota: Estas etiquetas no se pueden usar para descartar trazas a nivel del Datadog Agent. El agente solo filtra en función de las etiquetas disponibles antes de la ingestión.

Comunicaciones de red

Solicitudes HTTP

Base de datos

Cola de Mensajes

Llamadas a procedimientos remotos

Errores

Ignorando trazas basadas en recursos

La opción ignorar recursos permite excluir recursos si el tramo raíz global de la traza coincide con ciertos criterios. Consulte Excluir recursos de ser recolectados. Esta opción se aplica a todos los servicios que envían trazas a este Agente de Datadog en particular. Las trazas que se descartan debido a recursos ignorados no se incluyen en las métricas de traza.

Puede especificar recursos a ignorar ya sea en el archivo de configuración del Agente, datadog.yaml, o con la variable de entorno DD_APM_IGNORE_RESOURCES. Consulte los ejemplos a continuación.

Usando datadog.yaml:

apm_config:
## @param ignore_resources - list of strings - optional
## A list of regular expressions can be provided to exclude certain traces based on their resource name.
## All entries must be surrounded by double quotes and separated by commas.

  ignore_resources: ["(GET|POST) /healthcheck","API::NotesController#index"]

Usando DD_APM_IGNORE_RESOURCES:

DD_APM_IGNORE_RESOURCES="(GET|POST) /healthcheck,API::NotesController#index"

Notas:

• Al usar el formato de variable de entorno (DD_APM_IGNORE_RESOURCES), los valores deben proporcionarse como una lista de cadenas separadas por comas.
• La sintaxis regex que acepta el Agente de Trazas es evaluada por regexp de Go.
• Dependiendo de su estrategia de implementación, es posible que deba ajustar la regex escapando caracteres especiales.
• Si utiliza contenedores dedicados con Kubernetes, asegúrese de que la variable de entorno para la opción de recurso ignorado se esté aplicando al contenedor trace-agent.

Ejemplo

Considere una traza que contiene llamadas a /api/healthcheck de las que no desea trazas:

Tome nota del nombre del recurso del span raíz global.

• Nombre de la operación: rack.request
• Nombre del recurso: Api::HealthchecksController#index
• Http.url: /api/healthcheck

Para usar correctamente la opción de recurso ignorado, la regla regex escrita debe coincidir con el nombre del recurso, Api::HealthchecksController#index. Existen algunas opciones de regex, pero para filtrar rastros de este recurso tal como está, un regex potencial a utilizar es Api::HealthchecksController#index$.

Dependiendo de cómo lo implementes, la sintaxis se ve un poco diferente:

apm_config:
  ignore_resources: Api::HealthchecksController#index$

apm_config:
  ignore_resources: ["value1","Api::HealthchecksController#index$"]

    environment:
      // other Datadog Agent environment variables
      - DD_APM_IGNORE_RESOURCES=Api::HealthchecksController#index$$

    environment:
      // other Datadog Agent environment variables
      - DD_APM_IGNORE_RESOURCES="value1","Api::HealthchecksController#index$$"

docker run -d --name datadog-agent \
              --cgroupns host \
              --pid host \
              -v /var/run/docker.sock:/var/run/docker.sock:ro \
              -v /proc/:/host/proc/:ro \
              -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
              -e DD_API_KEY=<> \
              -e DD_APM_IGNORE_RESOURCES="Api::HealthchecksController#index$" \
              -e DD_APM_ENABLED=true \
              -e DD_APM_NON_LOCAL_TRAFFIC=true \
              registry.datadoghq.com/agent:latest

              -e DD_APM_IGNORE_RESOURCES=["value1","Api::HealthchecksController#index$"] \

    - name: trace-agent
        image: "registry.datadoghq.com/agent:latest"
        imagePullPolicy: IfNotPresent
        command: ["trace-agent", "-config=/etc/datadog-agent/datadog.yaml"]
        resources: {}
        ports:
        - containerPort: 8126
          hostPort: 8126
          name: traceport
          protocol: TCP
        env:
        - name: DD_API_KEY
          valueFrom:
            secretKeyRef:
              name: "datadog-secret"
              key: api-key
        - name: DD_KUBERNETES_KUBELET_HOST
          valueFrom:
            fieldRef:
              fieldPath: status.hostIP
        - name: KUBERNETES
          value: "yes"
        - name: DOCKER_HOST
          value: unix:///host/var/run/docker.sock
        - name: DD_LOG_LEVEL
          value: "INFO"
        - name: DD_APM_ENABLED
          value: "true"
        - name: DD_APM_NON_LOCAL_TRAFFIC
          value: "true"
        - name: DD_APM_RECEIVER_PORT
          value: "8126"
        - name: DD_KUBELET_TLS_VERIFY
          value: "false"
        - name: DD_APM_IGNORE_RESOURCES
          value: "Api::HealthchecksController#index$"

        - name: DD_APM_IGNORE_RESOURCES
          value: '"value1","Api::HealthchecksController#index$"'

    traceAgent:
      # agents.containers.traceAgent.env -- Additional environment variables for the trace-agent container
      env:
        - name: DD_APM_IGNORE_RESOURCES
          value: Api::HealthchecksController#index$

        - name: DD_APM_IGNORE_RESOURCES
          value: value1, Api::HealthchecksController#index$

helm install dd-agent -f values.yaml \
  --set datadog.apiKeyExistingSecret="datadog-secret" \
  --set agents.containers.traceAgent.env[0].name=DD_APM_IGNORE_RESOURCES, \
    agents.containers.traceAgent.env[0].value="Api::HealthchecksController#index$" \
  datadog/datadog

    "environment": [
	// other environment variables for the Datadog Agent
        {
          "name": "DD_APM_IGNORE_RESOURCES",
          "value": "Api::HealthchecksController#index$"
        }
     ]

Configuración del trazador

Algunos trazadores para algunos lenguajes pueden descartar trazas antes de que sean enviadas al Agente de Datadog. Usa esta opción si tienes requisitos específicos de la aplicación.

Datadog::Tracing.before_flush(
   Datadog::Tracing::Pipeline::SpanFilter.new { |span| span.resource =~ /Api::HealthchecksController#index/ }
)

from ddtrace.trace import tracer
from ddtrace.trace import TraceFilter
import re

class CustomFilter(TraceFilter):
    def __init__(self, pattern):
        self.pattern = re.compile(pattern)

    def process_trace(self, trace):
        for span in trace:
            if span.get_tag('http.url') and self.pattern.match(span.get_tag('http.url')):
                return None  # Drop the trace
        return trace  # Keep the trace

# Configure the SDK with your custom filter
tracer.configure(trace_processors=[CustomFilter(r'http://.*/healthcheck$')])

const tracer = require('dd-trace').init();
tracer.use('http', {
  // incoming http requests match on the path
  server: {
    blocklist: ['/healthcheck']
  },
  // outgoing http requests match on a full URL
  client: {
    blocklist: ['https://telemetry.example.org/api/v1/record']
  }
})

//import http

public class GreetingController {
   static {
       // In a class static block to avoid initializing multiple times.
       GlobalTracer.get().addTraceInterceptor(new TraceInterceptor() {
           @Override
           public Collection<? extends MutableSpan> onTraceComplete(Collection<? extends MutableSpan> trace) {
               for (MutableSpan span : trace) {
                   if ("GET /healthcheck".contentEquals(span.getResourceName())) {
                       return Collections.emptyList();
                   }
               }
               return trace;
           }
           @Override
           public int priority() {
               return 200;  // Some unique number
           }
       });
   }
}