Activer Azure Monitor OpenTelemetry pour les applications .NET, Node.js, Python et Java

Cet article explique comment activer et configurer la collecte de données basée sur OpenTelemetry dans Azure Monitor Application Insights à l’aide de la distribution OpenTelemetry Azure Monitor. OpenTelemetry est la norme open source d’observabilité de la CNCF ; la distribution Azure Monitor OpenTelemetry est la distribution de Microsoft de cette norme, optimisée pour Azure Monitor. La distribution :

• Fournit une distribution OpenTelemetry qui inclut la prise en charge des fonctionnalités spécifiques à Azure Monitor.
• Active la collecte automatique de données de télémétrie en incluant les bibliothèques d’instrumentation OpenTelemetry pour collecter des traces, des métriques, des journaux et des exceptions.
• Permet de collecter des données de télémétrie personnalisées .
• Prend en charge les métriques en direct pour surveiller et collecter les données de télémétrie à partir d’applications web actives en production.

Pour plus d’informations sur les avantages de l’utilisation de la distribution OpenTelemetry Azure Monitor, consultez Why dois-je utiliser la distribution OpenTelemetry Azure Monitor.

Pour en savoir plus sur la collecte de données à l’aide d’OpenTelemetry, consultez la vue d’ensemble d’Application Insights ou la FAQ OpenTelemetry.

Suivez les étapes décrites dans cet article pour installer la distribution, la connecter à votre ressource Application Insights et vérifier que les données de télémétrie circulent vers Azure Monitor.

Conseil

Pour obtenir une vue d’ensemble conceptuelle des options OpenTelemetry dans Azure Monitor ( ingestion OTLP native, distribution Microsoft d’OpenTelemetry et expériences d’observabilité de bout en bout), consultez OpenTelemetry avec Azure Monitor.

Statut de publication d’OpenTelemetry

Les offres OpenTelemetry sont disponibles pour les applications .NET, Node.js, Python et Java. Pour connaître le statut de chaque fonctionnalité, consultez la FAQ.

Remarque

Pour Azure Function Apps, consultez Use OpenTelemetry avec Azure Functions.

Activer OpenTelemetry avec Application Insights

Suivez les étapes de cette section pour instrumenter votre application avec OpenTelemetry. Sélectionnez un onglet pour obtenir des instructions spécifiques à la langue.

Le tableau suivant récapitule les packages et les commandes d’installation pour chaque langue prise en charge :

Language	Package	Commande d'installation
ASP.NET Core	Azure.Monitor.OpenTelemetry.AspNetCore	dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore
.NET	Azure.Monitor.OpenTelemetry.Exporter	dotnet add package Azure.Monitor.OpenTelemetry.Exporter
Java	applicationinsights-agent-3.7.8.jar	Download à partir de GitHub
Node.js	@azure/monitor-opentelemetry	npm install @azure/monitor-opentelemetry
Python	azure-monitor-opentelemetry	pip install azure-monitor-opentelemetry

Remarque

.NET couvre plusieurs scénarios, notamment les ASP.NET classiques, les applications console, les Windows Forms (WinForms), etc.

Prérequis

• abonnement Azure : Créer un abonnement Azure gratuitement
• Ressource Application Insights : Créer une ressource Application Insights

ASP.NET Core

• application ASP.NET Core à l’aide d’une version officiellement prise en charge de .NET

Conseil

Si vous effectuez une migration à partir de kits SDK Application Insights plus anciens, consultez notre documentation de migration.

.NET

• Application utilisant une version prise en charge de .NET ou .NET Framework 4.6.2 et versions ultérieures.

Conseil

Si vous effectuez une migration à partir de kits SDK Application Insights plus anciens, consultez notre documentation de migration.

Java

• Application Java à l’aide de Java 8+

Java natif

• Application Java à l’aide de GraalVM 17+

Node.js

• Application utilisant une version officiellement prise en charge du runtime Node.js :
  • Runtimes pris en charge par OpenTelemetry
  • Runtimes pris en charge par Azure Monitor OpenTelemetry Exporter

Remarque

Si vous ne comptez pas sur les propriétés répertoriées dans la table non prise en charge, le shim ApplicationInsights est votre chemin d’accès le plus simple une fois hors bêta.

