为 Azure Monitor OpenTelemetry 配置自动数据收集和资源检测器

请求

• ASP.NET Core

依赖

• HttpClient ¹²
• SqlClient ¹
• Azure SDK

日志记录

• ILogger

若要减少或增加发送到 Azure Monitor 的日志数，请配置日志记录以设置相应的日志级别或应用筛选器。 例如，您可以选择仅将 Warning 和 Error 日志发送到 OpenTelemetry/Azure Monitor。 OpenTelemetry 不负责控制日志路由或筛选——这些决策由您的 ILogger 配置来决定。 有关配置 ILogger的详细信息，请参阅 “配置日志记录”。

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

Azure监视器导出程序不包含任何检测库。

可以使用以下代码示例从 Azure 软件开发工具包（SDK） 收集依赖项，以手动订阅源。

// Create an OpenTelemetry tracer provider builder.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
	// The following line subscribes to dependencies emitted from Azure SDKs
    .AddSource("Azure.*")
    .AddAzureMonitorTraceExporter()
    .AddHttpClientInstrumentation(o => o.FilterHttpRequestMessage = (_) =>
	{
    	// Azure SDKs create their own client span before calling the service using HttpClient
		// In this case, we would see two spans corresponding to the same operation
		// 1) created by Azure SDK 2) created by HttpClient
		// To prevent this duplication we are filtering the span from HttpClient
		// as span from Azure SDK contains all relevant information needed.
		var parentActivity = Activity.Current?.Parent;
		if (parentActivity != null && parentActivity.Source.Name.Equals("Azure.Core.Http"))
		{
		    return false;
		}
		return true;
	})
    .Build();

若要减少或增加发送到 Azure Monitor 的日志数，请配置日志记录以设置相应的日志级别或应用筛选器。 例如，您可以选择仅将 Warning 和 Error 日志发送到 OpenTelemetry/Azure Monitor。 OpenTelemetry 不负责控制日志路由或筛选——这些决策由您的 ILogger 配置来决定。 有关配置 ILogger的详细信息，请参阅 “配置日志记录”。

请求

• Java 消息服务 （JMS） 使用者
• Kafka 使用者
• Netty
• 石英
• RabbitMQ
• Servlet
• 春季日程安排

依赖项（加上下游分布式跟踪传播）

• Apache HttpClient
• Apache HttpAsyncClient
• AsyncHttpClient
• Google HttpClient
• gRPC
• java.net.HttpURLConnection
• Java 11 HttpClient
• JAX-RS 客户端
• Jetty HttpClient (Jetty HTTP客户端)
• Java 消息服务 (JMS)
• Kafka
• Netty 客户端
• OkHttp
• RabbitMQ

依赖项（没有下游分布式跟踪传播）

• 支持 Cassandra
• 支持 Java 数据库连接 （JDBC）
• 支持 MongoDB （异步和同步）
• 支持 Redis （Lettuce 和 Jedis）

指标

• Micrometer 指标，包括 Spring Boot Actuator 指标
• Java 管理扩展 （JMX） 指标

日志

• Logback（包含 MDC 属性） ¹
• Log4j（包括 MDC/线程上下文属性） ¹
• JBoss 日志记录功能（包括 MDC 属性） ¹
• java.util.logging ¹

若要减少或增加 Azure Monitor 收集的日志数，请先在应用程序的日志记录库中设置所需的日志记录级别（例如 WARNING 或 ERROR）。

默认集合

默认情况下，会自动收集以下Azure SDK 发出的遥测数据：

• Azure 应用配置 1.1.10+
• Azure AI 搜索 11.3.0+
• Azure Communication Chat 1.0.0+
• Azure Communication Common 1.0.0+
• Azure 通信标识(版本 1.0.0+)
• Azure通信电话号码 1.0.0+
• Azure通信短信（短信服务） 1.0.0+
• Azure Cosmos DB 4.22.0+
• Azure 数字孪生 - 核心 1.1.0+
• Azure 事件网格 4.0.0+
• Azure 事件中心 5.6.0+
• Azure 事件中心-Azure Blob 存储检查点存储 1.5.1+
• Azure AI 文档智能 3.0.6+
• Azure 身份验证 1.2.4+
• Azure Key Vault - 证书 4.1.6+
• Azure Key Vault - 密钥 4.2.6+
• Azure Key Vault - 机密信息 4.2.6+
• Azure 服务总线 7.1.0+
• Azure 存储 - Blob 存储 12.11.0+
• Azure 存储 - Blob 批处理 12.9.0+
• Azure 存储服务 - Blob 加密技术 12.11.0+
• Azure 存储 - 通用 12.11.0+
• Azure 存储 - 文件数据湖 12.5.0+
• Azure Storage - 文件共享 12.9.0+
• Azure 存储 - 队列 12.9.0+
• Azure 文本分析 5.0.4+

