Aktivera Azure Monitor OpenTelemetry för .NET-, Node.js-, Python- och Java-program

Den här artikeln beskriver hur du aktiverar och konfigurerar OpenTelemetry-baserad datainsamling i Application Insights. The Azure Monitor OpenTelemetry Distro:

• Tillhandahåller en OpenTelemetry-distribution som innehåller stöd för funktioner som är specifika för Azure Monitor.
• Aktiverar automatisk telemetri genom att inkludera OpenTelemetry-instrumentationsbibliotek för insamling av spårningar, mått, loggar och undantag.
• Tillåter insamling av anpassad telemetri.
• Stöder livemått för att övervaka och samla in mer telemetri från webbprogram i produktion.

Mer information om fördelarna med att använda Azure Monitor OpenTelemetry Distro finns i Varför ska jag använda Azure Monitor OpenTelemetry Distro?

Mer information om hur du samlar in data med OpenTelemetry finns i Grunderna för datainsamling eller Vanliga frågor och svar om OpenTelemetry.

OpenTelemetry-versionsstatus

OpenTelemetry-erbjudanden är tillgängliga för .NET-, Node.js-, Python- och Java-program. En funktionsspecifik versionsstatus finns i Vanliga frågor och svar.

Aktivera OpenTelemetry med Application Insights

Följ stegen i det här avsnittet för att instrumentera ditt program med OpenTelemetry. Välj en flik för langaugespecifika instruktioner.

Kommentar

.NET omfattar flera scenarier, inklusive klassiska ASP.NET, konsolappar, Windows Forms (WinForms) med mera.

Förutsättningar

• Azure-prenumeration: Skapa en Azure-prenumeration kostnadsfritt
• Application Insights-resurs: Skapa en Application Insights-resurs

ASP.NET Core

• ASP.NET Core Application med en officiellt stödd version av .NET

Dricks

Om du migrerar från det klassiska API:et för Application Insights kan du läsa vår migreringsdokumentation.

.NET

• Program som använder en version av .NET eller .NET Framework 4.6.2 som stöds och senare.

Dricks

Om du migrerar från det klassiska API:et för Application Insights kan du läsa vår migreringsdokumentation.

Java

• Ett Java-program med Java 8+

Java-inbyggt

• Ett Java-program med GraalVM 17+

Node.js

• Program som använder en version av Node.js runtime som stöds officiellt:
  • Runtimes som stöds av OpenTelemetry
  • Azure Monitor OpenTelemetry Exporter stöds runtimes

Kommentar

Om du inte förlitar dig på några egenskaper som anges i tabellen som inte stöds är ApplicationInsights shim den enklaste vägen framåt en gång från betaversionen.

Om du förlitar dig på dessa egenskaper fortsätter du med Azure Monitor OpenTelemetry Distro. Vi kommer snart att tillhandahålla en migreringsguide.

Dricks

Om du migrerar från det klassiska API:et för Application Insights kan du läsa vår migreringsdokumentation.

Python

• Python-program med Python 3.8+

Dricks

Om du migrerar från OpenCensus kan du läsa vår migreringsdokumentation.

Installera klientbiblioteket

ASP.NET Core

Installera det senaste Azure.Monitor.OpenTelemetry.AspNetCore NuGet-paketet:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

Installera det senaste Azure.Monitor.OpenTelemetry.Exporter NuGet-paketet:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

Ladda ned filen applicationinsights-agent-3.6.0.jar .

Varning

Om du uppgraderar från en tidigare 3.x-version kan du påverkas genom att ändra standardvärden eller små skillnader i de data vi samlar in. Mer information finns i avsnittet migrering i viktig information. 3.5.0, 3.4.0, 3.3.0, 3.2.0 och 3.1.0

Java-inbyggt

För inbyggda Spring Boot-program :

• Importera OpenTelemetry Bills of Materials (BOM).
• Lägg till Spring Cloud Azure Starter Monitor-beroendet.
• Följ de här anvisningarna för Azure SDK JAR-filer (Java Archive).

För quarkus-inbyggda program:

• Lägg till Quarkus OpenTelemetry Exporter för Azure-beroende.

Node.js

Installera det senaste paketet @azure/monitor-opentelemetry :

npm install @azure/monitor-opentelemetry

Följande paket används också för vissa specifika scenarier som beskrivs senare i den här artikeln:

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/resurser
• @opentelemetry/semantiska konventioner
• @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

