Włączanie usługi Azure Monitor OpenTelemetry dla aplikacji .NET, Node.js, Python i Java

W tym artykule opisano sposób włączania i konfigurowania zbierania danych opartych na protokole OpenTelemetry w usłudze Application Insights. Dystrybucja opentelemetrii usługi Azure Monitor:

• Udostępnia dystrybucję OpenTelemetry, która obejmuje obsługę funkcji specyficznych dla usługi Azure Monitor.
• Włącza automatyczne dane telemetryczne, włączając biblioteki instrumentacji OpenTelemetry do zbierania śladów, metryk, dzienników i wyjątków.
• Umożliwia zbieranie niestandardowych danych telemetrycznych .
• Obsługuje metryki na żywo do monitorowania i zbierania większej ilości danych telemetrycznych z aplikacji internetowych w środowisku produkcyjnym.

Aby uzyskać więcej informacji na temat zalet korzystania z dystrybucji OpenTelemetry usługi Azure Monitor, zobacz Dlaczego należy używać dystrybucji OpenTelemetry usługi Azure Monitor.

Aby dowiedzieć się więcej na temat zbierania danych przy użyciu biblioteki OpenTelemetry, zapoznaj się z tematem Data Collection Basics (Podstawy zbierania danych) lub OpenTelemetry FAQ (Często zadawane pytania dotyczące zbierania danych).

Stan wydania openTelemetry

Oferty OpenTelemetry są dostępne dla aplikacji .NET, Node.js, Python i Java. Aby uzyskać stan wersji funkcji po funkcji, zobacz często zadawane pytania.

Włączanie funkcji OpenTelemetry za pomocą usługi Application Insights

Wykonaj kroki opisane w tej sekcji, aby instrumentować aplikację przy użyciu funkcji OpenTelemetry. Wybierz kartę dla instrukcji specyficznych dla języka.

Uwaga

Platforma .NET obejmuje wiele scenariuszy, w tym klasycznych ASP.NET, aplikacji konsolowych, formularzy systemu Windows (WinForms) i innych.

Wymagania wstępne

• Subskrypcja platformy Azure: tworzenie bezpłatnej subskrypcji platformy Azure
• Zasób usługi Application Insights: tworzenie zasobu usługi Application Insights

ASP.NET Core

• ASP.NET Core Application przy użyciu oficjalnie obsługiwanej wersji platformy .NET

Napiwek

Jeśli przeprowadzasz migrację z klasycznego interfejsu API usługi Application Insights, zapoznaj się z naszą dokumentacją migracji.

.NET

• Aplikacja korzystająca z obsługiwanej wersji platformy .NET lub .NET Framework 4.6.2 lub nowszej.

Napiwek

Jeśli przeprowadzasz migrację z klasycznego interfejsu API usługi Application Insights, zapoznaj się z naszą dokumentacją migracji.

Java

• Aplikacja Java korzystająca z języka Java 8 lub nowszego

Natywna dla języka Java

• Aplikacja Java korzystająca z maszyny GraalVM 17+

Node.js

• Aplikacja korzystająca z oficjalnie obsługiwanej wersji środowiska uruchomieniowego Node.js:
  • Obsługiwane środowiska uruchomieniowe OpenTelemetry
  • Obsługiwane środowiska uruchomieniowe eksportera OpenTelemetry w usłudze Azure Monitor

Uwaga

Jeśli nie korzystasz z żadnych właściwości wymienionych w tabeli nieobsługiwanej, podkładka ApplicationInsights będzie najprostszą ścieżką do przodu po zakończeniu wersji beta.

Jeśli korzystasz z dowolnych tych właściwości, przejdź do dystrybucji OpenTelemetry usługi Azure Monitor. Wkrótce udostępnimy przewodnik migracji.

Napiwek

Jeśli przeprowadzasz migrację z klasycznego interfejsu API usługi Application Insights, zapoznaj się z naszą dokumentacją migracji.

Python

• Aplikacja języka Python korzystająca z języka Python w wersji 3.8 lub nowszej

Napiwek

Jeśli przeprowadzasz migrację z usługi OpenCensus, zapoznaj się z naszą dokumentacją migracji.

Instalowanie biblioteki klienta

ASP.NET Core

Zainstaluj najnowszy Azure.Monitor.OpenTelemetry.AspNetCore pakiet NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

