通过

为 .NET、Java、Node.js 和 Python 应用程序添加和修改 Azure Monitor OpenTelemetry

  • 项目

本文提供有关如何使用 Azure Monitor Application Insights 为应用程序添加和修改 OpenTelemetry 的指导。

若要详细了解 OpenTelemetry 概念，请参阅 OpenTelemetry 概述或 OpenTelemetry 常见问题解答。

自动数据收集

发行版通过捆绑 OpenTelemetry 检测库来自动收集数据。

包含的检测库

请求

依赖项

Logging

  • ILogger

有关 ILogger 的详细信息，请参阅 C# 和 .NET 中的日志记录和代码示例。

脚注

  • ¹：支持未经处理的/未捕获的异常的自动报告
  • ²：支持 OpenTelemetry 指标
  • ³：默认情况下，日志记录仅在 INFO 级别或更高级别收集。 若要更改此设置，请参阅配置选项。
  • ⁴：默认情况下，仅当在 WARNING 级别或更高级别执行日志记录时，才会收集日志记录。

注意

Azure Monitor OpenTelemetry 发行版包括自定义映射和逻辑，用于自动发出 Application Insights 标准指标。

提示

所有 OpenTelemetry 指标，无论是从检测库自动收集的还是从自动编码中收集收集的，现在都被认为是用于计费目的的 Application Insights“自定义指标”。 了解详细信息。

添加社区检测库

从 OpenTelemetry 社区包含检测库时，可以自动收集更多数据。

注意

我们不支持也不保证社区检测库的质量。 要为我们的分发版推荐一个检测库，请在反馈社区中发帖或投票。 请注意，某些检测库基于实验性 OpenTelemetry 规范，可能会在将来引入中断性变更。

若要添加社区库，请在为库添加 NuGet 包后使用 ConfigureOpenTelemetryMeterProvider 或 ConfigureOpenTelemetryTracerProvider 方法。

以下示例演示如何添加运行时检测以收集额外指标：

dotnet add package OpenTelemetry.Instrumentation.Runtime 

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry meter provider to add runtime instrumentation.
builder.Services.ConfigureOpenTelemetryMeterProvider((sp, builder) => builder.AddRuntimeInstrumentation());

// Add the Azure Monitor telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

收集自定义遥测数据

本部分介绍如何从应用程序收集自定义遥测数据。

根据语言和信号类型，可以通过不同的方式收集自定义遥测数据，包括：

  • OpenTelemetry API
  • 特定于语言的日志记录/指标库
  • Application Insights Classic API

下表显示了目前支持的自定义遥测类型：

语言 自定义事件 自定义指标 依赖项 异常 页面视图 请求 跟踪
ASP.NET Core
   OpenTelemetry API 是 是 是 是
   ILogger API 是
   AI Classic API
Java
   OpenTelemetry API 是 是 是 是
   Logback，Log4j，JUL 是 是
   Micrometer 指标 是
   AI Classic API 是 是 是 是 是 是 是
Node.js
   OpenTelemetry API 是 是 是 是
Python
   OpenTelemetry API 是 是 是 是
   Python 日志记录模块 是
   事件扩展 是 是

注意

Application Insights Java 3.x 会侦听发送到 Application Insights Classic API 的遥测数据。 类似地，Application Insights Node.js 3.x 会收集使用 Application Insights Classic API 创建的事件。 在所有自定义遥测类型都通过 OpenTelemetry API 得到支持之前，这可以简化升级，并填补自定义遥测支持中的空白。

添加自定义指标

在这种情况下，自定义指标这个术语是指收集检测代码，以收集 OpenTelemetry 检测库没有自动收集的额外指标。

OpenTelemetry API 提供六种指标“检测”来涵盖各种指标方案，在指标资源管理器中可视化指标时，需要选取正确的“聚合类型”。 使用 OpenTelemetry 指标 API 发送指标和使用检测库时，此要求是正确的。

下表显示了每个 OpenTelemetry 指标检测的建议聚合类型。

