啟用適用於 .NET、Node.js、Python 和 Java 應用程式的 Azure 監視器 OpenTelemetry (部分機器翻譯)

文章
10/14/2024

本文說明如何在 Application Insights 內啟用和設定以 OpenTelemetry 為基礎的資料收集。 Azure 監視器 OpenTelemetry 發行版本：

提供 OpenTelemetry 發行版本，其中包含 Azure 監視器的特定功能支援。
藉由包含 OpenTelemetry 檢測程式庫來收集追蹤、計量、記錄和例外狀況，以啟用自動遙測。
允許收集自訂遙測。
支援即時計量以監視及收集來自即時、生產階段 Web 應用程式的更多遙測。

如需使用 Azure 監視器 OpenTelemetry 發行版本的優點相關資訊，請參閱為何應該使用 Azure 監視器 OpenTelemetry 發行版本。

若要深入了解如何使用 OpenTelemetry 收集資料，請參閱資料收集基本概念或 OpenTelemetry 常見問題集。

OpenTelemetry 發行狀態

OpenTelemetry 供應項目適用於 .NET、Node.js、Python 和 Java 應用程式。如需各種功能版本狀態，請參閱常見問題 (部分機器翻譯)。

使用 Application Insights 啟用 OpenTelemetry

請遵循本節中的步驟，使用 OpenTelemetry 檢測您的應用程式。選取索引標籤以取得特定語言的指示。

注意

.NET 涵蓋多個案例，包括傳統 ASP.NET、主控台應用程式、Windows Forms (WinForms) 等等。

必要條件

Azure 訂用帳戶：免費建立 Azure 訂用帳戶
Application Insights 資源：建立 Application Insights 資源

ASP.NET Core 應用程式使用正式支援的 .NET 版本

提示

如果您正從 Application Insights Classic API 遷移，請參閱我們的移轉文件。

安裝用戶端程式庫

安裝最新的 Azure.Monitor.OpenTelemetry.AspNetCore NuGet 套件：

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

安裝最新的 Azure.Monitor.OpenTelemetry.Exporter NuGet 套件：

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

安裝最新的 @azure/monitor-opentelemetry 套件：

npm install @azure/monitor-opentelemetry

本文稍後說明的一些特定案例還使用下列套件：

npm install @opentelemetry/api
npm install @opentelemetry/sdk-metrics
npm install @opentelemetry/resources
npm install @opentelemetry/semantic-conventions
npm install @opentelemetry/sdk-trace-base

安裝最新的 azure-monitor-opentelemetry PyPI 套件：

pip install azure-monitor-opentelemetry

修改您的應用程式

匯入 Azure.Monitor.OpenTelemetry.AspNetCore 命名空間、新增 OpenTelemetry，並將其設定為在 program.cs 類別中使用 Azure 監視器：

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

將 Azure 監視器匯出工具新增至 program.cs 類別中的每個 OpenTelemetry 訊號：

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

注意

如需詳細資訊，請參閱 OpenTelemetry .NET 的快速入門教學課程 (英文)

會透過設定變更的方式來啟用自動檢測。 不需要變更程式碼。

藉由將 -javaagent:"path/to/applicationinsights-agent-3.6.2.jar" 新增至應用程式的 JVM 引數，將 Java 虛擬機器 (JVM) 指向 jar 檔案。

注意

取樣預設會以每秒 5 個要求的速度啟用，以協助成本管理。在超出此速率的案例中，遙測資料可能會遺漏。如需修改取樣組態的詳細資訊，請參閱取樣覆寫 (部分機器翻譯)。

提示

如需案例特定指導，請參閱開始使用 (補充) (部分機器翻譯)。

提示

如果您開發 Spring Boot 應用程式，則可以選擇性地透過程式設計設定來取代 JVM 引數。如需詳細資訊，請參閱將 Azure 監視器 Application Insights 與 Spring Boot 搭配使用。

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

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

從 Application Insights 資源複製連接字串

連接字串是唯一的，並指定 Azure 監視器 OpenTelemetry 發行版本傳送其收集的遙測的位置。

提示

如果您還沒有可以使用的 Application Insights 資源，請遵循本指南建立資源。建議您建立新的資源，而不是使用現有的資源。

若要複製連接字串：