Si vous vous appuyez sur l’une de ces propriétés, passez à Azure Monitor OpenTelemetry Distribution.

Conseil

Si vous effectuez une migration à partir de kits SDK Application Insights plus anciens, consultez notre documentation de migration.

Python

• application Python à l’aide de Python 3.10+

Conseil

Si vous migrez à partir d’OpenCensus, consultez notre documentation de migration.

Installer la bibliothèque de client

ASP.NET Core

Installez le dernier package Azure.Monitor.OpenTelemetry.AspNetCoreNuGet :

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

.NET

Installez le dernier package Azure.Monitor.OpenTelemetry.ExporterNuGet :

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

Java

Téléchargez le dernier fichier applicationinsights-agent-3.7.8.jar.

Avertissement

Si vous effectuez une mise à niveau à partir d’une version 3.x antérieure, vous pouvez être affecté par la modification des valeurs par défaut ou de légères différences dans les données que nous collectons. Pour plus d’informations, consultez la section migration dans les notes de publication. 3.5.0, 3.4.0, 3.3.0, 3.2.0 et 3.1.0

Java natif

Pour les applications natives Spring Boot :

• Importez la nomenclature d’OpenTelemetry.
• Ajoutez la dépendance Spring Cloud Azure Starter Monitor.
• Suivez ces instructions pour les fichiers JAR (Java Archive) Kit de développement logiciel (SDK) Azure.

Pour les applications natives de Quarkus :

• Ajoutez la dépendance Quarkus OpenTelemetry Exporter for Azure.

Remarque

La communauté de Quarkus soutient et gère les extensions de Dockerus. Pour obtenir de l’aide, utilisez les canaux de support de la communauté Quarkus. Microsoft ne fournit pas de support technique pour cette intégration.

Node.js

Installez le dernier @azure/monitor-opentelemetry package :

npm install @azure/monitor-opentelemetry

Les packages suivants sont également utilisés pour certains scénarios spécifiques décrits plus loin dans cet article :

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/ressources
• @opentelemetry/semantic-conventions
• @opentelemetry/sdk-trace-base

npm install @opentelemetry/api
npm install @opentelemetry/sdk-metrics
npm install @opentelemetry/resources
npm install @opentelemetry/semantic-conventions
npm install @opentelemetry/sdk-trace-base

Python

Installez le dernier package PyPI Azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Modifier votre application

ASP.NET Core

Importez l’espace de noms Azure.Monitor.OpenTelemetry.AspNetCore, ajoutez OpenTelemetry et configurez-le pour utiliser Azure Monitor dans votre classe program.cs :

// Import the Azure.Monitor.OpenTelemetry.AspNetCore namespace.
using Azure.Monitor.OpenTelemetry.AspNetCore;

var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry and configure it to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

var app = builder.Build();

app.Run();

.NET

Ajoutez le Azure Monitor Exporter à chaque signal OpenTelemetry dans la classe program.cs :

// Create a new tracer provider builder and add an Azure Monitor trace exporter to the tracer provider builder.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace#tracerprovider-management
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddAzureMonitorTraceExporter();

// Add an Azure Monitor metric exporter to the metrics provider builder.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/metrics#meterprovider-management
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter();

// Create a new logger factory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs#logger-management
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(logging =>
    {
        logging.AddAzureMonitorLogExporter();
    });
});

Remarque

Pour plus d’informations, consultez le didacticiel de démarrage pour OpenTelemetry .NET

Java

L’instrumentation automatique est activée par le biais de modifications de configuration. Aucune modification du code n’est requise.

Pointez le Java machine virtuelle (JVM) vers le fichier jar en ajoutant -javaagent:"path/to/applicationinsights-agent-3.7.8.jar" aux arguments JVM de votre application.

Remarque

L’échantillonnage est activé par défaut à un taux de cinq demandes par seconde, ce qui aide à la gestion des coûts. Les données de télémétrie peuvent être manquantes dans les scénarios dépassant ce taux. Pour plus d’informations sur la modification de la configuration d’échantillonnage, consultez paramètres de substitution pour l’échantillonnage. Si vous voyez des frais inattendus ou des coûts élevés dans Application Insights, ce guide peut vous aider. Il couvre les causes courantes telles que le volume de télémétrie élevé, les pics d’ingestion de données et l’échantillonnage mal configuré. Il est particulièrement utile si vous résolvez des problèmes liés aux pics de coûts, au volume de télémétrie, à l’échantillonnage qui ne fonctionne pas, aux limites de données, à l’ingestion élevée ou à la facturation inattendue. Pour commencer, consultez Résoudre les problèmes d’ingestion de données élevées dans Application Insights.