OpenTelemetry 检测 Azure Monitor 聚合类型
计数器 Sum
异步计数器 Sum
直方图 Min、Max、Average、Sum 和 Count
异步仪表 平均值
UpDownCounter Sum
异步 UpDownCounter Sum

注意

表中显示类型以外的聚合类型通常没有意义。

OpenTelemetry 规范介绍了这些检测，并提供了何时可以使用每种检测的示例。

提示

直方图是最通用的，也与 Application Insights GetMetric Classic API 最接近。 Azure Monitor 目前将直方图检测合并到五种受支持的聚合类型中，并且正在研发对百分位数的支持。 其他 OpenTelemetry 检测虽然通用性较差，但是对应用程序性能的影响较小。

直方图示例

应用程序启动必须按名称订阅计量：

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry meter provider to add a meter named "OTel.AzureMonitor.Demo".
builder.Services.ConfigureOpenTelemetryMeterProvider((sp, builder) => builder.AddMeter("OTel.AzureMonitor.Demo"));

// Add the Azure Monitor telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Meter 必须使用同一名称初始化：

// Create a new meter named "OTel.AzureMonitor.Demo".
var meter = new Meter("OTel.AzureMonitor.Demo");

// Create a new histogram metric named "FruitSalePrice".
Histogram<long> myFruitSalePrice = meter.CreateHistogram<long>("FruitSalePrice");

// Create a new Random object.
var rand = new Random();

// Record a few random sale prices for apples and lemons, with different colors.
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "apple"), new("color", "red"));
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "lemon"), new("color", "yellow"));
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "lemon"), new("color", "yellow"));
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "apple"), new("color", "green"));
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "apple"), new("color", "red"));
myFruitSalePrice.Record(rand.Next(1, 1000), new("name", "lemon"), new("color", "yellow"));

计数器示例

应用程序启动必须按名称订阅计量：

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry meter provider to add a meter named "OTel.AzureMonitor.Demo".
builder.Services.ConfigureOpenTelemetryMeterProvider((sp, builder) => builder.AddMeter("OTel.AzureMonitor.Demo"));

// Add the Azure Monitor telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Meter 必须使用同一名称初始化：

// Create a new meter named "OTel.AzureMonitor.Demo".
var meter = new Meter("OTel.AzureMonitor.Demo");

// Create a new counter metric named "MyFruitCounter".
Counter<long> myFruitCounter = meter.CreateCounter<long>("MyFruitCounter");

// Record the number of fruits sold, grouped by name and color.
myFruitCounter.Add(1, new("name", "apple"), new("color", "red"));
myFruitCounter.Add(2, new("name", "lemon"), new("color", "yellow"));
myFruitCounter.Add(1, new("name", "lemon"), new("color", "yellow"));
myFruitCounter.Add(2, new("name", "apple"), new("color", "green"));
myFruitCounter.Add(5, new("name", "apple"), new("color", "red"));
myFruitCounter.Add(4, new("name", "lemon"), new("color", "yellow"));

仪表示例

应用程序启动必须按名称订阅计量：

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry meter provider to add a meter named "OTel.AzureMonitor.Demo".
builder.Services.ConfigureOpenTelemetryMeterProvider((sp, builder) => builder.AddMeter("OTel.AzureMonitor.Demo"));

// Add the Azure Monitor telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Meter 必须使用同一名称初始化：

// Get the current process.
var process = Process.GetCurrentProcess();

// Create a new meter named "OTel.AzureMonitor.Demo".
var meter = new Meter("OTel.AzureMonitor.Demo");

// Create a new observable gauge metric named "Thread.State".
// This metric will track the state of each thread in the current process.
ObservableGauge<int> myObservableGauge = meter.CreateObservableGauge("Thread.State", () => GetThreadState(process));

