Prise en charge de l'API OpenTelemetry dans les agents New Relic

Prérequis

Ajoutez les dépendances OpenTelemetry requises à votre application :

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

Activer la prise en charge de l'API OpenTelemetry

1. Activer l'autoconfiguration du SDK OpenTelemetry

Utilisez l'une des méthodes suivantes :

Propriété du système :

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

Variable d'environnement :

$
export OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true

2. Activer la prise en charge de New Relic OpenTelemetry

Propriété du système :

$
-Dnewrelic.config.opentelemetry.enabled=true

Variable d'environnement :

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Configuration YAML (newrelic.yml) :

opentelemetry:
  enabled: true

Types d'instrumentation pris en charge

Instrumentation manuelle

L'instrumentation personnalisée utilisant les API de traces, de métriques ou de logs OpenTelemetry sera automatiquement capturée par l'agent.

Instrumentation native et de bibliothèque

Les instrumentations de bibliothèques autonomes OpenTelemetry et l'instrumentation native intégrée directement dans les bibliothèques fonctionneront avec l'agent New Relic. Cependant, l'auto-instrumentation OpenTelemetry basée sur le bytecode ne sera pas détectée par l'agent New Relic.

Activer la prise en charge de l'API OpenTelemetry

Activez la prise en charge de l'API OpenTelemetry dans votre fichier de configuration newrelic.js :

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

API OpenTelemetry prises en charge

Lorsque la prise en charge d'OpenTelemetry est activée, l'agent Node.js prend entièrement en charge :

API Traces

Créer des spans personnalisés et ajouter des attributs à l'aide de l'API de traçage OpenTelemetry. Consultez l'exemple de traçage OpenTelemetry Node.js.

API métriques

L'API Metrics est la fonctionnalité la plus utile pour les clients Node.js. Cela étend la capacité de collecte de métriques pour inclure les métriques dimensionnelles, une fonctionnalité fréquemment demandée.

Enregistrez des métriques personnalisées à l'aide de l'API OpenTelemetry Metrics. Consultez l'exemple de métriques OpenTelemetry Node.js.

API Logs

L'API OpenTelemetry Logs JavaScript est encore en développement, mais l'agent Node.js la prend en charge. Vous pouvez utiliser l'API pour émettre des logs qui seront envoyés à New Relic.

Consultez l'exemple de logs OpenTelemetry Node.js.

Types d'instrumentation pris en charge

Instrumentation manuelle (recommandée)

Les clients qui instrumentent leurs applications avec l'API OpenTelemetry constateront que l'agent traite et transmet ces données correctement.

Instrumentation native et de bibliothèque (limitée)

La liste des instrumentations OpenTelemetry recoupe largement les modules pris en charge par l'agent Node.js. Les instrumentations qui ne sont pas déjà couvertes par l'agent New Relic peuvent :

• Conflit avec les éléments internes de l'agent
• Ne pas avoir une demande client suffisante

Limitations connues

• Aucune instrumentation automatique: l'agent n'active pas automatiquement les instrumentations OpenTelemetry. Les clients doivent instrumenter manuellement leur code à l'aide des API OpenTelemetry.

Activer la prise en charge de l'API OpenTelemetry

Activez la prise en charge de l'API OpenTelemetry à l'aide des variables d'environnement ou du fichier de configuration XML newrelic.config.

Utilisation des variables d'environnement :

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Utilisation de newrelic.config :

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

Instrumentations natives prises en charge

Lorsque vous activez la prise en charge de l'API OpenTelemetry, l'agent .NET peut capturer la télémétrie provenant des bibliothèques instrumentées par OpenTelemetry.

Instrumentations des traces

L'Agent prend en charge les bibliothèques avec une instrumentation de tracing OpenTelemetry native. L'instrumentation personnalisée écrite à l'aide de l'API de traçage OpenTelemetry est également prise en charge.

Instrumentations des métriques

Lorsque les métriques sont activées, l'agent prend en charge les instrumentations de métriques OpenTelemetry provenant de bibliothèques et de frameworks. L'instrumentation personnalisée écrite à l'aide de l'API OpenTelemetry Metrics est également prise en charge.

Instrumentations des logs

L'agent .NET instrumente déjà la bibliothèque de logging qui est devenue l'API OpenTelemetry pour les données de logs. Aucune modification n'est requise pour les logs lors de l'activation de la prise en charge de l'API OpenTelemetry. Pour assurer la rétrocompatibilité, l'instrumentation des logs continue de fonctionner comme auparavant.

Activer la prise en charge de l'API OpenTelemetry

Activez la prise en charge de l'API OpenTelemetry dans votre fichier de configuration newrelic.ini ou via des variables d'environnement :