Conseil

Pour obtenir des conseils spécifiques au scénario, consultez Prise en main (supplément).

Conseil

Si vous développez une application Spring Boot, vous pouvez éventuellement remplacer l’argument JVM par une configuration programmatique. Pour plus d’informations, consultez Utilisation Azure Monitor Application Insights avec Spring Boot.

Java natif

L’instrumentation automatique est activée par le biais de modifications de configuration. Aucune modification du code n’est requise.

Node.js

// Import the `useAzureMonitor()` function from the `@azure/monitor-opentelemetry` package.
const { useAzureMonitor } = require("@azure/monitor-opentelemetry");

// Call the `useAzureMonitor()` function to configure OpenTelemetry to use Azure Monitor.
useAzureMonitor();

Python

import logging
# Import the `configure_azure_monitor()` function from the
# `azure.monitor.opentelemetry` package.
from azure.monitor.opentelemetry import configure_azure_monitor

# Configure OpenTelemetry to use Azure Monitor with the
# APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
configure_azure_monitor(
    logger_name="<your_logger_namespace>",  # Set the namespace for the logger in which you would like to collect telemetry for if you are collecting logging telemetry. This is imperative so you do not collect logging telemetry from the SDK itself.
)
logger = logging.getLogger("<your_logger_namespace>")  # Logging telemetry will be collected from logging calls made with this logger and all of it's children loggers.

Copier le chaîne de connexion à partir de votre ressource Application Insights

Le chaîne de connexion est unique et spécifie où la distribution OpenTelemetry du Azure Monitor envoie les données de télémétrie qu'elle collecte.

Conseil

Si vous n’avez pas encore de ressource Application Insights, créez-en un suivant ce guide. Nous vous recommandons de créer une ressource plutôt que d’utiliser une ressource existante.

Pour copier le chaîne de connexion :

1. Accédez au volet Vue d’ensemble de votre ressource Application Insights.
2. Recherchez votre chaîne de connexion.
3. Pointez sur la chaîne de connexion et sélectionnez l’icône Copier dans le Presse-papiers.

Collez la chaîne de connexion dans votre environnement

Pour coller votre chaîne de connexion, utilisez l’une des méthodes suivantes :

Méthode	Langues prises en charge	Recommandé pour
Variable d’environnement	Tous	Production
Fichier de configuration (applicationinsights.json)	Java uniquement	Production (Java)
Code	ASP.NET Core, Node.js, Python	Développement/test local uniquement

Important

Nous vous recommandons de définir le chaîne de connexion via du code uniquement dans les environnements de développement et de test locaux.

Pour la production, utilisez une variable d’environnement ou un fichier de configuration (Java uniquement).

• Définissez la chaîne de connexion Application Insights comme variable d’environnement (recommandé pour la production)

  Remplacez <Your chaîne de connexion> dans la commande suivante par votre chaîne de connexion.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Set l’chaîne de connexion Application Insights dans un fichier de configuration - Java uniquement

  Créez un fichier de configuration nommé applicationinsights.json, puis placez-le dans le même répertoire que applicationinsights-agent-3.7.8.jar, avec le contenu suivant :

  {
    "connectionString": "<Your connection string>"
  }
  

  Remplacez <Your chaîne de connexion> dans le code JSON précédent par votre chaîne de connexion unique.

• Définissez la chaîne de connexion Application Insights dans le code - ASP.NET Core, Node.js et Python uniquement

  Consultez chaîne de connexion configuration pour obtenir un exemple de définition de chaîne de connexion via du code.

Remarque

Si vous définissez la chaîne de connexion dans plusieurs emplacements, elle est résolue dans l'ordre de priorité suivant (le plus élevé au plus bas) :

1. Code
2. Variable d’environnement
3. Fichier de configuration

Confirmer que les données circulent

