Un servicio puede administrar una variedad de solicitudes, algunas de las cuales puede que no desees que se rastreen o se incluyan en las métricas de traces (trazas). Un ejemplo de esto son, posiblemente, los checks de estado en una aplicación web. Esta documentación cubre dos opciones principales: muestreo y filtrado.

Si necesitas ayuda para decidir cuál opción es la más adecuada para tu caso de uso, ponte en contacto con asistencia técnica de Datadog.

Muestreo

Si deseas que el span (tramo) se incluya en las métricas de traces (trazas) pero no deseas que se ingiera, utiliza reglas de muestreo. Para obtener más información sobre el muestreo, consulta Controles de ingesta.

Utilización de reglas de muestreo

El enfoque de recomendado consiste en utilizar reglas de muestreo, que permiten muestrear traces (trazas) en función de los nombres de los recursos, los nombres de los servicios, las etiquetas (tags) y los nombres de las operaciones:

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

O para realizar un muestreo basado en las etiquetas (tags) de la URL HTTP:

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

Filtrado

Si no deseas que se ingiera el span (tramo) y no deseas que se refleje en las métricas de traces (trazas), utiliza el filtrado.

Existen dos formas de especificar que un punto de conexión de este tipo no debe rastrearse y debe excluirse de las métricas de trazas:

• Configuración del Trace Agent (en el Datadog Agent) o bien
• Configuración del rastreador.

Opciones de configuración del Trace Agent

El componente Trace Agent dentro del Datadog Agent tiene dos métodos para evitar que aparezcan ciertas trazas: ignorar etiquetas (tags) de tramos (spans) o ignorar recursos. Si se descartan trazas debido a esta configuración, las métricas de trazas excluyen estas solicitudes.

La configuración del Trace Agent para ignorar ciertos tramos o recursos se aplica a todos los servicios que envían trazas a este Datadog Agent particular. Si tienes requisitos específicos de la aplicación, utiliza, en su lugar, el método de Configuración del rastreador.

Ignorar en función de las etiquetas de tramos

Empezando con el Datadog Agent 6.27.0/7.27.0, con la opción filtrar por etiquetas, se descartan trazas con tramos de raíz que coincidan con etiquetas de tramos especificadas. Esta opción se aplica a todos los servicios que envían trazas a este Datadog Agent particular. Las trazas que se descartan debido al filtro por etiquetas no se incluyen en las métricas de trazas.

Si puedes identificar mediante programación un conjunto de trazas que sabes que no deseas enviar a Datadog y ninguna otra opción de esta guía resuelve tu necesidad, puedes considerar añadir una etiqueta de tramo personalizada para poder descartar las trazas. Ponte en contacto con el servicio de soporte técnico para tratar tu caso de uso con más detalle, de modo que Datadog pueda seguir ampliando esta funcionalidad.

La opción de filtrar por etiquetas requiere una coincidencia exacta de las cadenas. Si tu caso de uso requiere ignorar por expresiones regulares, consulta Ignorar en función de los recursos.

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

DD_APM_FILTER_TAGS_REQUIRE

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

DD_APM_FILTER_TAGS_REJECT

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

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"]

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

Al filtrar trazas de esta manera, se eliminan estas solicitudes de las métricas de trazas. Para obtener más información sobre cómo reducir el consumo sin afectar las métricas de trazas, consulta Controles de consumo.

En el backend, Datadog crea y añade las siguientes etiquetas (tags) de spans (tramos) a los spans (tramos) después de la ingesta. Ten en cuenta que estas etiquetas (tags) no se pueden utilizar para eliminar traces (trazas) en el nivel del Datadog Agent, ya que el Agent sólo filtra en función de las etiquetas (tags) disponibles antes de la ingesta.

Comunicaciones de red

Solicitudes HTTP

Base de datos

Cola de mensajes

Llamadas a procedimientos remotos

Errores

Ignorar en función de los recursos

La opción ignorar recursos permite excluir recursos si el tramo de raíz global de la traza coincide con determinados criterios. Consulta Excluir recursos de la recopilación. Esta opción se aplica a todos los servicios que envían trazas a este Datadog Agent particular. Las trazas que se descartan porque se ignoran recursos no se incluyen en las métricas de trazas.

Puedes especificar los recursos que deseas ignorar en el archivo de configuración del Agent, datadog.yaml o con la variable de entorno DD_APM_IGNORE_RESOURCES. Consulta los ejemplos siguientes.

Utilización de Datadog.yaml:

apm_config:
## @param ignore_resources - lista de cadenas - opcional
## Se puede proporcionar un lista de expresiones regulares para excluir determinados trazas en función del nombre del recurso.
## Todas las entradas deben ir entre comillas dobles y separadas por comas.

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

Utilización de DD_APM_IGNORE_RESOURCES:

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

Notas:

• Cuando se utiliza el formato de variable de entorno (DD_APM_IGNORE_RESOURCES), los valores deben proporcionarse como una lista de cadenas separadas por comas.
• La sintaxis de las expresiones regulares que acepta el Trace Agent se evalúa con expresiones regulares de Go.
• Según cuál sea tu estrategia de despliegue, puedes tener que ajustar la expresión regular escapando caracteres especiales.
• Si utilizas contenedores dedicados con Kubernetes, asegúrate de que la variable de entorno para la opción de ignorar recursos se esté aplicando al contenedor del Trace-Agent.

Ejemplo

Considera una traza que contiene llamadas a /api/healthcheck desde la cual no deseas trazas:

Toma nota del nombre del recurso del tramo de raíz global.

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

Para utilizar correctamente la opción de ignorar recurso, la regla de la expresión regular escrita debe coincidir con el nombre del recurso, Api::HealthchecksController#index. Existen varias opciones de expresiones regulares posibles, pero para filtrar trazas desde este recurso tal como está, una posible expresión regular que puedes utilizar es Api::HealthchecksController#index$.

Según cuál sea tu forma de despliegue, la sintaxis será un poco diferente:

apm_config:
  ignore_resources: Api::HealthchecksController#index$

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

   environment:
      // otras variables de entorno del Datadog Agent
      - DD_APM_IGNORE_RESOURCES=Api::HealthchecksController#index$$

   environment:
      // otras variables de entorno del Datadog Agent
      - 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 \
              gcr.io/datadoghq/agent:latest

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

    - name: trace-agent
        image: "gcr.io/datadoghq/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 -- Variables de entorno adicionales para el contenedor del trace-agent
      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": [
    // otras variables de entorno para el Datadog Agent
        {
          "name": "DD_APM_IGNORE_RESOURCES",
          "value": "Api::HealthchecksController#index$"
        }
     ]

Opciones de configuración del rastreador

Algunos de los rastreadores específicos del lenguaje tienen una opción para modificar tramos antes de que se envíen al Datadog Agent. Utiliza esta opción si tienes requisitos específicos de la aplicación y utilizas uno de los lenguajes que se enumeran a continuació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 tracer 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 {
       // En un bloque estático de clase para evitar inicializar muchas veces.
       GlobalTracer.get().addTraceInterceptor(new TraceInterceptor() {
           @Override
           public Collection<? extends MutableSpan> onTraceComplete(Collection<? extends MutableSpan> trace) {
               para (MutableSpan span : trace) {
                   si ("GET /healthcheck".contentEquals(span.getResourceName())) {
                       devolver Collections.emptyList();
                   }
               }
               devolver traza;
           }
           @Override
           public int priority() {
               devolver 200;  // Algún número único
           }
       });
   }
}