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 temps réel pour surveiller et collecter plus de télémétrie à partir d’applications web en production.

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

Pour en savoir plus sur la collecte de données à l’aide d’OpenTelemetry, consultez les concepts de base de la collecte de données ou la 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 Utiliser 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 propres au langage de votre choix.

Remarque

.NET couvre plusieurs scénarios, notamment ASP.NET classique, les applications de console, Windows Forms (WinForms) et bien plus encore.

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 utilisant 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 utilisant Java 8+

Java natif

• Application Java utilisant GraalVM 17+

Node.JS

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

Remarque

Si vous ne dépendez pas des propriétés listées dans le tableau des propriétés non prises en charge, le shim ApplicationInsights constitue la suite la plus simple après la version bêta.

Si vous vous appuyez sur l’une de ces propriétés, passez à la distribution OpenTelemetry d’Azure Monitor. Nous fournirons bientôt un guide de migration.

Conseil

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

Python

• Application Python utilisant 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 Azure.Monitor.OpenTelemetry.AspNetCore le plus récent :

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

Installez le Azure.Monitor.OpenTelemetry.Exporter le plus récent :

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

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

Avertissement

Si vous effectuez une mise à niveau à partir d’une version 3.x antérieure, vous pouvez être impacté par la modification des valeurs par défaut ou par 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) du Kit de développement logiciel (SDK) Azure.

Pour les applications natives de Quarkus :

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

Node.JS

Installez le dernier package @azure/monitor-opentelemetry :

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 l’exportateur Azure Monitor à 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 prise en main 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 la machine virtuelle Java (JVM) vers le fichier jar en ajoutant -javaagent:"path/to/applicationinsights-agent-3.7.1.jar" aux arguments JVM de votre application.

Remarque

L’échantillonnage est activé par défaut avec un débit de 5 demandes par seconde, ce qui facilite la gestion des coûts. Des données de télémétrie peuvent manquer dans les scénarios dépassant ce débit. 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 d’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 la chaîne de connexion à partir de votre ressource Application Insights

La chaîne de connexion est unique et spécifie où la distribution Azure Monitor OpenTelemetry 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 la 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.

Coller la chaîne de connexion dans votre environnement

Pour coller votre chaîne de connexion, sélectionnez l’une des options suivantes :

Important

Nous vous recommandons de définir la chaîne de connexion au moyen de code uniquement dans les environnements de développement et de test locaux.

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

• Définir via une variable - d’environnementrecommandé

  Dans la commande suivante, remplacez <Your connection string> par votre chaîne de connexion.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Défini via le fichier de configuration - Uniquement pour Java

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

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

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

• Définir par le biais du code - ASP.NET Core, Node.jset Python uniquement

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

Remarque

Si vous définissez la chaîne de connexion à plusieurs emplacements, l’ordre de priorité des variables d’environnement est le 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.

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 en savoir plus, consultez Statsbeat dans Azure Application Insights.

Exemples d’applications

Les exemples d’applications Azure Monitor OpenTelemetry sont disponibles pour tous les langages pris en charge :

• exemple d’application ASP.NET Core
• Exemple d’application NET
• Exemples d’applications Java
• Exemples d’applications natifs Java GraalVM
• Node.js exemple d’application
• Exemples d’applications Python

Étapes suivantes

ASP.NET Core

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry.
• Pour configurer davantage la distribution OpenTelemetry, consultez la configuration d’Azure Monitor OpenTelemetry.
• Pour passer en revue le code source, consultez le référentiel GitHub Azure Monitor AspNetCore.
• Pour installer le package NuGet, recherchez les mises à jour ou affichez les notes de publication, consultez la page Package NuGet Azure Monitor AspNetCore .
• Pour vous familiariser avec Azure Monitor et OpenTelemetry, consultez l’exemple d’application Azure Monitor.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le dépôt GitHub OpenTelemetry .NET.
• 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

.NET

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry.
• Pour configurer davantage la distribution OpenTelemetry, consultez la configuration d’Azure Monitor OpenTelemetry.
• Pour passer en revue le code source, consultez le référentiel GitHub de l’exportateur Azure Monitor.
• Pour installer le package NuGet, recherchez les mises à jour ou affichez les notes de publication, consultez la page Package NuGet de l’exportateur Azure Monitor .
• Pour vous familiariser avec Azure Monitor et OpenTelemetry, consultez l’exemple d’application Azure Monitor.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le dépôt GitHub OpenTelemetry .NET.
• 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

Java

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry .
• Passez en revue les options de configuration de l’autoinstrumentation Java.
• Passez en revue le code source dans le dépôt GitHub d’autoinstrumentation Java d’Azure Monitor.
• En savoir plus sur OpenTelemetry et sa communauté dans le dépôt GitHub Java OpenTelemetry.
• Activez les expériences d’utilisation en voyant Activer l’analyse des utilisateurs web ou du navigateur.
• Passez en revue les notes de publication 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

Java natif

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry .
• Passez en revue le code source dans la distribution Azure Monitor OpenTelemetry dans l’application Java d’image native Spring Boot et l’Exportateur Quarkus OpenTelemetry pour Azure.
• En savoir plus sur OpenTelemetry et sa communauté dans le dépôt GitHub Java OpenTelemetry.
• En savoir plus sur les fonctionnalités des applications d’image native Spring Boot dans OpenTelemetry SpringBoot starter
• Découvrez d’autres fonctionnalités des applications natives Quarkus dans l’Exportateur Quarkus OpenTelemetry pour Azure.
• Passez en revue les notes de publication 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

Node.JS

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry.
• Pour passer en revue le code source, consultez le dépôt GitHub d’Azure Monitor OpenTelemetry.
• Pour installer le package npm et rechercher les mises à jour, consultez la @azure/monitor-opentelemetry page package npm .
• Pour vous familiariser avec Azure Monitor Application Insights et OpenTelemetry, consultez l’exemple d’application Azure Monitor.
• Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le référentiel GitHub JavaScript OpenTelemetry.
• 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

Python

• Pour plus d’informations sur l’ajout et la modification d’Azure Monitor OpenTelemetry, consultez Ajouter et modifier Azure Monitor OpenTelemetry .
• Passez en revue le code source et la documentation supplémentaire dans le dépôt GitHub de distribution Azure Monitor.
• Consultez des exemples et des cas d’usage supplémentaires dans les exemples de distribution Azure Monitor.
• Passez en revue le journal des modifications sur GitHub.
• Installez le package PyPI, recherchez les mises à jour ou affichez les notes de publication dans la page Package PyPI de distribution Azure Monitor .
• Familiarisez-vous avec Azure Monitor Application Insights et OpenTelemetry dans l’exemple d’application Azure Monitor.
• En savoir plus sur OpenTelemetry et sa communauté dans le dépôt GitHub Python OpenTelemetry.
• Consultez les instrumentations et composants OpenTelemetry disponibles dans le dépôt GitHub du contributeur OpenTelemetry.
• 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 l’aide, le support et les commentaires d’OpenTelemetry pour Azure Monitor Application Insights.