Après avoir configuré la distribution OpenTelemetry Azure Monitor et défini la chaîne de connexion, exécutez votre application et ouvrez votre ressource Application Insights dans le portail Azure afin de vérifier que les traces, métriques et journaux apparaissent. L’affichage des données peut prendre quelques minutes.

Application Insights est maintenant activé pour votre application. Les étapes suivantes sont facultatives et permettent une personnalisation supplémentaire.

Remarque

Dans le cadre de l’utilisation de l’instrumentation Application Insights, nous collectons et envoyons des données de diagnostic à Microsoft. Ces données nous permettent d’exécuter et d’améliorer Application Insights. Pour plus d’informations, consultez le FAQ Application Insights.

Important

Si vous avez deux services ou plus qui émettent des données de télémétrie vers la même ressource Application Insights, vous devez définir les noms de rôles cloud pour les représenter correctement sur la carte d’application.

Résolution des problèmes, commentaires et support

Conseil

Les sections suivantes sont disponibles dans tous les articles de distribution OpenTelemetry.

Résolution des problèmes

ASP.NET Core

Pour des informations de dépannage sur les problèmes, consultez Résoudre les problèmes d'OpenTelemetry dans .NET et Résoudre les problèmes de télémétrie manquante dans Azure Monitor Application Insights.

.NET

Pour des informations de dépannage sur les problèmes, consultez Résoudre les problèmes d'OpenTelemetry dans .NET et Résoudre les problèmes de télémétrie manquante dans Azure Monitor Application Insights.

Java

Pour plus d'informations sur la résolution des problèmes, consultez Résoudre les problèmes OpenTelemetry en Java et Résoudre l'absence de télémétrie des applications dans Azure Monitor Application Insights.

Java natif

Pour obtenir des informations sur la résolution des problèmes, consultez Résoudre les problèmes OpenTelemetry dans les applications d'images natives Spring Boot et Résoudre la télémétrie d'application manquante dans Azure Monitor Application Insights.

Node.js

Pour des informations de dépannage, consultez Dépanner les problèmes OpenTelemetry dans Node.js et Dépanner les télémétries manquantes d'application dans Azure Monitor Application Insights.

Python

Pour plus d’informations sur la résolution des problèmes, consultez Résoudre les problèmes d'OpenTelemetry en Python et Résoudre les problèmes de télémétrie d'application manquante dans Azure Monitor Application Insights.

Commentaires sur OpenTelemetry

Pour fournir des commentaires :

• Remplissez l’enquête sur les commentaires des clients de la communauté OpenTelemetry.
• Parlez de vous à Microsoft en vous joignant à la OpenTelemetry Early Adopter Community.
• Collaborez avec d’autres utilisateurs Azure Monitor dans la communauté tech Microsoft.
• Effectuez une demande de fonctionnalité au Azure Forum de commentaires.

Support

Sélectionnez un onglet correspondant à la langue de votre choix pour découvrir les options de support.

ASP.NET Core

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour les problèmes d’OpenTelemetry, contactez la communauté OpenTelemetry .NET communauté directement.
• Pour obtenir la liste des problèmes ouverts liés à Azure Monitor Exporter, consultez la page GitHub Problèmes.

.NET

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour les problèmes d’OpenTelemetry, contactez la communauté OpenTelemetry .NET communauté directement.
• Pour obtenir la liste des problèmes ouverts liés à Azure Monitor Exporter, consultez la page GitHub Problèmes.

Java

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour obtenir de l’aide pour la résolution des problèmes, consultez les étapes de résolution des problèmes.
• Pour les problèmes OpenTelemetry, contactez directement la communauté OpenTelemetry.
• Pour obtenir la liste des problèmes ouverts liés à Azure Monitor Java d'autoinstrumentation, consultez la page GitHub Issues.

Java natif

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour les problèmes OpenTelemetry, contactez directement la communauté OpenTelemetry.
• Pour obtenir la liste des problèmes ouverts liés aux applications natives Spring Boot, consultez la page GitHub Problèmes.
• Pour obtenir la liste des problèmes ouverts liés aux applications natives Quarkus, consultez la page des problèmes GitHub.

Remarque

