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 Azure Monitor Application Insights. Dystrybucja OpenTelemetry dla usługi Azure Monitor

• Udostępnia dystrybucję OpenTelemetry, która obejmuje obsługę funkcji specyficznych dla usługi Azure Monitor.
• Włącza automatyczną telemetrię, włączając biblioteki do 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ęcej danych telemetrycznych z internetowych aplikacji produkcyjnych.

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 dla poszczególnych funkcji, zobacz FAQ.

Uwaga

W przypadku aplikacji funkcji platformy Azure zobacz Use OpenTelemetry with Azure Functions (Używanie funkcji OpenTelemetry z usługą Azure Functions).

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ę z instrukcjami specyficznymi 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.

Jawa

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

Natywny Java

• Aplikacja Java korzystająca z maszyny GraalVM 17+

Node.js

• Aplikacja korzystająca z oficjalnie obsługiwanej wersji środowiska uruchomieniowego Node.js:
  • Środowiska uruchomieniowe obsługiwane przez 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ługiwanych, nakładka ApplicationInsights będzie najprostszym rozwiązaniem, gdy zakończy się wersja beta.

Jeśli polegasz na którejkolwiek z tych właściwości, zastosuj Azure Monitor OpenTelemetry Distro. 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.

Pyton

• 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.AspNetCorepakiet NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

Zainstaluj najnowszy Azure.Monitor.OpenTelemetry.Exporterpakiet NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Jawa

Pobierz najnowszy plik applicationinsights-agent-3.7.1.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 uwagach do wydania. 3.5.0, 3.4.0, 3.3.0, 3.2.0 i 3.1.0

Natywny Java

W przypadku aplikacji natywnych platformy Spring Boot :

• Zaimportuj listę materiałów 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 zależność Quarkus OpenTelemetry Exporter for 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

Pyton

Zainstaluj najnowszy pakiet PyPI azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Modyfikowanie aplikacji

ASP.NET Core

Zaimportuj przestrzeń nazw Azure.Monitor.OpenTelemetry.AspNetCore, dodaj OpenTelemetry i skonfiguruj ją tak, aby korzystała z usługi Azure Monitor w klasie 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

Dodaj eksportera Azure Monitor do każdego sygnału OpenTelemetry w klasie 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();
    });
});

Uwaga

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

Jawa

Automatyczna instrumentacja jest włączona poprzez zmiany w konfiguracji. Nie są wymagane żadne zmiany kodu.

Skieruj maszynę wirtualną Java (JVM) na plik jar, dodając -javaagent:"path/to/applicationinsights-agent-3.7.1.jar" do argumentów 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. Jeśli widzisz nieoczekiwane opłaty lub wysokie koszty w usłudze Application Insights, ten przewodnik może pomóc. Obejmuje ona typowe przyczyny, takie jak duża ilość danych telemetrycznych, skoki pozyskiwania danych i błędnie skonfigurowane próbkowanie. Jest to szczególnie przydatne, jeśli rozwiązujesz problemy związane ze wzrostem kosztów, ilością danych telemetrycznych, niedziałającym próbkowaniem, limitami danych, wysokim pozyskiwaniem lub nieoczekiwanymi rozliczeniami. Aby rozpocząć, zapoznaj się z Rozwiązywanie problemów z wysokim pozyskiwaniem danych w usłudze Application Insights.

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

Natywny Java

Automatyczna instrumentacja jest włączona poprzez zmiany w 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();

Pyton

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.

Skopiuj ciąg połączenia z zasobu usługi Application Insights

Ciąg połączenia jest unikatowy i określa, gdzie Azure Monitor OpenTelemetry Distro wysyła zebrane dane telemetryczne.

Napiwek

Jeśli nie masz jeszcze zasobu usługi Application Insights, utwórz go, postępując zgodnie z tym przewodnikiem. 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ź swój ciąg połączenia.
3. Umieść kursor na parametry połączenia i wybierz ikonę Kopiuj do schowka.

Wklej ciąg połączenia do swojego środowiska

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

Ważne

Zalecamy ustawianie ciągu 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).

• Ustaw poprzez zmienną środowiskową - zalecane

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Ustawione za pomocą pliku konfiguracyjnego - Tylko dla Java

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

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

  Zastąp <Your connection string> w poprzednim formacie JSON twoim unikalnym ciągiem połączenia.

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

  Zobacz konfigurację parametrów połączenia jako przykład ustawienia parametrów 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 w aplikacji 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 natywne 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 Azure Monitor AspNetCore.
• Aby zainstalować pakiet NuGet, sprawdzić dostępność aktualizacji lub wyświetlić informacje o wersji, zobacz stronę pakietu NuGet platformy Azure Monitor AspNetCore.
• 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ć doświadczenia użytkowania, 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, sprawdzić aktualizacje lub wyświetlić informacje o wersji, przejdź do strony Azure Monitor Exporter NuGet Package.
• 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ć doświadczenia użytkowania, 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.

Jawa

• Zobacz Dodawanie i modyfikowanie Azure Monitor OpenTelemetry, aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania Azure Monitor OpenTelemetry.
• Zapoznaj się z opcjami konfiguracji autoinstrumentacji języka Java.
• Przejrzyj kod źródłowy w repozytorium GitHub autoinstrumentacji Java dla Azure Monitor.
• Dowiedz się więcej o technologii OpenTelemetry i jej społeczności w repozytorium GitHub OpenTelemetry Java.
• Aby umożliwić doświadczenia użytkowników, zobacz Włączanie monitorowania użytkowników w internecie lub przeglądarce.
• Przejrzyj informacje o wersji na 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.

Natywny Java

• Zobacz Dodawanie i modyfikowanie Azure Monitor OpenTelemetry, aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania Azure Monitor OpenTelemetry.
• Przejrzyj kod źródłowy w Azure Monitor OpenTelemetry Distro dla aplikacji Java w natywnym obrazie platformy Spring Boot i eksporterze Quarkus OpenTelemetry dla 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 na 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 projektu 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 o technologii OpenTelemetry i jej społeczności, odwiedź repozytorium GitHub JavaScript OpenTelemetry.
• Aby włączyć doświadczenia użytkowania, 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.

Pyton

• Zobacz Dodawanie i modyfikowanie Azure Monitor OpenTelemetry, aby uzyskać szczegółowe informacje na temat dodawania i modyfikowania Azure Monitor OpenTelemetry.
• 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ów OpenTelemetry.
• Umożliwiaj doświadczenia użytkownika poprzez włączenie monitorowania użytkowników sieci 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.