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 usłudze OpenTelemetry w celu obsługi środowisk w usłudze Azure Monitor Application Insights. Omówimy sposób instalowania dystrybucji "Azure Monitor OpenTelemetry". Dystrybucja automatycznie zbiera ślady, metryki, dzienniki i wyjątki w aplikacji i jej zależnościach. Aby dowiedzieć się więcej na temat zbierania danych przy użyciu technologii OpenTelemetry, zobacz 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.

Język	Stan wydania
ASP.NET Core	⚠✔ 2
.NET (eksporter)	✅1
Java	✅1
Node.js	✅1
Python	✅1

Przypisy dolne

• ✅ 1: Usługa OpenTelemetry jest dostępna dla wszystkich klientów z formalną pomocą techniczną.
• ⚠✔ 2: Funkcja OpenTelemetry jest dostępna jako publiczna wersja zapoznawcza. Dodatkowe warunki użytkowania dotyczące wersji zapoznawczych platformy Microsoft Azure

Uwaga

Aby uzyskać informacje o stanie wydania funkcji po funkcji, zobacz często zadawane pytania. Dystrybucja ASP.NET Core jest poddawana dodatkowym testom stabilności przed ga. Możesz użyć eksportera .NET, jeśli potrzebujesz w pełni obsługiwanego rozwiązania OpenTelemetry dla aplikacji ASP.NET Core.

Rozpoczęcie pracy

Wykonaj kroki opisane w tej sekcji, aby instrumentować aplikację przy użyciu usługi OpenTelemetry.

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 aplikacji przy użyciu oficjalnie obsługiwanej wersji platformy .NET Core

.NET

• Aplikacja korzystająca z oficjalnie obsługiwanej wersji platformy .NET Core lub .NET Framework, która jest co najmniej .NET Framework 4.6.2

Java

• Aplikacja Java korzystająca z języka Java w wersji 8 lub nowszej

Node.js

Uwaga

Jeśli korzystasz z żadnych właściwości w tabeli nieobsługiwanej, użyj dystrybucji i wkrótce udostępnimy przewodnik migracji. Jeśli nie, podkładka usługi App Insights jest najprostszą ścieżką do przodu, gdy nie jest w wersji beta.

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

Python

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

Porada

Nie zalecamy używania zestawu SDK/interfejsu API społeczności OTel z usługą Azure Monitor OTel Distro, ponieważ automatycznie ładuje je jako zależności.

Instalowanie biblioteki klienta

ASP.NET Core

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

dotnet add package --prerelease Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

Pobierz plik applicationinsights-agent-3.4.17.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 niewielkich różnic w zbieranych danych. Aby uzyskać więcej informacji, zobacz sekcję migracji w informacjach o wersji. 3.4.0, 3.3.0, 3.2.0 i 3.1.0

Node.js

Zainstaluj następujące pakiety:

• @azure/monitor-opentelemetry

npm install @azure/monitor-opentelemetry

Następujące pakiety są również używane w przypadku niektórych konkretnych scenariuszy 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

Włączanie usługi Azure Monitor Application Insights

Aby włączyć usługę Azure Monitor Application Insights, wprowadzasz drobne modyfikacje aplikacji i ustawiasz wartość "Parametry połączenia". Parametry połączenia informują aplikację, gdzie mają być wysyłane dane telemetryczne zbierane przez dystrybucję, i są one unikatowe dla Ciebie.

Modyfikowanie aplikacji

ASP.NET Core

Dodaj UseAzureMonitor() element do uruchamiania aplikacji. W zależności od używanej wersji platformy .NET jest ona w startup.cs klasie lub program.cs .

// Import the Azure.Monitor.OpenTelemetry.AspNetCore namespace.
using Azure.Monitor.OpenTelemetry.AspNetCore;

// Create a new WebApplicationBuilder instance.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry NuGet package to the application's services and configure OpenTelemetry to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the application.
var app = builder.Build();

// Run the application.
app.Run();

.NET

Dodaj eksportera usługi Azure Monitor do każdego sygnału OpenTelemetry podczas uruchamiania aplikacji. W zależności od używanej wersji platformy .NET jest ona w startup.cs klasie lub 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.
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.
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter();

// Create a new logger factory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        options.AddAzureMonitorLogExporter();
    });
});

Uwaga

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

Java