Utilisation de newrelic.ini :

[newrelic]
opentelemetry.enabled = true

Utilisation de la variable d'environnement :

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Comment ça marche

Lorsque la prise en charge d'OpenTelemetry est activée et que l'agent détecte que opentelemetry-api est installé :

1. Instrumentation native: Pour les bibliothèques avec une instrumentation OpenTelemetry native intégrée, l'agent désactive automatiquement les hooks de New Relic et utilise l'instrumentation OpenTelemetry native à la place.

2. Instrumentation de bibliothèque: Si une bibliothèque d'instrumentation OpenTelemetry est détectée, l'agent utilise automatiquement l'instrumentation OpenTelemetry au lieu des hooks d'instrumentation de New Relic.

Pour la liste actuelle des instrumentations Python disponibles, consultez la liste officielle des instrumentations Python OpenTelemetry.

Instrumentation manuelle

Toute instrumentation personnalisée écrite à l'aide de l'API de traçage OpenTelemetry sera capturée par l'agent.

Exemple:

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

Fonctionnalités prises en charge

API Traces

✅ Entièrement pris en charge: Créer des spans personnalisés et ajouter des attributs à l'aide de l'API de tracing OpenTelemetry

API métriques

❌ Pas encore pris en charge: l'API OpenTelemetry Metrics n'est pas activée dans l'agent Python

API Logs

✅ Fonctionne déjà: L'agent prend déjà en charge le module de logging. Il n'existe pas d'API OpenTelemetry pour le logging en Python (seul un SDK existe). Ce qu'OpenTelemetry configure pour le logging est si c'est activé et vers quels points de terminaison envoyer les données.

Comment ça marche

Lorsque la prise en charge d'OpenTelemetry est activée :

1. L'Agent recherche dans le système pour déterminer si les bibliothèques d'instrumentation OpenTelemetry sont installées
2. Basculement automatique: si elle est détectée, l'agent utilise l'instrumentation de la bibliothèque OpenTelemetry au lieu des hooks de New Relic
3. Intégration transparente: les spans OpenTelemetry sont intégrés aux traces New Relic

Limitations connues

• Métriques non prises en charge: l'API OpenTelemetry Metrics n'est pas encore activée
• Certaines bibliothèques AWS et gRPC exclues: continueront d'utiliser l'instrumentation New Relic
• Bibliothèques d'IA désactivées: L'instrumentation OpenTelemetry native pour les bibliothèques d'IA est désactivée pour le moment
• Paramètres d'inclusion/exclusion: Des options d'affinement sont prévues pour les futures versions, mais seule l'activation/désactivation est actuellement fonctionnelle.

Activer la prise en charge de l'API OpenTelemetry

Pour activer la prise en charge de l'API OpenTelemetry dans l'agent Ruby, ajoutez ce qui suit à votre fichier de configuration newrelic.yml :

opentelemetry:
  enabled: true

Ou définissez la variable d'environnement :

$
NEW_RELIC_OPENTELEMETRY_ENABLED=true

Instrumentation manuelle

Toute instrumentation personnalisée écrite à l'aide de l'API de traçage OpenTelemetry sera capturée par l'agent.

Exemple:

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

Fonctionnalités prises en charge

API Traces

✅ Pris en charge: Créer des spans personnalisées et ajouter des attributs à l'aide de l'API de traçage OpenTelemetry

API métriques

❌ Non pris en charge: OpenTelemetry Metrics API

API Logs

❌ Non pris en charge: OpenTelemetry Logs API

Liens de span

❌ Non pris en charge: Liens de span

Événements sur les spans

❌ Non pris en charge: Événements sur les Spans

Comment ça marche

Lorsque la prise en charge d'OpenTelemetry est activée, l'agent Ruby New Relic :

1. Écoute les appels vers les API de tracing OpenTelemetry
2. Traduit ces appels en modèles de données New Relic
3. Intègre les spans OpenTelemetry dans les traces New Relic

Limitations connues

• Prise en charge limitée de l'API: seule l'API Traces est prise en charge dans cette version
• Métriques et logs: Non disponible
• Liens de span et événements: Non pris en charge actuellement

Vérifiez la configuration de votre agent pour confirmer que la prise en charge d'OpenTelemetry est activée :

• Vérifier les variables d'environnement ou les fichiers de configuration
• Vérifiez les logs de l'agent pour confirmer que la prise en charge d'OpenTelemetry est active.
• Assurez-vous d'avoir redémarré votre application après avoir modifié la configuration

Confirmez que vous utilisez la version minimale requise de l'agent prenant en charge les API OpenTelemetry. Voir le tableau des langages pris en charge ci-dessus.