Zainstaluj najnowszy Azure.Monitor.OpenTelemetry.Exporter pakiet NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

Pobierz najnowszy plik applicationinsights-agent-3.6.2.jar .

Ostrzeżenie

W przypadku uaktualniania z wcześniejszej wersji 3.x może to mieć wpływ na zmianę wartości domyślnych lub niewielkie różnice w zbieranych danych. Aby uzyskać więcej informacji, zobacz sekcję migracji w informacjach o wersji. 3.5.0, 3.4.0, 3.3.0, 3.2.0 i 3.1.0

Natywna dla języka Java

W przypadku aplikacji natywnych platformy Spring Boot :

• Zaimportuj rachunki za materiały OpenTelemetry (BOM).
• Dodaj zależność usługi Spring Cloud Azure Starter Monitor.
• Postępuj zgodnie z tymi instrukcjami dla plików JAR (Java Archive) zestawu Azure SDK.

W przypadku aplikacji natywnych quarkus :

• Dodaj eksportera Quarkus OpenTelemetry dla zależności platformy Azure.

Node.js

Zainstaluj najnowszy pakiet @azure/monitor-opentelemetry :

npm install @azure/monitor-opentelemetry

Następujące pakiety są również używane w niektórych konkretnych scenariuszach opisanych w dalszej części tego artykułu:

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/zasoby
• @opentelemetry/konwencje semantyczne
• @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

Zainstaluj najnowszy pakiet PyPI azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Modyfikowanie aplikacji

ASP.NET Core

Zaimportuj przestrzeń nazw, dodaj bibliotekę Azure.Monitor.OpenTelemetry.AspNetCore OpenTelemetry i skonfiguruj ją tak, aby korzystała z usługi Azure Monitor w program.cs klasie:

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

Dodaj eksportera usługi Azure Monitor do każdego sygnału program.cs OpenTelemetry w klasie:

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

Uwaga

Aby uzyskać więcej informacji, zobacz samouczek wprowadzający dla platformy .NET OpenTelemetry.

Java

Automatycznainstrumentacja jest włączona za pośrednictwem zmian konfiguracji. Nie są wymagane żadne zmiany kodu.

Wskaż maszynę wirtualną Java (JVM) do pliku jar, dodając -javaagent:"path/to/applicationinsights-agent-3.6.2.jar" do args maszyny wirtualnej JVM aplikacji.

Uwaga

Próbkowanie jest domyślnie włączone w tempie 5 żądań na sekundę, co ułatwia zarządzanie kosztami. W scenariuszach przekraczających tę częstotliwość mogą brakować danych telemetrycznych. Aby uzyskać więcej informacji na temat modyfikowania konfiguracji próbkowania, zobacz przesłonięcia próbkowania.

Napiwek

Aby uzyskać wskazówki specyficzne dla scenariusza, zobacz Wprowadzenie (uzupełnienie).

Napiwek

Jeśli tworzysz aplikację Spring Boot, opcjonalnie możesz zastąpić argument JVM konfiguracją programową. Aby uzyskać więcej informacji, zobacz Using Azure Monitor Application Insights with Spring Boot (Korzystanie z usługi Azure Monitor Application Insights z platformą Spring Boot).

Natywna dla języka Java

Automatycznainstrumentacja jest włączona za pośrednictwem zmian konfiguracji. Nie są wymagane żadne zmiany kodu.

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

Kopiowanie parametry połączenia z zasobu usługi Application Insights

Parametry połączenia jest unikatowa i określa, gdzie usługa Azure Monitor OpenTelemetry Distro wysyła zebrane dane telemetryczne.

Napiwek

Jeśli nie masz jeszcze zasobu usługi Application Insights, utwórz go w tym przewodniku. Zalecamy utworzenie nowego zasobu zamiast używania istniejącego zasobu.

Aby skopiować parametry połączenia:

1. Przejdź do okienka Przegląd zasobu usługi Application Insights.
2. Znajdź parametry połączenia.
3. Umieść kursor na parametry połączenia i wybierz ikonę Kopiuj do schowka.

Wklej parametry połączenia w środowisku

Aby wkleić parametry połączenia, wybierz spośród następujących opcji:

Ważne

Zalecamy ustawienie parametry połączenia za pomocą kodu tylko w lokalnych środowiskach deweloperskich i testowych.