[//]: # "Azure Cosmos DB 4.22.0+ due to https://github.com/Azure/azure-sdk-for-java/pull/25571"
[//]: # "the remaining above names and links scraped from https://azure.github.io/azure-sdk/releases/latest/java.html"
[//]: # "and version synched manually against the oldest version in maven central built on azure-core 1.14.0"
[//]: # ""
[//]: # "var table = document.querySelector('#tg-sb-content > div > table')"
[//]: # "var str = ''"
[//]: # "for (var i = 1, row; row = table.rows[i]; i++) {"
[//]: # "  var name = row.cells[0].getElementsByTagName('div')[0].textContent.trim()"
[//]: # "  var stableRow = row.cells[1]"
[//]: # "  var versionBadge = stableRow.querySelector('.badge')"
[//]: # "  if (!versionBadge) {"
[//]: # "    continue"
[//]: # "  }"
[//]: # "  var version = versionBadge.textContent.trim()"
[//]: # "  var link = stableRow.querySelectorAll('a')[2].href"
[//]: # "  str += '* [' + name + '](' + link + ') ' + version + '\n'"
[//]: # "}"
[//]: # "console.log(str)"

Spring Boot 原生应用程序的请求

• Spring Web
• Spring Web MVC（模型-View-Controller）
• Spring WebFlux

Spring Boot 本机应用程序的依赖项

• JDBC
• R2DBC
• MongoDB
• Kafka
• Azure SDK

指标

• Micrometer 指标

Spring Boot 本机应用程序的日志

• Logback

若要减少或增加 Azure Monitor 收集的日志数，请先在应用程序的日志记录库中设置所需的日志记录级别（例如 WARNING 或 ERROR）。

有关 Quartz 原生应用程序，请查看 Quarkus 文档。

以下 OpenTelemetry Instrumentation 库包含在 Azure Monitor Application Insights 发行版中。 有关详细信息，请参阅 Azure SDK for JavaScript。

请求

• HTTP/HTTPS²

依赖

• 支持 MongoDB
• 支持 MySQL
• 支持 Postgres
• 支持 Redis
• 支持 Redis-4
• 支持 Azure SDK

日志

• 班扬
• 温斯顿

若要减少或增加 Azure Monitor 收集的日志数，请先在应用程序的日志记录库中设置所需的日志记录级别（例如 WARNING 或 ERROR）。

可以使用 AzureMonitorOpenTelemetryOptions 配置检测：

export class BunyanInstrumentationSample {
  static async run() {
    // Dynamically import Azure Monitor and Bunyan
    const { useAzureMonitor } = await import("@azure/monitor-opentelemetry");
    const bunyanMod = await import("bunyan");
    const bunyan = (bunyanMod as any).default ?? bunyanMod;

    // Enable Azure Monitor integration and bunyan instrumentation
    const options = {
      instrumentationOptions: {
        bunyan: { enabled: true },
      },
    };

    const monitor = useAzureMonitor(options);

    // Emit a test log entry
    const log = (bunyan as any).createLogger({ name: "testApp" });
    log.info(
      {
        testAttribute1: "testValue1",
        testAttribute2: "testValue2",
        testAttribute3: "testValue3",
      },
      "testEvent"
    );

    console.log("Bunyan log emitted");
  }
}

请求

• Django ¹
• FastApi ¹
• Flask ¹

依赖

• Psycopg2
• 请求 ¹
• Urllib ¹
• Urllib3 ¹

日志

• Python 日志记录库

若要减少或增加 Azure Monitor 收集的日志数，请先在应用程序的日志记录库中设置所需的日志记录级别（例如 WARNING 或 ERROR）。

可以在 GitHub 上找到使用 Python 日志记录库的示例。

默认情况下，会自动 收集 Azure 软件开发工具包（SDK）发出的遥测数据。

若要添加社区库，请在为库添加 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();

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

// Create a new OpenTelemetry meter provider and add runtime instrumentation and the Azure Monitor metric exporter.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddRuntimeInstrumentation()
    .AddAzureMonitorMetricExporter();

不能使用社区检测库来扩展 Java 发行版。 若要请求我们包括另一个检测库，请在GitHub页面上提出问题。 可以在 后续步骤中找到指向 GitHub 页面的链接。

不能将社区检测库与 GraalVM Java 原生应用程序一起使用。

export class RegisterExpressInstrumentationSample {
  static async run() {
    // Dynamically import Azure Monitor and Express instrumentation
    const { useAzureMonitor } = await import("@azure/monitor-opentelemetry");
    const { registerInstrumentations } = await import("@opentelemetry/instrumentation");
    const { ExpressInstrumentation } = await import("@opentelemetry/instrumentation-express");

    // Initialize Azure Monitor (uses env var if set)
    const monitor = useAzureMonitor();

    // Register the Express instrumentation
    registerInstrumentations({
      instrumentations: [new ExpressInstrumentation()],
    });

    console.log("Express instrumentation registered");
  }
}

若要添加社区仪器库（Azure Monitor 发行版中未正式支持/包含），可以直接使用该仪器进行监测。 可在 此处找到社区检测库的列表。

# Import the `configure_azure_monitor()`, `SQLAlchemyInstrumentor`, `create_engine`, and `text` functions from the appropriate packages.
from azure.monitor.opentelemetry import configure_azure_monitor
from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
from sqlalchemy import create_engine, text

# Configure OpenTelemetry to use Azure Monitor.
configure_azure_monitor()

# Create a SQLAlchemy engine.
engine = create_engine("sqlite:///:memory:")

# SQLAlchemy instrumentation is not officially supported by this package, however, you can use the OpenTelemetry `instrument()` method manually in conjunction with `configure_azure_monitor()`.
SQLAlchemyInstrumentor().instrument(
    engine=engine,
)

# Database calls using the SQLAlchemy library will be automatically captured.
with engine.connect() as conn:
    result = conn.execute(text("select 'hello world'"))
    print(result.all())

• 若要进一步配置 OpenTelemetry 发行版，请参阅 Azure Monitor OpenTelemetry 配置。
• 若要查看源代码，请参阅 Azure Monitor AspNetCore GitHub 存储库。
• 若要安装 NuGet 包、检查更新或查看发行说明，请访问Azure Monitor AspNetCore NuGet 包页面。
• 若要更熟悉 Azure Monitor 和 OpenTelemetry，请参阅 Azure Monitor 示例应用程序。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry .NET GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。

• 若要进一步配置 OpenTelemetry 发行版，请参阅 Azure Monitor OpenTelemetry 配置
• 若要查看源代码，请参阅 Azure Monitor 导出程序 GitHub 存储库。
• 若要安装 NuGet 包、检查更新或查看发行说明，请参阅 Azure Monitor 导出程序 NuGet 包 页。
• 若要更熟悉 Azure Monitor 和 OpenTelemetry，请参阅 Azure Monitor 示例应用程序。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry .NET GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。

• 若要查看配置选项，请参阅 Java 自动检测配置选项。
• 若要查看源代码，请参阅 Azure Monitor Java 自动检测 GitHub 存储库。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry Java GitHub 存储库。
• 若要启用使用体验，请参阅 “启用 Web 或浏览器用户监视”。
• 若要查看发行说明，请参阅 GitHub 上的 发行说明 。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。

• 若要查看源代码，请参阅 Spring Boot 原生映像 Java 应用程序中的 Azure Monitor OpenTelemetry 发行版 和 Quarkus OpenTelemetry Exporter for Azure。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry Java GitHub 存储库。
• 若要查看发行说明，请参阅 GitHub 上的 发行说明 。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。

• 若要查看源代码，请参阅 Azure Monitor OpenTelemetry GitHub 存储库。
• 若要安装 npm 包并检查更新，请参阅 @azure/monitor-opentelemetry npm 包页面。
• 若要更熟悉 Azure Monitor Application Insights 和 OpenTelemetry，请参阅 Azure Monitor 示例应用程序。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry JavaScript GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。

• 若要查看源代码和额外文档，请参阅 Azure Monitor Distro GitHub 存储库。
• 若要查看额外的示例和用例，请参阅 Azure Monitor 发行版示例。
• 若要查看发行说明，请参阅 GitHub 上的 发行说明 。
• 若要安装 PyPI 包、检查更新或查看发行说明，请参阅 Azure Monitor Distro PyPI 包页面。
• 若要更熟悉 Azure Monitor Application Insights 和 OpenTelemetry，请参阅 Azure Monitor 示例应用程序。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry Python GitHub 存储库。
• 若要查看可用的 OpenTelemetry 检测和组件，请参阅 OpenTelemetry 参与者 Python GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。
• 若要查看常见问题解答、故障排除步骤、支持选项或提供 OpenTelemetry 反馈，请参阅适用于 Azure Monitor Application Insights 的 OpenTelemetry 帮助、支持和反馈。