Soporte de la API de OpenTelemetry en los agentes de New Relic

Requisitos previos

Agrega las dependencias requeridas de OpenTelemetry a tu aplicación:

implementation(platform("io.opentelemetry:opentelemetry-bom:1.44.1"))
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
implementation("io.opentelemetry:opentelemetry-exporter-otlp")

Habilitar el soporte de la API de OpenTelemetry

1. Habilitar la autoconfiguración del SDK de OpenTelemetry

Utilice uno de los siguientes métodos:

Propiedad del sistema:

$
-Dotel.java.global-autoconfigure.enabled=true

Variable ambiental:

$
export OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true

2. Habilitar el soporte de New Relic para OpenTelemetry

Propiedad del sistema:

$
-Dnewrelic.config.opentelemetry.enabled=true

Variable ambiental:

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Configuración de YAML (newrelic.yml):

opentelemetry:
  enabled: true

Tipos de instrumentación admitidos

Instrumentación manual

La instrumentación personalizada que utiliza las API de trazas, métricas o logs de OpenTelemetry será capturada automáticamente por el agente.

Instrumentación de bibliotecas y nativa

Las instrumentaciones de bibliotecas independientes de OpenTelemetry y la instrumentación nativa integrada directamente en las bibliotecas funcionarán con el agente de New Relic. Sin embargo, la autoinstrumentación basada en bytecode de OpenTelemetry no será detectada por el agente de New Relic.

Habilitar el soporte de la API de OpenTelemetry

Habilite el soporte de la API de OpenTelemetry en su archivo de configuración newrelic.js:

exports.config = {
  // ... other config
  opentelemetry: {
    enabled: true,
    traces: {
      enabled: true
    }
  }
  // ... other config
}

APIs de OpenTelemetry compatibles

Cuando el soporte de OpenTelemetry está habilitado, el agente de Node.js admite totalmente:

API de trazas

Cree spans personalizados y agregue atributos mediante la API de Tracing de OpenTelemetry. Consulte el ejemplo de rastreo de OpenTelemetry para Node.js.

APImétrica

La Metrics API es la funcionalidad más útil para los clientes de Node.js. Amplía la capacidad de recolección de métricas para incluir métricas dimensionales, una característica solicitada con frecuencia.

Registre métricas personalizadas mediante la API de métricas de OpenTelemetry. Consulte el ejemplo de métricas de OpenTelemetry para Node.js.

API de Logs

La API de logs de OpenTelemetry para JavaScript aún está en desarrollo, pero el agente de Node.js la admite. Puedes usar la API para emitir logs que se enviarán a New Relic.

Consulte el ejemplo de logs de OpenTelemetry para Node.js.

Tipos de instrumentación admitidos

Instrumentación manual (recomendada)

Los clientes que instrumenten sus aplicaciones con la API de OpenTelemetry verán que el agente procesa y envía esos datos correctamente.

Instrumentación nativa y de biblioteca (limitada)

La lista de instrumentaciones de OpenTelemetry tiene una superposición significativa con los módulos soportados por el agente de Node.js. Las instrumentaciones que aún no están cubiertas por el agente de New Relic pueden:

• Conflicto con los componentes internos del agente
• No tener suficiente demanda de los clientes

Limitaciones conocidas

• Sin instrumentaciones automáticas: El agente no habilita automáticamente las instrumentaciones de OpenTelemetry. Los clientes deben instrumentar manualmente su código utilizando las API de OpenTelemetry.

Habilitar el soporte de la API de OpenTelemetry

Habilite el soporte para la API de OpenTelemetry utilizando variables de entorno o el archivo de configuración XML newrelic.config.

Uso de variables de entorno:

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Uso de newrelic.config:

<configuration>
  <openTelemetry enabled="true" />
</configuration>

Instrumentaciones nativas soportadas

Cuando habilita el soporte para la API de OpenTelemetry, el agente .NET puede capturar telemetría de bibliotecas instrumentadas con OpenTelemetry.

Instrumentaciones de trazas

El agente admite bibliotecas con instrumentación de rastreo nativa de OpenTelemetry. También se admite la instrumentación personalizada escrita utilizando la API de Tracing de OpenTelemetry.

Instrumentaciones de métricas

Cuando las métricas están habilitadas, el agente admite instrumentaciones de métricas de OpenTelemetry de bibliotecas y frameworks. También se admite la instrumentación personalizada escrita con la API de métricas de OpenTelemetry.

Instrumentaciones de logs

El agente .NET ya instrumenta la biblioteca de logging que se convirtió en la API de OpenTelemetry para datos de log. No se requieren cambios en los logs al habilitar el soporte de la API de OpenTelemetry. Para la compatibilidad con versiones anteriores, la instrumentación de logs sigue funcionando como antes.

Habilitar el soporte de la API de OpenTelemetry