Autoinstrumentacja języka Java jest włączona za pomocą zmian konfiguracji; nie są wymagane żadne zmiany w kodzie.

Wskaż maszynę wirtualną JVM do pliku jar, dodając -javaagent:"path/to/applicationinsights-agent-3.4.17.jar" element do args JVM aplikacji.

Porada

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

Porada

Jeśli tworzysz aplikację Spring Boot, możesz opcjonalnie 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).

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 specified connection
# string.
configure_azure_monitor(
    connection_string="<Your Connection String>",
)

# Get a tracer for the current module.
tracer = trace.get_tracer(__name__)

# Start a new span with the name "hello". This also sets this created span as the current span in this context. This span will be exported to Azure Monitor as part of the trace.
with tracer.start_as_current_span("hello"):
    print("Hello, World!")

# Wait for export to take place in the background.
input()

Kopiowanie parametrów połączenia z zasobu usługi Application Insights

Porada

Jeśli jeszcze go nie masz, teraz jest to świetny czas na utworzenie zasobu usługi Application Insights. W tym przypadku zalecamy utworzenie nowego zasobu usługi Application Insights w porównaniu z użyciem istniejącego zasobu.

Aby skopiować unikatowe parametry połączenia:

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

Wklej parametry połączenia w środowisku

Aby wkleić parametry połączenia, wybierz następujące opcje:

A. Ustaw za pomocą zmiennej środowiskowej (zalecane)

Zastąp <Your Connection String> ciąg w poniższym poleceniu unikatowymi parametrami połączenia.

APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

B. Ustaw za pomocą pliku konfiguracji — tylko Java (zalecane)

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

{
  "connectionString": "<Your Connection String>"
}

Zastąp <Your Connection String> element w poprzednim formacie JSON unikatowymi parametrami połączenia.

C. Ustaw za pomocą kodu — ASP.NET Core, Node.js i Tylko język Python (niezalecane)

Zobacz Konfiguracja parametrów połączenia , aby zapoznać się z przykładem ustawienia parametrów połączenia za pomocą kodu.

Uwaga

Jeśli ustawisz parametry połączenia w więcej niż jednym miejscu, przestrzegamy następującej precendencji:

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

Potwierdzanie przepływu danych

Uruchom aplikację i otwórz kartę Zasób usługi Application Insights w Azure Portal. Wyświetlenie danych w portalu może potrwać kilka minut.

Teraz włączono usługę Application Insights dla aplikacji. Wszystkie 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).

Rozwiązywanie problemów

ASP.NET Core

Nie działa? Zapoznaj się ze stroną rozwiązywania problemów dla ASP.NET Core.

.NET

Nie działa? Zapoznaj się ze stroną rozwiązywania problemów dla platformy .NET.

Java

Nie działa? Zapoznaj się ze stroną rozwiązywania problemów dla języka Java.

Node.js

Nie działa? Zapoznaj się ze stroną rozwiązywania problemów dla Node.js.

Python

Nie działa? Zapoznaj się ze stroną rozwiązywania problemów dla języka Python.

Pomoc techniczna

Wybierz kartę dla wybranego języka, aby odnaleźć opcje pomocy technicznej.

ASP.NET Core

• W przypadku pomoc techniczna platformy Azure problemów otwórz bilet pomoc techniczna platformy Azure.
• W przypadku problemów z funkcją OpenTelemetry skontaktuj się bezpośrednio ze społecznością platformy .NET OpenTelemetry .
• Aby uzyskać listę otwartych problemów związanych z eksporterem usługi Azure Monitor, zobacz stronę Problemów z usługą GitHub.

.NET

• W przypadku pomoc techniczna platformy Azure problemów otwórz bilet pomoc techniczna platformy Azure.
• W przypadku problemów z funkcją OpenTelemetry skontaktuj się bezpośrednio ze społecznością platformy .NET OpenTelemetry .
• Aby uzyskać listę otwartych problemów związanych z eksporterem usługi Azure Monitor, zobacz stronę Problemów z usługą GitHub.

Java

• W przypadku pomoc techniczna platformy Azure problemów otwórz bilet pomoc techniczna platformy Azure.
• Aby uzyskać pomoc dotyczącą rozwiązywania problemów, zapoznaj się z krokami rozwiązywania problemów.
• W przypadku problemów z funkcją OpenTelemetry skontaktuj się bezpośrednio ze społecznością OpenTelemetry .
• Aby uzyskać listę otwartych problemów związanych z autoinstrumentacją Java usługi Azure Monitor, zobacz stronę Problemów z usługą GitHub.