W przypadku środowiska produkcyjnego użyj zmiennej środowiskowej lub pliku konfiguracji (tylko język Java).

• Ustawianie za pomocą zalecanej zmiennej środowiskowej -

  Zastąp <Your connection string> ciąg w poniższym poleceniu swoim parametry połączenia.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Ustawianie tylko za pomocą pliku - konfiguracji w języku Java

  Utwórz plik konfiguracji o nazwie applicationinsights.jsoni umieść go w tym samym katalogu, co applicationinsights-agent-3.6.2.jar w przypadku następującej zawartości:

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

  Zastąp <Your connection string> element w poprzednim formacie JSON unikatowym parametry połączenia.

• Ustaw tylko za pomocą kodu - ASP.NET Core, Node.js i Python

  Zobacz parametry połączenia konfiguracji, aby zapoznać się z przykładem ustawienia parametry połączenia za pomocą kodu.

Uwaga

Jeśli ustawisz parametry połączenia w wielu miejscach, zmienna środowiskowa będzie określana priorytetowo w następującej kolejności:

1. Kod
2. Zmienna środowiskowa
3. Plik konfiguracji

Potwierdzanie, że dane przepływają

Uruchom aplikację, a następnie otwórz usługę Application Insights w witrynie Azure Portal. Wyświetlenie danych może potrwać kilka minut.

Usługa Application Insights jest teraz włączona dla aplikacji. Poniższe kroki są opcjonalne i umożliwiają dalsze dostosowywanie.

Ważne

Jeśli masz co najmniej dwie usługi, które emitują dane telemetryczne do tego samego zasobu usługi Application Insights, musisz ustawić nazwy ról w chmurze, aby reprezentować je prawidłowo na mapie aplikacji.

W ramach instrumentacji usługi Application Insights zbieramy i wysyłamy dane diagnostyczne do firmy Microsoft. Te dane pomagają nam uruchamiać i ulepszać usługę Application Insights. Aby dowiedzieć się więcej, zobacz Statsbeat in aplikacja systemu Azure Insights (Statystyki w usłudze aplikacja systemu Azure Insights).

Przykładowe aplikacje

Przykładowe aplikacje OpenTelemetry w usłudze Azure Monitor są dostępne dla wszystkich obsługiwanych języków:

• przykładowa aplikacja ASP.NET Core
• Przykładowa aplikacja platformy NET
• Przykładowe aplikacje w języku Java
• Przykładowe aplikacje java GraalVM
• przykładowa aplikacja Node.js
• Przykładowe aplikacje języka Python

Następne kroki

ASP.NET Core

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie funkcji OpenTelemetry usługi Azure Monitor.
• Aby jeszcze bardziej skonfigurować dystrybucję OpenTelemetry, zobacz Azure Monitor OpenTelemetry configuration (Konfiguracja biblioteki OpenTelemetry w usłudze Azure Monitor).
• Aby przejrzeć kod źródłowy, zobacz repozytorium GitHub aspnetcore usługi Azure Monitor.
• Aby zainstalować pakiet NuGet, sprawdź dostępność aktualizacji lub wyświetl informacje o wersji, zobacz stronę Pakiet NuGet platformy AspNetCore usługi Azure Monitor.
• Aby zapoznać się z usługami Azure Monitor i OpenTelemetry, zobacz Przykładowa aplikacja usługi Azure Monitor.
• Aby dowiedzieć się więcej na temat biblioteki OpenTelemetry i jej społeczności, zobacz repozytorium GitHub OpenTelemetry .NET.
• Aby włączyć środowiska użycia, włącz monitorowanie użytkowników sieci Web lub przeglądarki.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.

.NET

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie funkcji OpenTelemetry usługi Azure Monitor.
• Aby jeszcze bardziej skonfigurować dystrybucję OpenTelemetry, zobacz Azure Monitor OpenTelemetry configuration (Konfiguracja biblioteki OpenTelemetry w usłudze Azure Monitor).
• Aby przejrzeć kod źródłowy, zobacz repozytorium GitHub eksportera usługi Azure Monitor.
• Aby zainstalować pakiet NuGet, sprawdź aktualizacje lub wyświetl informacje o wersji, zobacz stronę Pakiet NuGet eksportera usługi Azure Monitor.
• Aby zapoznać się z usługami Azure Monitor i OpenTelemetry, zobacz Przykładowa aplikacja usługi Azure Monitor.
• Aby dowiedzieć się więcej na temat biblioteki OpenTelemetry i jej społeczności, zobacz repozytorium GitHub OpenTelemetry .NET.
• Aby włączyć środowiska użycia, włącz monitorowanie użytkowników sieci Web lub przeglądarki.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.