Installera det senaste PyPI-paketet azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Ändra ditt program

ASP.NET Core

Azure.Monitor.OpenTelemetry.AspNetCore Importera namnområdet, lägg till OpenTelemetry och konfigurera det så att det använder Azure Monitor i din program.cs klass:

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

Lägg till Azure Monitor Exporter till varje OpenTelemetry-signal i program.cs klassen:

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

Kommentar

Mer information finns i självstudien komma igång för OpenTelemetry .NET

Java

Automatisk instrumentering aktiveras genom konfigurationsändringar. Inga kodändringar krävs.

Peka den virtuella Java-datorn (JVM) till jar-filen genom att lägga -javaagent:"path/to/applicationinsights-agent-3.6.0.jar" till I programmets JVM-args.

Kommentar

Sampling aktiveras som standard med en frekvens på 5 begäranden per sekund, vilket underlättar kostnadshanteringen. Telemetridata kan saknas i scenarier som överskrider den här takten. Mer information om hur du ändrar samplingskonfigurationen finns i samplings åsidosättningar.

Dricks

För scenariospecifik vägledning, se Kom igång (kompletterande).

Dricks

Om du utvecklar ett Spring Boot-program kan du ersätta JVM-argumentet med en programmatisk konfiguration. Mer information finns i Använda Azure Monitor Application Insights med Spring Boot.

Java-inbyggt

Automatisk instrumentering aktiveras genom konfigurationsändringar. Inga kodändringar krävs.

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

Kopiera anslutningssträng från Application Insights-resursen

Anslutningssträng är unik och anger var Azure Monitor OpenTelemetry Distro skickar telemetrin som samlas in.

Dricks

Om du inte redan har en Application Insights-resurs skapar du en som följer den här guiden. Vi rekommenderar att du skapar en ny resurs i stället för att använda en befintlig resurs.

Kopiera anslutningssträng:

1. Gå till fönstret Översikt för din Application Insights-resurs.
2. Hitta din anslutningssträng.
3. Hovra över anslutningssträng och välj ikonen Kopiera till Urklipp.

Klistra in anslutningssträng i din miljö

Om du vill klistra in anslutningssträng väljer du bland följande alternativ:

Viktigt!

Vi rekommenderar att du ställer in anslutningssträng endast via kod i lokala utvecklings- och testmiljöer.

För produktion använder du en miljövariabel eller konfigurationsfil (endast Java).

• Ange via miljövariabel rekommenderas -

  Ersätt <Your connection string> i följande kommando med din anslutningssträng.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Ange endast via konfigurationsfilen - Java

  Skapa en konfigurationsfil med namnet applicationinsights.jsonoch placera den i samma katalog som applicationinsights-agent-3.6.0.jar med följande innehåll:

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

  Ersätt <Your connection string> i föregående JSON med din unika anslutningssträng.

• Ange endast via kod - ASP.NET Core, Node.js och Python

  Se anslutningssträng konfiguration för ett exempel på hur du ställer in anslutningssträng via kod.

Kommentar

Om du anger anslutningssträng på flera platser prioriteras miljövariabeln i följande ordning:

1. Kod
2. Miljövariabel
3. Konfigurationsfil

Bekräfta att data flödar

Kör programmet och öppna sedan Application Insights i Azure Portal. Det kan ta några minuter innan data visas.

Application Insights är nu aktiverat för ditt program. Följande steg är valfria och tillåter ytterligare anpassning.

Viktigt!

Om du har två eller flera tjänster som genererar telemetri till samma Application Insights-resurs måste du ange molnrollnamn för att representera dem korrekt på programkartan.

Som en del av användningen av Application Insights-instrumentation samlar vi in och skickar diagnostikdata till Microsoft. Dessa data hjälper oss att köra och förbättra Application Insights. Mer information finns i Statsbeat i Azure Application Insights.

Exempelprogram

Azure Monitor OpenTelemetry-exempelprogram är tillgängliga för alla språk som stöds:

• ASP.NET Core-exempelapp
• NET-exempelapp
• Java-exempelappar
• Inbyggda Java GraalVM-exempelappar
• Node.js exempelapp
• Python-exempelappar

Nästa steg

