Povolení Azure Monitor OpenTelemetry pro aplikace .NET, Node.js, Python a Java

Tento článek popisuje, jak povolit a nakonfigurovat shromažďování dat založených na OpenTelemetry v rámci Azure Monitor Application Insights pomocí distro Azure Monitor OpenTelemetry. OpenTelemetry je open-source standard pro observabilitu od CNCF; Azure Monitor OpenTelemetry Distro je distribuce společnosti Microsoft tohoto standardu, optimalizovaná pro Azure Monitor. Distribuce:

• Poskytuje distribuci OpenTelemetry, která zahrnuje podporu funkcí specifických pro Azure Monitor.
• Umožňuje automatické shromažďování telemetrie pomocí instrumentačních knihoven OpenTelemetry pro shromažďování tras, metrik, logů a výjimek.
• Umožňuje shromažďovat vlastní telemetrii.
• Podporuje živé metriky pro monitorování a shromažďování telemetrie z živých webových aplikací v produkčním prostředí.

Další informace o výhodách použití Azure Monitor OpenTelemetry Distro naleznete v tématu Proč bych měl použít Azure Monitor OpenTelemetry Distro.

Další informace o shromažďování dat pomocí OpenTelemetry najdete v přehledu Application Insights nebo nejčastějších dotazech k OpenTelemetry.

Postupujte podle kroků v tomto článku a nainstalujte distribuci, připojte ji k prostředku Application Insights a ověřte, že telemetrická data proudí do služby Azure Monitor.

Návod

Koncepční přehled možností OpenTelemetry v Azure Monitoru – nativní příjem OTLP, distribuce Microsoft OpenTelemetry a komplexní prostředí observability – viz OpenTelemetry v Azure Monitoru.

Stav vydání OpenTelemetry

Nabídky OpenTelemetry jsou k dispozici pro aplikace .NET, Node.js, Python a Java. Informace o stavu vydání funkcí podle funkcí najdete v nejčastějších dotazech.

Poznámka:

Pokud pracujete s aplikacemi Azure Functions, přečtěte si téma Použití OpenTelemetry s Azure Functions.

Aktivujte OpenTelemetry pomocí Application Insights

Pomocí kroků v této části instrumentujte aplikaci pomocí OpenTelemetry. Vyberte kartu pro pokyny specifické pro konkrétní jazyk.

Následující tabulka shrnuje balíčky a příkazy pro instalaci pro každý podporovaný jazyk:

Jazyk	Package	Instalační příkaz
ASP.NET Core	Azure.Monitor.OpenTelemetry.AspNetCore	dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore
platforma .NET	Azure.Monitor.OpenTelemetry.Exporter	dotnet add package Azure.Monitor.OpenTelemetry.Exporter
Java	applicationinsights-agent-3.7.8.jar	Download z GitHub
Node.js	@azure/monitor-opentelemetry	npm install @azure/monitor-opentelemetry
Python	azure-monitor-opentelemetry	pip install azure-monitor-opentelemetry

Poznámka:

.NET se zabývá několika scénáři, včetně klasických ASP.NET, konzolových aplikací, model Windows Forms (WinForms) a dalších.

Požadavky

• Azure předplatné: Vytváření Azure předplatného zdarma
• Prostředek Application Insights: Vytvoření prostředku Application Insights

ASP.NET Core

• ASP.NET Core Application pomocí oficiálně podporované verze .NET

Návod

Pokud migrujete ze starších sad Application Insights SDK, prohlédni si naše dokumentace k migraci.

.NET

• Aplikace využívající podporovanou verzi.NET nebo .NET Framework 4.6.2 a novější.

Návod

Pokud migrujete ze starších sad Application Insights SDK, prohlédni si naše dokumentace k migraci.

Java

• Aplikace Java využívající Java 8 nebo novější

Java nativní

• Aplikace Java využívající GraalVM 17 nebo novější

Node.js