Habilite el soporte de la API de OpenTelemetry en su archivo de configuración newrelic.ini o mediante variables de entorno:

Uso de newrelic.ini:

[newrelic]
opentelemetry.enabled = true

Uso de variable de entorno:

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Cómo funciona

Cuando el soporte de OpenTelemetry está habilitado y el agente detecta que opentelemetry-api está instalado:

1. Instrumentación nativa: Para bibliotecas con instrumentación nativa de OpenTelemetry incorporada, el agente deshabilita automáticamente los hooks de New Relic y utiliza la instrumentación nativa de OpenTelemetry en su lugar.

2. Instrumentación de bibliotecas: Si se detecta una biblioteca de instrumentación de OpenTelemetry, el agente utiliza automáticamente la instrumentación de OpenTelemetry en lugar de los hooks de instrumentación de New Relic.

Para consultar la lista actual de instrumentaciones de Python disponibles, consulte la lista oficial de instrumentación de Python de OpenTelemetry.

Instrumentación manual

Cualquier instrumentación personalizada escrita con la API de rastreo de OpenTelemetry será capturada por el agente.

Ejemplo:

from opentelemetry import trace

tracer = trace.get_tracer(__name__)

with tracer.start_as_current_span("my-custom-span") as span:
    span.set_attribute("custom.attribute", "value")
    # Your code here

Característica admitida

API de trazas

✅ Totalmente compatible: Cree spans personalizados y agregue atributos mediante la API de Tracing de OpenTelemetry

APImétrica

❌ Aún no se admite: La API de métricas de OpenTelemetry no está habilitada en el agente de Python

API de Logs

✅ Ya funciona: El agente ya soporta el módulo de logging. No existe una API de OpenTelemetry para logging en Python (solo existe un SDK). Lo que OpenTelemetry configura para el logging es si está habilitado y a qué endpoints enviar los datos.

Cómo funciona

Cuando el soporte de OpenTelemetry está habilitado:

1. El agente busca en el sistema para determinar si las bibliotecas de instrumentación de OpenTelemetry están instaladas
2. Cambio automático: Si se detecta, el agente utiliza la instrumentación de la biblioteca OpenTelemetry en lugar de los hooks de New Relic
3. Integración fluida: Los spans de OpenTelemetry se integran en las trazas de New Relic

Limitaciones conocidas

• Métricas no admitidas: La API de métricas de OpenTelemetry aún no está habilitada
• Algunas bibliotecas de AWS y gRPC excluidas: Se seguirá usando la instrumentación de New Relic
• Bibliotecas de IA deshabilitadas: La instrumentación nativa de OpenTelemetry para bibliotecas de IA está deshabilitada por ahora
• Configuración de inclusión/exclusión: Se planean opciones de ajuste fino para futuras versiones, pero actualmente solo funciona habilitar/deshabilitar

Habilitar el soporte de la API de OpenTelemetry

Para habilitar el soporte de la API de OpenTelemetry en el agente de Ruby, agregue lo siguiente a su archivo de configuración newrelic.yml:

opentelemetry:
  enabled: true

O configure la variable de entorno:

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Instrumentación manual

Cualquier instrumentación personalizada escrita con la API de rastreo de OpenTelemetry será capturada por el agente.

Ejemplo:

require 'opentelemetry'

APP_TRACER = OpenTelemetry.tracer_provider.tracer('my-app', '1.0.0')

APP_TRACER.in_span("my-custom-span") do |span|
  span.set_attribute("test.attribute", "value")
  # Your code here
end

Característica admitida

API de trazas

✅ Soportado: Crear spans personalizados y agregar atributos usando la API de Tracing de OpenTelemetry

APImétrica

❌ No compatible: API de métricas de OpenTelemetry

API de Logs

❌ No admitido: OpenTelemetry Logs API

Vínculos de span

❌ No compatible: Enlaces de Span

Eventos en Spans

❌ No admitido: Eventos en Spans

Cómo funciona

Cuando el soporte de OpenTelemetry está habilitado, el agente Ruby de New Relic:

1. Escucha las llamadas a las API de rastreo de OpenTelemetry
2. Traduce esas llamadas a modelos de datos de New Relic
3. Incorpora spans de OpenTelemetry en las trazas de New Relic

Limitaciones conocidas

• Soporte limitado de API: Solo se admite la API de Traces en esta versión
• Métricas y logs: No disponible
• Enlaces de span y eventos: No compatible actualmente

Verifique la configuración de su agente para confirmar que el soporte de OpenTelemetry esté habilitado:

• Revise las variables de entorno o los archivos de configuración
• Revise los logs del agente para confirmar que el soporte de OpenTelemetry esté activo
• Asegúrese de haber reiniciado su aplicación después de cambiar la configuración

Confirme que está ejecutando la versión mínima requerida del agente que admite las API de OpenTelemetry. Consulte la tabla de lenguajes soportados de arriba.