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. La distribution Azure Monitor OpenTelemetry :

• Fournit une distribution OpenTelemetry qui inclut la prise en charge des fonctionnalités spécifiques à Azure Monitor.
• Active la télémétrie automatique en incluant les bibliothèques d’instrumentation OpenTelemetry pour collecter des traces, des mesures, des logs 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 Collect OpenTelemetry (OTel) pour les expériences Application Insights ou le FAQ OpenTelemetry.

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.

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 l’API Classique Application Insights, 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 l’API Classique Application Insights, consultez notre documentation de migration.

Java

• Application Java à l’aide de Java 8+

Java native

• Application Java à l’aide de GraalVM 17+

• 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 Distro.

Conseil

Si vous effectuez une migration à partir de l’API Classique Application Insights, consultez notre documentation de migration.

Python

• application Python à l’aide de Python 3.8+

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.4.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 native

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.

Installez le dernier 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.5.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 native

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

// 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

La chaîne de connexion est unique et spécifie où la distribution OpenTelemetry de 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, sélectionnez les options suivantes :

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éfinir via une variable d’environnementrecommandé

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Set via le fichier de configuration - Java uniquement

  Créez un fichier de configuration nommé , puis placez-le dans le même répertoire que , 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.

• Set via 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 l’chaîne de connexion à plusieurs emplacements, la variable d’environnement est hiérarchisée dans l’ordre suivant :

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

Confirmer que les données circulent

Exécutez votre application, puis ouvrez Application Insights dans le portail Azure. L’affichage des données peut prendre quelques minutes.

Capture d’écran de l’onglet Vue d’ensemble d’Application Insights avec les demandes de serveur et le temps de réponse du serveur mis en surbrillance.

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

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.

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 Statsbeat dans Azure Application Insights.

Exemples d’applications

Les exemples d’applications OpenTelemetry Azure Monitor sont disponibles pour toutes les langues supportées.

• ASP.NET Core exemple d’application
• exemple d’application NET
• Java exemples d’applications
• Exemples d’applications natives GraalVM en Java
• Node.js exemple d’application
• Python exemples d’applications

Étapes suivantes

ASP.NET Core

• Pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry, consultez Add et modifiez Azure Monitor OpenTelemetry.
• Pour configurer davantage la distribution OpenTelemetry, consultez Azure Monitor configuration OpenTelemetry.
• Pour consulter le code source, consultez le référentiel Azure Monitor AspNetCore GitHub.
• Pour installer le package NuGet, recherchez les mises à jour ou affichez les notes de publication, consultez la page Azure Monitor Package NuGet AspNetCore.
• Pour vous familiariser avec Azure Monitor et OpenTelemetry, consultez la Azure Monitor Exemple d’application.
• 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.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.

.NET

• Pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry, consultez Add et modifiez Azure Monitor OpenTelemetry.
• Pour configurer davantage la distribution OpenTelemetry, consultez Azure Monitor configuration OpenTelemetry.
• Pour passer en revue le code source, consultez le référentiel Azure Monitor Exporter GitHub.
• Pour installer le package NuGet, rechercher les mises à jour ou afficher les notes de publication, consultez la page Package NuGet d’exportation Azure Monitor.
• Pour vous familiariser avec Azure Monitor et OpenTelemetry, consultez la Azure Monitor Exemple d’application.
• 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.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.

Java

• Consultez Add et modifiez Azure Monitor OpenTelemetry pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry.
• Passez en revue les options de configuration d’autoinstrumentation Java.
• Passez en revue le code source dans le dépôt GitHub Azure Monitor Java autoinstrumentation.
• En savoir plus sur OpenTelemetry et sa communauté dans le dépôt Java GitHub OpenTelemetry.
• Activez les expériences d’utilisation en voyant Activer l’analyse des utilisateurs web ou du navigateur.
• Passez en revue les notes de version sur GitHub.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.

Java native

• Consultez Add et modifiez Azure Monitor OpenTelemetry pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry.
• Passez en revue le code source dans l’application Distribution Azure Monitor OpenTelemetry dans l'application Java d'image native Spring Boot et Quarkus OpenTelemetry Exporter pour Azure.
• En savoir plus sur OpenTelemetry et sa communauté dans le dépôt Java GitHub OpenTelemetry.
• 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.
• Consultez les notes de version sur GitHub.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.

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.

• Pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry, consultez Add et modifiez Azure Monitor OpenTelemetry.
• Pour passer en revue le code source, consultez le référentiel Azure Monitor OpenTelemetry GitHub.
• Pour installer le package npm et rechercher les mises à jour, consultez la page package npm .
• Pour vous familiariser avec Azure Monitor Application Insights et OpenTelemetry, consultez l'Azure Monitor Exemple d’application.
• 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.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.

Python

• Consultez Add et modifiez Azure Monitor OpenTelemetry pour plus d’informations sur l’ajout et la modification de Azure Monitor OpenTelemetry.
• Passez en revue le code source et la documentation supplémentaire du référentiel GitHub de distribution Azure Monitor.
• Consultez des exemples et des cas d’usage supplémentaires dans Exemples de distribution Azure Monitor.
• Passez en revue le changelog sur GitHub.
• Installez le paquet PyPI, recherchez les mises à jour ou affichez les notes de publication sur la page Paquet de distribution PyPI d'Azure Monitor.
• Familiarisez-vous avec Azure Monitor Application Insights et OpenTelemetry dans l’exemple d’application Azure Monitor exemple d’application.
• En savoir plus sur OpenTelemetry et sa communauté dans le référentiel OpenTelemetry Python GitHub.
• Consultez les composants et instrumentations OpenTelemetry disponibles dans le référentiel OpenTelemetry Contributor Python GitHub.
• Activez les expériences d’utilisation en activant la surveillance des utilisateurs web ou de navigateur.
• Pour passer en revue les questions fréquemment posées, les étapes de dépannage, les options de support ou pour fournir des commentaires OpenTelemetry, consultez Aide, support et commentaires pour Azure Monitor Application Insights.