• Aplikace využívající oficiálně podporovanou verzi runtime prostředí Node.js:
  • Podporované runtime OpenTelemetry
  • Moduly runtime podporované exportérem OpenTelemetry pro Azure Monitor

Poznámka:

Pokud se nespoléháte na žádné vlastnosti uvedené v tabulce nepodporovaných vlastností, je vrstva ApplicationInsights vaší nejjednodušší cestou vpřed, jakmile bude vydána finální verze.

Pokud se spoléháte na některou z těchto vlastností, pokračujte s Azure Monitor OpenTelemetry Distro.

Návod

Pokud migrujete ze starších sad Application Insights SDK, prohlédni si naše dokumentace k migraci.

Python

• Python aplikace s využitím Python 3.10 nebo novější

Návod

Pokud migrujete z OpenCensus, prohlédni si naše dokumentace k migraci.

Instalace klientské knihovny

ASP.NET Core

Nainstalujte nejnovější balíček Azure.Monitor.OpenTelemetry.AspNetCoreNuGet:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

.NET

Nainstalujte nejnovější balíček Azure.Monitor.OpenTelemetry.ExporterNuGet:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

Java

Stáhněte si nejnovější soubor applicationinsights-agent-3.7.8.jar.

Varování

Pokud upgradujete ze starší verze 3.x, může to mít vliv na změnu výchozích hodnot nebo drobných rozdílů ve shromažďovaných datech. Další informace najdete v části migrace v poznámkách k verzi. 3.5.0, 3.4.0, 3.3.0, 3.2.0 a 3.1.0

Java nativní

Nativní aplikace Spring Boot :

• Importujte seznam materiálů (BOM) OpenTelemetry.
• Přidejte závislost Spring Cloud Azure Starter Monitor.
• Postupujte podle těchto pokynů pro soubory Azure SDK JAR (Java Archiv).

Nativní aplikace Quarkus :

• Přidejte závislost Quarkus OpenTelemetry Exportér pro Azure.

Poznámka:

Komunita Quarkus podporuje a udržuje rozšíření Quarkus. Pokud potřebujete pomoc, použijte kanály podpory komunity Quarkus. Microsoft neposkytuje technickou podporu pro tuto integraci.

Node.js

Nainstalujte nejnovější @azure/monitor-opentelemetry balíček:

npm install @azure/monitor-opentelemetry

Následující balíčky se také používají pro některé konkrétní scénáře popsané dále v tomto článku:

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/prostředky
• @opentelemetry/sémantické konvence
• @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

Nainstalujte nejnovější balíček PyPI azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Úprava aplikace

ASP.NET Core

Naimportujte obor názvů Azure.Monitor.OpenTelemetry.AspNetCore, přidejte OpenTelemetry a nakonfigurujte ho tak, aby používal Azure Monitor ve třídě 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

Přidejte exportér Azure Monitor do každého signálu OpenTelemetry ve třídě 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();
    });
});

Poznámka:

Další informace najdete v kurzu getting-started pro OpenTelemetry .NET

Java

Automatická instrumentace se povoluje změnami konfigurace. Nejsou vyžadovány žádné změny kódu.

Nasměrujte virtuální počítač Java (JVM) na soubor JAR přidáním -javaagent:"path/to/applicationinsights-agent-3.7.8.jar" do argumentů JVM vaší aplikace.

Poznámka:

Vzorkování je ve výchozím nastavení povolené rychlostí pěti požadavků za sekundu, které pomáhají při správě nákladů. Ve scénářích, které překračují tuto rychlost, můžou chybět telemetrická data. Další informace o úpravách konfigurace vzorkování naleznete v části přepisy vzorkování. Pokud se vám v Application Insights zobrazují neočekávané poplatky nebo vysoké náklady, může vám pomoct tento průvodce. Zahrnuje běžné příčiny, jako jsou vysoké objemy telemetrie, špičky příjmu dat a chybně nakonfigurované vzorkování. Je zvlášť užitečné, pokud řešíte problémy související se špičkami nákladů, objemem telemetrie, nefunkčním vzorkováním, limity dat, vysokým příjmem dat nebo neočekávanou fakturací. Pokud chcete začít, přečtěte si téma Řešení potíží s vysokým příjmem dat ve službě Application Insights.

