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

Article
10/14/2024

Cet article explique comment activer et configurer la collecte de données basée sur OpenTelemetry dans Application Insights. La distribution Azure Monitor OpenTelemetry :

fournit une distribution OpenTelemetry qui inclut la prise en charge de fonctionnalités propres à Azure Monitor ;
permet une télémétrie automatique en incluant les bibliothèques d’instrumentation OpenTelemetry pour collecter les traces, métriques, journaux et exceptions ;
autorise la collecte de données de télémétrie personnalisées ;
prend en charge les métriques temps réel pour surveiller et collecter davantage de données de télémétrie à partir d’applications de production web en direct.

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

Si vous souhaitez en savoir plus sur la collecte de données avec OpenTelemetry, consultez les principes de base de la collecte de données ou les questions fréquentes (FAQ) sur OpenTelemetry.

Statut de publication d’OpenTelemetry

Les offres OpenTelemetry sont disponibles pour les applications .NET, Node.js, Python et Java. Pour connaître l’état de la publication fonctionnalité par fonctionnalité, consultez la FAQ.

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

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

Application ASP.NET Core utilisant une version officiellement prise en charge de .NET

Conseil

Si vous effectuez une migration depuis l’API Classique Application Insights, consultez notre documentation sur la migration.

Installer la bibliothèque de client

Installez le package NuGet Azure.Monitor.OpenTelemetry.AspNetCore le plus récent :

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

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 :

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

Installez le package PyPI azure-monitor-opentelemetry le plus récent :

pip install azure-monitor-opentelemetry

Modifier votre application

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();

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 tutoriel de prise en main d’OpenTelemetry .NET

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

Pointez la machine virtuelle Java (JVM) vers le fichier jar en ajoutant -javaagent:"path/to/applicationinsights-agent-3.6.2.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 de l’échantillonnage, consultez Remplacements d’échantillonnage.

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.

// 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();

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

# Import the tracing api from the `opentelemetry` package.
from opentelemetry import trace

# Configure OpenTelemetry to use Azure Monitor with the 
# APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
configure_azure_monitor()

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 ne disposez pas encore d’une ressource Application Insights, créez-en une en 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 :

Accédez au panneau Vue d’ensemble de votre ressource Application Insights.
Recherchez votre chaîne de connexion.
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 au moyen d’une variable d’environnement - recommandé

Dans la commande suivante, remplacez <Your connection string> par votre chaîne de connexion.
```
APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
```
Définir au moyen d’un fichier config - Java uniquement

Créez un fichier de configuration nommé applicationinsights.json, puis placez-le dans le même répertoire que applicationinsights-agent-3.6.2.jar, avec le contenu suivant :
```
{
  "connectionString": "<Your connection string>"
}
```
Remplacez <Your connection string> dans le code JSON précédent par votre chaîne de connexion unique.
Définir au moyen de code - ASP.NET Core, Node.js et Python uniquement

Pour obtenir un exemple de définition d’une chaîne de connexion au moyen de code, consultez la configuration de la chaîne de connexion.

Remarque

Si vous définissez la chaîne de connexion à plusieurs emplacements, l’ordre de priorité des variables d’environnement est le suivant :

Code
Variable d’environnement
Fichier de configuration

Confirmer le déplacement des données

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 serveur et le temps de réponse du serveur mis en évidence.

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

Important

Si vous avez deux ou plusieurs services émettant de la télémétrie vers la même ressource Application Insights, vous devez définir les noms des rôles cloud pour les représenter correctement sur la cartographie 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 :

Étapes suivantes

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 Configuration d'Azure Monitor OpenTelemetry.
Pour passer en revue le code source, consultez Référentiel GitHub Azure Monitor AspNetCore .
Pour installer le package NuGet, recherchez les mises à jour ou affichez les notes de publication, et consultez la page Package NuGet Azure Monitor AspNetCore.
Pour se familiariser davantage à Azure Monitor et OpenTelemetry grâce à l’exemple d’application Azure Monitor.
Pour en savoir plus sur OpenTelemetry et sa communauté, consultez le référentiel GitHub OpenTelemetry .NET.
Pour activer les expériences d’utilisation, consultez Activer la surveillance des utilisateurs web ou de navigateur.
Pour consulter le forum aux questions, les étapes de résolution des problèmes et les options de support, ou pour fournir des commentaires sur OpenTelemetry, consultez Aide, support et commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

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 Azure Monitor OpenTelemetry.
Pour installer le package npm et vérifier si des mises à jour sont disponibles, consultez la page Package npm @azure/monitor-opentelemetry.
Familiarisez-vous davantage avec Azure Monitor Application Insights et OpenTelemetry grâce à l’exemple d’application Azure Monitor.
Pour en savoir plus sur OpenTelemetry et sa communauté, visitez le référentiel GitHub OpenTelemetry JavaScript.
Pour activer les expériences d’utilisation, consultez Activer la surveillance des utilisateurs web ou de navigateur.
Pour consulter le forum aux questions, les étapes de résolution des problèmes et les options de support, ou pour fournir des commentaires sur OpenTelemetry, consultez Aide, support et commentaires d’OpenTelemetry pour Azure Monitor Application Insights.

Partager via

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

Statut de publication d’OpenTelemetry

Activer OpenTelemetry avec Application Insights

Prérequis

Installer la bibliothèque de client

Modifier votre application

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

Coller la chaîne de connexion dans votre environnement

Confirmer le déplacement des données

Exemples d’applications

Étapes suivantes

Commentaires

Ressources supplémentaires