private static IEnumerable<Measurement<int>> GetThreadState(Process process)
{
    // Iterate over all threads in the current process.
    foreach (ProcessThread thread in process.Threads)
    {
        // Create a measurement for each thread, including the thread state, process ID, and thread ID.
        yield return new((int)thread.ThreadState, new("ProcessId", process.Id), new("ThreadId", thread.Id));
    }
}

添加自定义异常

选择检测库会自动报告 Application Insights 的异常。 但是，你可能想要手动报告检测库报告的异常之外的异常。 例如，通常不会报告代码捕获的异常。 你可能希望报告这些异常，以便在相关体验中引起注意，包括故障部分和端到端事务视图。

  • 要使用 Activity 记录异常：

    // Start a new activity named "ExceptionExample".
using (var activity = activitySource.StartActivity("ExceptionExample"))
{
    // Try to execute some code.
    try
    {
        throw new Exception("Test exception");
    }
    // If an exception is thrown, catch it and set the activity status to "Error".
    catch (Exception ex)
    {
        activity?.SetStatus(ActivityStatusCode.Error);
        activity?.RecordException(ex);
    }
}

  • 要使用 ILogger 记录异常：

    // Create a logger using the logger factory. The logger category name is used to filter and route log messages.
var logger = loggerFactory.CreateLogger(logCategoryName);

// Try to execute some code.
try
{
    throw new Exception("Test Exception");
}
catch (Exception ex)
{
    // Log an error message with the exception. The log level is set to "Error" and the event ID is set to 0.
    // The log message includes a template and a parameter. The template will be replaced with the value of the parameter when the log message is written.
    logger.Log(
        logLevel: LogLevel.Error,
        eventId: 0,
        exception: ex,
        message: "Hello {name}.",
        args: new object[] { "World" });
}

添加自定义范围

你可能想要在两种情况下添加自定义跨度。 首先，当存在检测库尚未收集的依赖项请求时。 其次，当你希望在端到端事务视图上将应用程序进程建模为跨度时。

注意

System.Diagnostics 命名空间中的 Activity 和 ActivitySource 类分别代表 Span 和 Tracer 的 OpenTelemetry 概念。 可以通过使用其构造函数而不是使用 TracerProvider 来直接创建 ActivitySource。 每个 ActivitySource 类都必须使用 AddSource() 显式连接到 TracerProvider。 这是因为 OpenTelemetry 跟踪 API 的某些部分会直接合并到 .NET 运行时中。 若要了解详细信息，请参阅 OpenTelemetry .NET 跟踪 API 简介。

// Define an activity source named "ActivitySourceName". This activity source will be used to create activities for all requests to the application.
internal static readonly ActivitySource activitySource = new("ActivitySourceName");

// Create an ASP.NET Core application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry tracer provider to add a source named "ActivitySourceName". This will ensure that all activities created by the activity source are traced.
builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => builder.AddSource("ActivitySourceName"));

// Add the Azure Monitor telemetry service to the application. This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

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

// Map a GET request to the root path ("/") to the specified action.
app.MapGet("/", () =>
{
    // Start a new activity named "CustomActivity". This activity will be traced and the trace data will be sent to Azure Monitor.
    using (var activity = activitySource.StartActivity("CustomActivity"))
    {
        // your code here
    }

    // Return a response message.
    return $"Hello World!";
});

// Start the ASP.NET Core application.
app.Run();

StartActivity 默认为 ActivityKind.Internal，但你可以提供任何其他 ActivityKind。 ActivityKind.Client、ActivityKind.Producer、ActivityKind.Internal 映射到 Application Insights dependencies。 ActivityKind.Server、ActivityKind.Consumer 映射到 Application Insights requests。

使用 Application Insights Classic API 发送自定义遥测数据

建议尽可能使用 OpenTelemetry API，但在某些情况下，可能必须使用 Application Insights Classic API。

事件

  1. 向应用程序添加 Microsoft.ApplicationInsights。

  2. 创建一个 TelemetryClient 实例：

    注意

    务必仅为每个应用程序创建一次 TelemetryClient 实例。

    var telemetryConfiguration = new TelemetryConfiguration { ConnectionString = "" };