Node.js

• W przypadku pomoc techniczna platformy Azure problemów otwórz bilet pomoc techniczna platformy Azure.
• W przypadku problemów z funkcją OpenTelemetry skontaktuj się bezpośrednio ze społecznością języka JavaScript openTelemetry .
• Aby uzyskać listę otwartych problemów związanych z eksporterem usługi Azure Monitor, zobacz stronę Problemów z usługą GitHub.

Python

• W przypadku pomoc techniczna platformy Azure problemów otwórz bilet pomoc techniczna platformy Azure.
• W przypadku problemów z funkcją OpenTelemetry skontaktuj się bezpośrednio ze społecznością języka Python OpenTelemetry .
• Aby uzyskać listę otwartych problemów związanych z dystrybucją usługi Azure Monitor, zobacz stronę problemów z usługą GitHub.

Opinie dotyczące programu OpenTelemetry

Aby przekazać opinię:

• Wypełnij ankietę opinii klientów społeczności OpenTelemetry.
• Poinformuj firmę Microsoft o sobie, dołączając do społeczności wczesnego wdrażania OpenTelemetry.
• Skontaktuj się z innymi użytkownikami usługi Azure Monitor w Microsoft Tech Community.
• Wyślij żądanie funkcji na forum opinii platformy Azure.

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 biblioteki OpenTelemetry usługi Azure Monitor
• Aby jeszcze bardziej skonfigurować dystrybucję OpenTelemetry, zobacz Konfigurowanie usługi Azure Monitor OpenTelemetry
• Aby przejrzeć kod źródłowy, zobacz repozytorium GitHub usługi Azure Monitor AspNetCore.
• Aby zainstalować pakiet NuGet, sprawdź aktualizacje 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 technologii 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.

.NET

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie biblioteki OpenTelemetry usługi Azure Monitor
• Aby jeszcze bardziej skonfigurować dystrybucję OpenTelemetry, zobacz Konfigurowanie usługi Azure Monitor OpenTelemetry
• 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 technologii 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.

Java

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie biblioteki OpenTelemetry usługi Azure Monitor
• Zapoznaj się z opcjami konfiguracji autoinstrumentacji języka Java.
• Aby zapoznać się z kodem źródłowym, zobacz repozytorium GitHub autoinstrumentacji java usługi Azure Monitor.
• Aby dowiedzieć się więcej o technologii OpenTelemetry i jego społeczności, zobacz repozytorium GitHub OpenTelemetry Java.
• Aby włączyć środowiska użycia, zobacz Włączanie monitorowania użytkowników sieci Web lub przeglądarki.
• Zapoznaj się z informacjami o wersji w usłudze GitHub.

Node.js

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie usługi Azure Monitor OpenTelemetry
• Aby przejrzeć kod źródłowy, zobacz repozytorium GitHub usługi Azure Monitor OpenTelemetry.
• 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 na temat technologii OpenTelemetry i jej społeczności, zobacz repozytorium GitHub OpenTelemetry JavaScript.
• Aby włączyć obsługę użycia, włącz monitorowanie użytkowników sieci Web lub przeglądarki.

Python

• Aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania usługi Azure Monitor OpenTelemetry, zobacz Dodawanie i modyfikowanie usługi Azure Monitor OpenTelemetry
• Aby zapoznać się z kodem źródłowym i dodatkową dokumentacją, zobacz repozytorium GitHub dystrybucji usługi Azure Monitor.
• Aby wyświetlić dodatkowe przykłady i przypadki użycia, zobacz Przykłady dystrybucji usługi Azure Monitor.
• Zapoznaj się z informacjami o wersji w usłudze GitHub.
• Aby zainstalować pakiet PyPI, sprawdź aktualizacje lub wyświetl informacje o wersji, zobacz stronę Pakiet PyPI usługi Azure Monitor .
• 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 na temat platformy OpenTelemetry i jej społeczności, zobacz repozytorium GitHub OpenTelemetry Python.
• Aby wyświetlić dostępne instrumentacje i składniki OpenTelemetry, zobacz repozytorium GitHub współautora biblioteki OpenTelemetry w języku Python.
• Aby włączyć obsługę użycia, włącz monitorowanie użytkowników sieci Web lub przeglądarki.