ASP.NET Core

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Mer information om hur du konfigurerar OpenTelemetry-distributionen finns i Konfiguration av Azure Monitor OpenTelemetry.
• Information om hur du granskar källkoden finns i Azure Monitor AspNetCore GitHub-lagringsplatsen.
• Om du vill installera NuGet-paketet söker du efter uppdateringar eller visar viktig information på sidan Azure Monitor AspNetCore NuGet-paket .
• Mer information om Azure Monitor och OpenTelemetry finns i Exempelprogrammet för Azure Monitor.
• Mer information om OpenTelemetry och dess community finns i GitHub-lagringsplatsen OpenTelemetry .NET.
• Aktivera webb- eller webbläsaranvändarövervakning för att aktivera användningsupplevelser.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.

.NET

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Mer information om hur du konfigurerar OpenTelemetry-distributionen finns i Konfiguration av Azure Monitor OpenTelemetry.
• Information om hur du granskar källkoden finns i GitHub-lagringsplatsen för Azure Monitor Exporter.
• Om du vill installera NuGet-paketet söker du efter uppdateringar eller visar viktig information på sidan NuGet-paket för Azure Monitor Exporter.
• Mer information om Azure Monitor och OpenTelemetry finns i Exempelprogrammet för Azure Monitor.
• Mer information om OpenTelemetry och dess community finns i GitHub-lagringsplatsen OpenTelemetry .NET.
• Aktivera webb- eller webbläsaranvändarövervakning för att aktivera användningsupplevelser.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.

Java

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Granska konfigurationsalternativen för Java-autoinstrumentering.
• Granska källkoden på GitHub-lagringsplatsen för Azure Monitor Java Autoinstrumentation.
• Läs mer om OpenTelemetry och dess community på GitHub-lagringsplatsen OpenTelemetry Java.
• Aktivera användningsupplevelser genom att se Aktivera webb- eller webbläsaranvändarövervakning.
• Läs viktig information på GitHub.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.

Java-inbyggt

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Granska källkoden i Azure Monitor OpenTelemetry Distro i Den inbyggda Spring Boot-avbildningens Java-program och Quarkus OpenTelemetry Exporter för Azure.
• Läs mer om OpenTelemetry och dess community på GitHub-lagringsplatsen OpenTelemetry Java.
• Läs mer om funktioner för spring boot-inbyggda avbildningsprogram i OpenTelemetry SpringBoot starter
• Läs mer om funktioner för quarkus-inbyggda program i Quarkus OpenTelemetry Exporter för Azure.
• Läs viktig information på GitHub.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.

Node.js

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Information om hur du granskar källkoden finns i Azure Monitor OpenTelemetry GitHub-lagringsplatsen.
• Information om hur du installerar npm-paketet och söker efter uppdateringar finns på @azure/monitor-opentelemetry sidan npm-paket .
• Mer information om Azure Monitor Application Insights och OpenTelemetry finns i Exempelprogrammet för Azure Monitor.
• Mer information om OpenTelemetry och dess community finns i GitHub-lagringsplatsen OpenTelemetry JavaScript.
• Aktivera webb- eller webbläsaranvändarövervakning för att aktivera användningsupplevelser.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.

Python

• Mer information om hur du lägger till och ändrar Azure Monitor OpenTelemetry finns i Lägga till och ändra Azure Monitor OpenTelemetry.
• Granska källkoden och den extra dokumentationen på Azure Monitor Distro GitHub-lagringsplatsen.
• Se extra exempel och användningsfall i Azure Monitor Distro-exempel.
• Granska ändringsloggen på GitHub.
• Installera PyPI-paketet, sök efter uppdateringar eller visa viktig information på sidan Azure Monitor Distro PyPI-paket .
• Bekanta dig med Azure Monitor Application Insights och OpenTelemetry i Azure Monitor-exempelprogrammet.
• Läs mer om OpenTelemetry och dess community på GitHub-lagringsplatsen OpenTelemetry Python.
• Se tillgängliga OpenTelemetry-instrumentationer och komponenter i OpenTelemetry-deltagaren Python GitHub-lagringsplats.
• Aktivera användningsupplevelser genom att aktivera webb- eller webbläsaranvändarövervakning.
• Om du vill granska vanliga frågor, felsökningssteg, supportalternativ eller för att ge Feedback om OpenTelemetry kan du läsa OpenTelemetry-hjälp, support och feedback för Azure Monitor Application Insights.