var telemetryClient = new TelemetryClient(telemetryConfiguration);

  3. 使用客户端发送自定义遥测数据：

    telemetryClient.TrackEvent("testEvent");

修改遥测

本部分介绍如何修改遥测。

添加范围属性

这些属性可能包括向遥测添加自定义属性。 还可以使用属性来设置 Application Insights 架构中的可选字段，如客户端 IP。

将自定义属性添加到范围

你添加到范围的任何属性都将导出为自定义属性。 它们将填充请求、依赖项、跟踪或异常表中的 customDimensions 字段。

若要添加范围属性，请使用以下两种方法之一：

  • 使用检测库提供的选项。
  • 添加自定义范围处理器。

提示

使用检测库提供的选项（当它们可用时）的优点是整个上下文都可用。 因此，用户可以选择添加或筛选更多属性。 例如，HttpClient 检测库中的扩充选项让用户可以访问 HttpRequestMessage 和 HttpResponseMessage 本身。 他们可以从中选择任何内容并将其存储为属性。

  1. 许多检测库都提供扩充选项。 有关指南，请参阅各个检测库的自述文件：

  2. 使用自定义处理器：

    提示

    添加 Azure Monitor 之前，请添加此处显示的处理器。

    // Create an ASP.NET Core application builder.
var builder = WebApplication.CreateBuilder(args);

// Configure the OpenTelemetry tracer provider to add a new processor named ActivityEnrichingProcessor.
builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => builder.AddProcessor(new ActivityEnrichingProcessor()));

// Add the Azure Monitor telemetry service to the application. This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

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

// Start the ASP.NET Core application.
app.Run();

    使用以下代码将 ActivityEnrichingProcessor.cs 添加到你的项目：

    public class ActivityEnrichingProcessor : BaseProcessor<Activity>
{
    public override void OnEnd(Activity activity)
    {
        // The updated activity will be available to all processors which are called after this processor.
        activity.DisplayName = "Updated-" + activity.DisplayName;
        activity.SetTag("CustomDimension1", "Value1");
        activity.SetTag("CustomDimension2", "Value2");
    }
}

设置用户 IP

可以通过设置范围的属性来填充请求的 client_IP 字段。 Application Insights 使用 IP 地址生成用户位置属性，然后默认放弃它。

使用自定义属性示例，但替换 ActivityEnrichingProcessor.cs 中的以下代码行：

// Add the client IP address to the activity as a tag.
// only applicable in case of activity.Kind == Server
activity.SetTag("client.address", "<IP Address>");

设置用户 ID 或经过身份验证的用户 ID

可以使用以下指导填充请求的 user_Id 或 user_AuthenticatedId 字段。 用户 ID 是匿名用户标识符。 经过身份验证的用户 ID 是已知的用户标识符。

重要

在设置经过身份验证的用户 ID 之前，请参考适用的隐私法律。

使用自定义属性示例：

// Add the user ID to the activity as a tag, but only if the activity is not null.
activity?.SetTag("enduser.id", "<User Id>");

添加日志属性

OpenTelemetry 使用 .NET 的 ILogger。 可以使用消息模板将自定义维度附加到日志。

获取跟踪 ID 或范围 ID

可以使用以下步骤获取当前处于活动状态的范围的 Trace ID 和 Span ID。

注意

System.Diagnostics 命名空间中的 Activity 和 ActivitySource 类分别代表 Span 和 Tracer 的 OpenTelemetry 概念。 这是因为 OpenTelemetry 跟踪 API 的某些部分会直接合并到 .NET 运行时中。 若要了解详细信息，请参阅 OpenTelemetry .NET 跟踪 API 简介。

// Get the current activity.
Activity activity = Activity.Current;
// Get the trace ID of the activity.
string traceId = activity?.TraceId.ToHexString();
// Get the span ID of the activity.
string spanId = activity?.SpanId.ToHexString();

后续步骤