Návod

Pokyny specifické pro konkrétní scénář najdete v tématu Začínáme (doplňkové).

Návod

Pokud vyvíjíte aplikaci Spring Boot, můžete volitelně nahradit argument JVM programovou konfigurací. Další informace najdete v tématu Použití Azure Monitor Application Insights se Spring Boot.

Java nativní

Automatická instrumentace se povoluje změnami konfigurace. Nejsou vyžadovány žádné změny kódu.

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

Zkopírujte připojovací řetězec (připojovací řetězec) z prostředku Application Insights

Připojovací řetězec je jedinečný a určuje, kam Azure Monitor OpenTelemetry Distro odesílá telemetrii, kterou shromažďuje.

Návod

Pokud ještě prostředek Application Insights nemáte, vytvořte si ho podle tohoto průvodce. Místo použití existujícího prostředku doporučujeme vytvořit nový prostředek.

Pro zkopírování připojovacího řetězce:

1. Přejděte do podokna Přehled prostředku Application Insights.
2. Najděte připojovací řetězec.
3. Najeďte myší na připojovací řetězec a vyberte ikonu Kopírovat do schránky.

Vložte připojovací řetězec do prostředí

K vložení připojovací řetězec použijte jednu z následujících metod:

Metoda	Podporované jazyky	Doporučeno pro:
Proměnná prostředí	All	Výroba
Konfigurační soubor (applicationinsights.json)	Jen Java	Produkce (Java)
Code	ASP.NET Core, Node.js, Python	Pouze místní vývoj/testování

Důležité

Doporučujeme nastavit připojovací řetězec prostřednictvím kódu pouze v místním vývojovém a testovacím prostředí.

V produkčním prostředí použijte proměnnou prostředí nebo konfigurační soubor (pouze Java).

• Nastavte připojovací řetězec služby Application Insights jako proměnnou prostředí (doporučeno pro produkční prostředí)

  V následujícím příkazu nahraďte <Your připojovací řetězec> svým řetězcem připojení.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Nastavte připojovací řetězec služby Application Insights v konfiguračním souboru - Pouze Java

  Vytvořte konfigurační soubor s názvem applicationinsights.jsona umístěte ho do stejného adresáře jako applicationinsights-agent-3.7.8.jar s následujícím obsahem:

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

  Nahraďte <Your připojovací řetězec> v předchozím formátu JSON vaším jedinečným připojovacím řetězcem.

• Nastavení připojovacího řetězce Application Insights v kódu - Pouze pro ASP.NET Core, Node.js a Python

  V části konfigurace řetězce připojení najdete příklad nastavení řetězce připojení prostřednictvím kódu.

Poznámka:

Pokud nastavíte připojovací řetězec na více místech, bude vyřešen v následujícím pořadí priorit (nejvyšší až nejnižší):

1. Code
2. Proměnná prostředí
3. Konfigurační soubor

Potvrzení toku dat

Po konfiguraci distribuce OpenTelemetry pro Azure Monitor a nastavení připojovacího řetězce spusťte aplikaci a otevřete prostředek Application Insights na portálu Azure. Ověřte, že se zobrazují trasování, metriky a protokoly. Zobrazení dat může trvat několik minut.

Application Insights je teď pro vaši aplikaci povolená. Následující kroky jsou volitelné a umožňují další přizpůsobení.

Poznámka:

V rámci instrumentace Application Insights shromažďujeme a odesíláme diagnostická data do Microsoft. Tato data nám pomáhají spouštět a vylepšovat Application Insights. Další informace najdete v nejčastějších dotazech k Application Insights.

Důležité

