Instrumentación personalizada de Node.js con la API de OpenTelemetry

Documentos > APM > Instrumentación de aplicación > Instrumentación personalizada > > Instrumentación personalizada de Node.js con la API de OpenTelemetry

Unsure when to use OpenTelemetry with Datadog? Start with Custom Instrumentation with the OpenTelemetry API to learn more.

Overview

There are a few reasons to manually instrument your applications with the OpenTelemetry API:

You are not using Datadog supported library instrumentation.
You want to extend the ddtrace library’s functionality.
You need finer control over instrumenting your applications.

The ddtrace library provides several techniques to help you achieve these goals. The following sections demonstrate how to use the OpenTelemetry API for custom instrumentation to use with Datadog.

Configuración

Para configurar OpenTelemetry para utilizar el proveedor de traza de Datadog:

Añade la instrumentación manual de OpenTelemetry deseada a tu código Node.js siguiendo la documentación de la Instrumentación manual de OpenTelemetry Node.js. Nota: Cuando esas instrucciones indiquen que tu código debe llamar al SDK de OpenTelemetry, llama a la biblioteca de rastreo de Datadog en su lugar.
Añadir el módulo dd-trace a tu paquete .json:
```
npm install dd-trace
```

Inicializar el módulo dd-trace en tu aplicación:

const tracer = require('dd-trace').init({
  // ...
})

Visitar TracerProvider en tracer:
```
const { TracerProvider } = tracer
```

Crear y registrar un TracerProvider:

const provider = new TracerProvider()
provider.register()

Importar la API de OpenTelemetry y crear una instancia de rastreador OpenTelemetry:

const ot = require('@opentelemetry/api')
const otelTracer = ot.trace.getTracer(
  'my-service'
)

Ejecuta tu aplicación.

Datadog combina estos tramos de OpenTelemetry con otros tramos de Datadog APM en una traza única de tu aplicación. También es compatible con la instrumentación de la integración y la instrumentación automática de OpenTelemetry.

Añadir etiquetas al tramo

Añade atributos personalizados a tus tramos para proporcionar un contexto adicional:

function processData(i, param1, param2) {
  return tracer.startActiveSpan(`processData:${i}`, (span) => {
    const result = someOperation(param1, param2);

    // Añade un atributo al tramo
    span.setAttribute('app.processedData', result.toString());

    span.end();
    return result;
    });
}

Creación de tramos

Para crear un nuevo tramo y cerrarlo correctamente, utiliza el método startActiveSpan:

function performTask(iterations, param1, param2) {
  // Crea un tramo. Se debe cerrar un tramo.
  return tracer.startActiveSpan('performTask', (span) => {
    const results = [];
    for (let i = 0; i < iterations; i++) {
      results.push(processData(i, param1, param2));
    }
    // Asegúrate de terminar el tramo.
    span.end();
    return results;
  });
}

Filtrado de solicitudes

En algunos casos, puede que desees excluir instrumentar ciertas solicitudes, como el tráfico de check de estado o tráfico Synthetic. Puedes utilizar las opciones blocklist o allowlist del complemento http para ignorar estas solicitudes.

Para excluir solicitudes a nivel de aplicación, añade lo siguiente después de inicializar el rastreador:

// en la parte superior del punto de entrada derecho después de tracer.init()
tracer.use('http', {
  blocklist: ['/health', '/ping']
})

También puedes dividir la configuración entre el cliente y el servidor si es necesario:

tracer.use('http', {
  server: {
    blocklist: ['/ping']
  }
})

Además, puedes excluir trazas basándote en su nombre de recurso para evitar que el Agent las envíe a Datadog. Para obtener más información sobre la seguridad y el ajuste de las configuraciones del Agent, consulta las secciones Seguridad o Ignorar recursos no deseados.