La communauté de Quarkus soutient et gère les extensions de Dockerus. Pour obtenir de l’aide, utilisez les canaux de support de la communauté Quarkus. Microsoft ne fournit pas de support technique pour cette intégration.

Node.js

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour les problèmes OpenTelemetry, contactez directement la communauté OpenTelemetry JavaScript.
• Pour obtenir la liste des problèmes ouverts liés à Azure Monitor Exporter, consultez la page GitHub Problèmes.

Python

• Pour les problèmes de support Azure, ouvrez un ticket de support Azure.
• Pour les problèmes d’OpenTelemetry, contactez la OpenTelemetry Python communauté directement.
• Pour obtenir la liste des problèmes ouverts liés à Azure Monitor Distribution, consultez la page GitHub Problèmes.

Étapes suivantes

ASP.NET Core

• Pour passer en revue le code source, consultez le référentiel Azure Monitor ASP.NET Core GitHub.
• Pour passer en revue un exemple d’application, consultez Azure Monitor OpenTelemetry pour ASP.NET Core.
• Pour installer le package NuGet, recherchez les mises à jour ou affichez les notes de publication, consultez la page Azure Monitor Package NuGet AspNetCore.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le dépôt OpenTelemetry .NET GitHub.
• Pour activer les expériences d’utilisation, activez la surveillance des utilisateurs du web ou du navigateur.

.NET

• Pour passer en revue le code source, consultez le référentiel Azure Monitor Exporter GitHub.
• Pour passer en revue un exemple d’application, consultez Azure Monitor OpenTelemetry pour .NET.
• Pour installer le package NuGet, rechercher les mises à jour ou afficher les notes de publication, consultez la page Azure Monitor Exporter NuGet Package.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le dépôt OpenTelemetry .NET GitHub.
• Pour activer les expériences d’utilisation, activez la surveillance des utilisateurs du web ou du navigateur.

Java

• Pour passer en revue les options de configuration, consultez options de configuration d'autoinstrumentation Java.
• Pour passer en revue le code source, consultez le dépôt GitHub Azure Monitor Java autoinstrumentation.
• Pour passer en revue les exemples d’applications, consultez Application Insights Java Samples.
• Passez en revue les notes de version sur GitHub.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le référentiel OpenTelemetry Java GitHub.
• Pour permettre les expériences d'utilisation, consultez Activer l'analyse des utilisateurs du Web ou du navigateur.

Java natif

• Pour passer en revue le code source, consultez Azure Monitor OpenTelemetry Distro in Spring Boot native image Java application et Quarkus OpenTelemetry Exporter for Azure.
• Pour consulter un exemple d’application, consultez Télémétrie pour les images natives GraalVM.
• Passez en revue les notes de version sur GitHub.
• En savoir plus sur les fonctionnalités des applications d’image native Spring Boot dans OpenTelemetry SpringBoot starter
• Apprenez-en davantage sur les fonctionnalités des applications natives dans Quarkus OpenTelemetry Exporter pour Azure.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le référentiel OpenTelemetry Java GitHub.

Node.js

• Pour passer en revue le code source, consultez le référentiel Azure Monitor OpenTelemetry pour JavaScript.
• Pour passer en revue un exemple d’application, consultez Azure Monitor OpenTelemetry pour Node.js.
• Pour installer le package npm et vérifier si des mises à jour sont disponibles, consultez la page Package npm @azure/monitor-opentelemetry.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le référentiel OpenTelemetry JavaScript GitHub.
• Pour activer les expériences d’utilisation, activez la surveillance des utilisateurs du web ou du navigateur.

Python

• Pour consulter le code source et la documentation supplémentaire, consultez le référentiel Azure Monitor Python GitHub.
• Pour passer en revue les exemples d’applications, consultez Azure Monitor OpenTelemetry pour Python.
• Pour installer le paquet PyPI et rechercher les mises à jour, consultez la page Paquet de distribution PyPI d'Azure Monitor.
• Passez en revue les notes de version sur GitHub.
• Pour consulter les composants et instrumentations OpenTelemetry disponibles, consultez le référentiel OpenTelemetry Contributor Python GitHub.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le dépôt OpenTelemetry Python GitHub.
• Pour activer les expériences d’utilisation, activez la surveillance des utilisateurs du web ou du navigateur.