Pokud máte dvě nebo více služeb, které generují telemetrii do stejného prostředku Application Insights, musíte nastavit názvy cloudových rolí tak, aby je správně představovaly na mapě aplikace.

Řešení potíží, zpětná vazba a podpora

Návod

Následující části jsou k dispozici ve všech článcích o distribuci OpenTelemetry.

Troubleshooting

ASP.NET Core

Pro informace o řešení potíží si prohlédněte Řešení problémů s OpenTelemetry v .NET a Řešení problémů s chybějící telemetrií aplikací v Azure Monitor Application Insights.

.NET

Pro informace o řešení potíží si prohlédněte Řešení problémů s OpenTelemetry v .NET a Řešení problémů s chybějící telemetrií aplikací v Azure Monitor Application Insights.

Java

Informace o řešení problémů najdete v tématu Řešení problémů OpenTelemetry v Javě a Řešení problémů s chybějící telemetrií aplikací v Azure Monitor Application Insights.

Java nativní

Informace o řešení potíží najdete v tématech Řešení problémů s OpenTelemetry v aplikacích s nativním imagí Spring Boot a Řešení problémů s chybějící telemetrií aplikace v Azure Monitor Application Insights.

Node.js

Informace o řešení potíží najdete v části Řešení problémů s OpenTelemetry v Node.js a Řešení problémů s chybějící telemetrií aplikací v Azure Monitor Application Insights.

Python

Informace o řešení potíží najdete v tématu Řešení potíží s OpenTelemetry v Pythonu a Řešení potíží s chybějící telemetrií aplikace v Azure Monitor Application Insights.

Zpětná vazba k OpenTelemetry

Poskytnutí zpětné vazby:

• Vyplňte průzkum názorů zákazníků komunity OpenTelemetry.
• Řekněte Microsoft o sobě tím, že se připojíte k OpenTelemetry Early Adopter Community.
• Spojte se s dalšími uživateli Azure Monitor v technické komunitě Microsoft.
• Požádejte o funkci na fóru Azure feedback.

Podpora

Vyberte kartu pro jazyk podle vašeho výběru a objevte možnosti podpory.

ASP.NET Core

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• V případě problémů s OpenTelemetry se obraťte přímo na komunitu OpenTelemetry .NET.
• Seznam otevřených problémů souvisejících s vývozcem Azure Monitor najdete na stránce GitHub Problémy.

.NET

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• V případě problémů s OpenTelemetry se obraťte přímo na komunitu OpenTelemetry .NET.
• Seznam otevřených problémů souvisejících s vývozcem Azure Monitor najdete na stránce GitHub Problémy.

Java

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• Nápovědu k řešení potíží najdete v krocích pro řešení potíží.
• V případě problémů s OpenTelemetry kontaktujte přímo komunitu OpenTelemetry.
• Seznam otevřených problémů souvisejících s automatickým příkazem Azure Monitor pro Javu najdete na stránce GitHub Issues Page.

Java nativní

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• V případě problémů s OpenTelemetry kontaktujte přímo komunitu OpenTelemetry.
• Seznam otevřených problémů s nativními aplikacemi Spring Boot najdete na stránce GitHub Problémy.
• Seznam otevřených problémů s nativními aplikacemi Quarkus najdete na stránce GitHub Problémy.

Poznámka:

Komunita Quarkus podporuje a udržuje rozšíření Quarkus. Pokud potřebujete pomoc, použijte kanály podpory komunity Quarkus. Microsoft neposkytuje technickou podporu pro tuto integraci.

Node.js

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• V případě problémů s OpenTelemetry se obraťte přímo na komunitu OpenTelemetry JavaScriptu.
• Seznam otevřených problémů souvisejících s vývozcem Azure Monitor najdete na stránce GitHub Problémy.

Python

• V případě problémů s podporou Azure otevřete podpora Azure ticket.
• V případě problémů s OpenTelemetry se obraťte přímo na komunitu OpenTelemetry Python.
• Seznam otevřených problémů souvisejících s distribucí Azure Monitor najdete na stránce GitHub Problémy.

