OpenTelemetry .NET SDK 初始化指南：两种方式详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00171/article/details/148577373

OpenTelemetry .NET SDK 初始化指南：两种方式详解

opentelemetry-dotnet The OpenTelemetry .NET Client 项目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-dotnet

前言

OpenTelemetry 作为云原生时代可观测性的标准解决方案，其 .NET 实现为开发者提供了强大的应用监控能力。本文将深入解析 OpenTelemetry .NET SDK 的两种初始化方式，帮助开发者根据应用场景选择最适合的集成方案。

两种初始化方式对比

OpenTelemetry .NET SDK 提供了两种主要初始化方式：

基于主机的初始化：适用于现代 .NET 应用，与 Microsoft 扩展主机深度集成
手动初始化：适用于传统 .NET Framework 应用或需要更细粒度控制的场景

方式一：基于主机的初始化

适用场景

ASP.NET Core 应用
基于通用主机(Generic Host)的控制台应用
后台服务(Worker Service)
任何使用 Microsoft.Extensions.Hosting 的应用

核心优势

与 .NET 依赖注入系统深度集成
自动配置管理
简化的生命周期管理
单管道设计保证一致性

实现步骤

安装必要包：首先需要安装 OpenTelemetry.Extensions.Hosting 包
基础配置示例：

var builder = WebApplication.CreateBuilder(args);

// 清除主机默认添加的日志提供程序
builder.Logging.ClearProviders();

// 初始化OpenTelemetry
builder.Services.AddOpenTelemetry()
    .ConfigureResource(resource => 
        resource.AddService(serviceName: "my-service"))
    .WithLogging(logging => 
        logging.AddConsoleExporter())
    .WithMetrics(metrics => 
        metrics.AddConsoleExporter())
    .WithTracing(tracing => 
        tracing.AddConsoleExporter());

关键说明

AddOpenTelemetry() 是入口点，返回一个构建器对象
ConfigureResource 用于配置所有信号共享的资源信息
WithLogging 会自动注册 OpenTelemetry 的日志提供程序
每个信号(tracing, metrics, logging)可以单独配置

方式二：手动初始化

适用场景

.NET Framework 应用
不使用主机的应用
需要多管道配置的复杂场景
需要精细控制生命周期的场景

版本差异

1.10.0 及以上版本

提供了统一的 OpenTelemetrySdk.Create API：

using OpenTelemetry;

var sdk = OpenTelemetrySdk.Create(builder => builder
    .ConfigureResource(resource => 
        resource.AddService(serviceName: "my-service"))
    .WithLogging(logging => 
        logging.AddConsoleExporter())
    .WithMetrics(metrics => 
        metrics.AddConsoleExporter())
    .WithTracing(tracing => 
        tracing.AddConsoleExporter()));

// 应用关闭时
sdk.Dispose();

特点：

内部创建专用服务集合和提供程序
自动从环境变量创建配置
统一的生命周期管理

1.9.0 及以下版本

需要单独创建各信号提供程序：

using Microsoft.Extensions.Logging;
using OpenTelemetry;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("my-activity-source")
    .AddConsoleExporter()
    .Build();

var meterProvider = Sdk.CreateMeterProviderBuilder()
    .AddMeter("my-meter")
    .AddConsoleExporter()
    .Build();

var loggerFactory = LoggerFactory.Create(builder => builder
    .AddOpenTelemetry(options => 
        options.AddConsoleExporter()));

// 应用关闭时
tracerProvider.Dispose();
meterProvider.Dispose();
loggerFactory.Dispose();