移至 Application Insights 資源的 [概觀] 窗格。
尋找您的連接字串。
暫留在連接字串上，選取「複製到剪貼簿」圖示。

在您的環境中貼上連接字串

若要貼上連接字串，請從下列選項中進行選取：

重要

建議您只在本機開發和測試環境中透過程式碼設定連接字串。

針對生產環境，請使用環境變數或組態檔 (僅限 JAVA)。

透過環境變數設定 - 建議

使用您的連接字串取代下列命令中的 <Your connection string>。
```
APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
```
透過組態檔設定 - 僅限 JAVA

建立名為 applicationinsights.json 的組態檔，並將其置於具有與 applicationinsights-agent-3.6.2.jar 下列內容的相同目錄下：
```
{
  "connectionString": "<Your connection string>"
}
```
將上述 JSON 中的 <Your connection string> 取代為您的唯一連接字串。
透過程式碼設定 - 僅限 ASP.NET Core、Node.js 和 Python

如需透過程式碼設定連接字串的範例，請參閱連接字串組態。

注意

如果您在多個位置設定連接字串，則環境變數會依下列順序排列優先順序：

代碼
環境變數
組態檔

確認資料正在流動

執行您的應用程式，然後在 Azure 入口網站中開啟 Application Insights。資料可能需要幾分鐘的時間才會顯示。

此螢幕擷取畫面顯示 Application Insights 的 [概觀] 索引標籤，其中醒目提示伺服器要求和伺服器回應時間。

Application Insights 現在已為您的應用程式啟用。下列步驟是選擇性的，並允許進一步自訂。

重要

如果您有兩個以上的服務將遙測發出至相同的 Application Insights 資源，則必須設定雲端角色名稱，才能在應用程式對應上正確地代表服務。

在使用 Application Insights 檢測的過程中，我們會收集診斷資料並且傳送給 Microsoft。此資料可協助我們執行及改善 Application Insights。若要深入了解，請參閱在 Azure Application Insights 中的 Statsbeat。

範例應用程式

Azure 監視器 OpenTelemetry 範例應用程式適用於所有支援的語言：

下一步

如需有關新增和修改 Azure 監視器 OpenTelemetry 的詳細資料，請參閱新增和修改 Azure 監視器 OpenTelemetry。
若要進一步設定 OpenTelemetry 發行版本，請參閱 Azure 監視器 OpenTelemetry 設定 (部分機器翻譯)。
若要檢閱原始程式碼，請參閱 Azure 監視器 AspNetCore GitHub 存放庫 (英文)。
若要安裝 NuGet 套件、檢查更新或檢視版本資訊，請參閱 Azure 監視器 AspNetCore NuGet 套件 (英文) 頁面。
若要進一步熟悉 Azure 監視器和 OpenTelemetry，請參閱 Azure 監視器範例應用程式 (英文)。
若要深入了解 OpenTelemetry 和其社群，請參閱 OpenTelemetry .NET GitHub 存放庫。
若要啟用使用體驗，請啟用 Web 或瀏覽器使用者監視。
若要檢閱常見問題、疑難解答步驟、支持選項，或提供OpenTelemetry意見反應，請參閱 Azure 監視器 Application Insights 的 OpenTelemetry 說明、支援和意見反應。

如需有關新增和修改 Azure 監視器 OpenTelemetry 的詳細資料，請參閱新增和修改 Azure 監視器 OpenTelemetry。
若要檢閱原始程式碼，請參閱 Azure 監視器 OpenTelemetry GitHub 存放庫 (英文)。
若要安裝 npm 套件並檢查更新，請參閱 @azure/monitor-opentelemetrynpm 套件 (英文) 頁面。
若要進一步熟悉 Azure 監視器 Application Insights 和 OpenTelemetry，請參閱 Azure 監視器範例應用程式。
若要深入了解 OpenTelemetry 和其社群，請參閱 OpenTelemetry JavaScript GitHub 存放庫。
若要啟用使用體驗，請啟用 Web 或瀏覽器使用者監視。
若要檢閱常見問題、疑難解答步驟、支持選項，或提供OpenTelemetry意見反應，請參閱 Azure 監視器 Application Insights 的 OpenTelemetry 說明、支援和意見反應。

分享方式：