Další kroky

ASP.NET Core

• Informace o zdrojovém kódu najdete v úložišti Azure Monitor ASP.NET Core GitHub.
• Ukázkovou aplikaci najdete v tématu Azure Monitor OpenTelemetry pro ASP.NET Core.
• Pokud chcete nainstalovat balíček NuGet, vyhledat aktualizace nebo zobrazit poznámky k verzi, přečtěte si stránku Azure Monitor balíček NuGet AspNetCore.
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry .NET GitHub.
• Pro umožnění uživatelských zkušeností povolte monitorování uživatelů na webu nebo v prohlížeči.

.NET

• Pokud chcete zkontrolovat zdrojový kód, prohlédněte si úložiště GitHub Azure Monitor exportér.
• Ukázkovou aplikaci najdete v tématu Azure Monitor OpenTelemetry pro .NET.
• Pokud chcete nainstalovat balíček NuGet, vyhledat aktualizace nebo zobrazit poznámky k verzi, přečtěte si stránku Azure Monitor Exportér balíčku NuGet.
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry .NET GitHub.
• Pro umožnění uživatelských zkušeností povolte monitorování uživatelů na webu nebo v prohlížeči.

Java

• Informace o možnostech konfigurace najdete v části Java možnosti konfigurace automatické instrumentace.
• Pokud chcete zdrojový kód zkontrolovat, podívejte se na úložiště GitHub pro automatizaci Azure Monitor Java.
• Pokud chcete zkontrolovat ukázkové aplikace, podívejte se na Ukázky Java Application Insights.
• Přečtěte si relelease notes na GitHub.
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry Java GitHub.
• Pokud chcete povolit uživatelské zážitky, přečtěte si téma Povolení monitorování uživatelů ve webových prohlížečích.

Java nativní

• Pokud chcete zkontrolovat zdrojový kód, podívejte se na Azure Monitor OpenTelemetry Distro v nativním imagi Java aplikace Spring Boot a Quarkus OpenTelemetry Exportér pro Azure.
• Pokud chcete zkontrolovat ukázkovou aplikaci, viz téma Telemetry pro nativní bitové kopie GraalVM.
• Přečtěte si relelease notes na GitHub.
• Další informace o funkcích nativních obrazů aplikací Spring Boot v úvodní sadě OpenTelemetry SpringBoot
• Další informace o funkcích nativních aplikací Quarkus najdete v Quarkus OpenTelemetry Exportér pro Azure.
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry Java GitHub.

Node.js

• Pokud chcete zdrojový kód zkontrolovat, přečtěte si Azure Monitor OpenTelemetry pro úložiště JavaScriptu.
• Ukázkovou aplikaci najdete v tématu Azure Monitor OpenTelemetry pro Node.js.
• Pokud chcete nainstalovat balíček npm a vyhledat aktualizace, podívejte se na @azure/monitor-opentelemetry stránku balíček npm .
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry GitHub v JavaScriptu.
• Pro umožnění uživatelských zkušeností povolte monitorování uživatelů na webu nebo v prohlížeči.

Python

• Informace o zdrojovém kódu a další dokumentaci najdete v úložišti Azure Monitor Python GitHub.
• Ukázkové aplikace najdete v tématu Azure Monitor OpenTelemetry pro Python.
• Pokud chcete nainstalovat balíček PyPI a vyhledat aktualizace, podívejte se na stránku Azure Monitor Distribuce balíčku PyPI.
• Přečtěte si relelease notes na GitHub.
• Informace o dostupných instrumentacích a komponentách OpenTelemetry najdete v úložišti PřispěvatelOpenTelemetry Python GitHub.
• Další informace o OpenTelemetry a její komunitě najdete v úložišti OpenTelemetry Python GitHub.
• Pro umožnění uživatelských zkušeností povolte monitorování uživatelů na webu nebo v prohlížeči.