Java

• Zobacz Dodawanie i modyfikowanie usługi Azure Monitor OpenTelemetry , aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania funkcji OpenTelemetry usługi Azure Monitor.
• Zapoznaj się z opcjami konfiguracji autoinstrumentacji języka Java.
• Przejrzyj kod źródłowy w repozytorium GitHub autoinstrumentacji Java usługi Azure Monitor.
• Dowiedz się więcej o technologii OpenTelemetry i jej społeczności w repozytorium GitHub OpenTelemetry Java.
• Włącz środowiska użycia, zobacz Włączanie monitorowania użytkowników w internecie lub przeglądarce.
• Przejrzyj informacje o wersji w witrynie GitHub.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.

Natywna dla języka Java

• Zobacz Dodawanie i modyfikowanie usługi Azure Monitor OpenTelemetry , aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania funkcji OpenTelemetry usługi Azure Monitor.
• Przejrzyj kod źródłowy w usłudze Azure Monitor OpenTelemetry Distro in Spring Boot native image Application (Aplikacja Java obrazu natywnego platformy Spring Boot) i Eksporter Quarkus OpenTelemetry dla platformy Azure.
• Dowiedz się więcej o technologii OpenTelemetry i jej społeczności w repozytorium GitHub OpenTelemetry Java.
• Dowiedz się więcej o funkcjach aplikacji obrazów natywnych platformy Spring Boot w szablonie startowym SpringBoot OpenTelemetry
• Dowiedz się więcej o funkcjach aplikacji natywnych quarkus w eksporterze Quarkus OpenTelemetry dla platformy Azure.
• Przejrzyj informacje o wersji w witrynie GitHub.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.

Node.js

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie funkcji OpenTelemetry usługi Azure Monitor.
• Aby przejrzeć kod źródłowy, zobacz repozytorium GitHub OpenTelemetry usługi Azure Monitor.
• Aby zainstalować pakiet npm i sprawdzić dostępność aktualizacji, zobacz @azure/monitor-opentelemetry stronę pakiet npm.
• Aby lepiej zapoznać się z usługami Azure Monitor Application Insights i OpenTelemetry, zobacz Przykładowa aplikacja usługi Azure Monitor.
• Aby dowiedzieć się więcej o technologii OpenTelemetry i jej społeczności, zobacz repozytorium GitHub Języka JavaScript openTelemetry.
• Aby włączyć środowiska użycia, włącz monitorowanie użytkowników sieci Web lub przeglądarki.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.

Python

• Zobacz Dodawanie i modyfikowanie usługi Azure Monitor OpenTelemetry , aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania funkcji OpenTelemetry usługi Azure Monitor.
• Przejrzyj kod źródłowy i dodatkową dokumentację w repozytorium GitHub dystrybucji usługi Azure Monitor.
• Zobacz dodatkowe przykłady i przypadki użycia w przykładach dystrybucji usługi Azure Monitor.
• Przejrzyj dziennik zmian w witrynie GitHub.
• Zainstaluj pakiet PyPI, sprawdź aktualizacje lub wyświetl informacje o wersji na stronie Pakiet PyPI usługi Azure Monitor.
• Zapoznaj się z usługą Azure Monitor Application Insights i aplikacją OpenTelemetry w przykładowej aplikacji usługi Azure Monitor.
• Dowiedz się więcej na temat biblioteki OpenTelemetry i jej społeczności w repozytorium GitHub OpenTelemetry Python.
• Zobacz dostępne instrumentacje i składniki openTelemetry w repozytorium GitHub Współautor openTelemetry.
• Włącz środowiska użycia, włączając monitorowanie użytkowników w internecie lub przeglądarce.
• Aby zapoznać się z często zadawanymi pytaniami, krokami rozwiązywania problemów, opcjami pomocy technicznej lub przekazać opinię na temat funkcji OpenTelemetry, zobacz Pomoc, pomoc techniczna i opinie dotyczące usługi Azure Monitor Application Insights.