C#如何配置OpenTelemetry .NET应用可观测性配置教程

秋瑶君_7064

秋瑶君_7064

2026-03-03

1125人浏览

原创

C# .NET 应用接入 OpenTelemetry 的核心是三步:引入 SDK、配置 Tracing 和 Metrics、导出到后端(如 Jaeger、Zipkin、OTLP 接收器),需安装 OpenTelemetry 等 NuGet 包,在 Program.cs 中注册服务并设置 Resource、Endpoint 与 Instrumentation,支持手动打点和指标采集。

c#如何配置opentelemetry .net应用可观测性配置教程

在 C# .NET 应用中接入 OpenTelemetry,核心是三步:引入 SDK、配置 Tracing 和 Metrics、导出到后端(如 Jaeger、Zipkin、OTLP 接收器)。不依赖特定云厂商,标准轻量,适合 .NET 6+ 项目。

安装必要 NuGet 包

确保项目使用 .NET 6 或更高版本。在项目文件(.csproj)中添加以下包:

  • OpenTelemetry(基础运行时)
  • OpenTelemetry.Exporter.OpenTelemetryProtocol(推荐 OTLP 协议导出)
  • OpenTelemetry.Instrumentation.AspNetCore(自动采集 HTTP 请求追踪)
  • OpenTelemetry.Instrumentation.Http(自动采集 HttpClient 出站调用)
  • (可选)OpenTelemetry.Instrumentation.SqlClient(SQL Server 调用追踪)

例如通过 CLI 安装:

dotnet add package OpenTelemetry
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
dotnet add package OpenTelemetry.Instrumentation.AspNetCore
dotnet add package OpenTelemetry.Instrumentation.Http

在 Program.cs 中配置 Tracing

.NET 6+ 使用 Minimal Hosting 模型,直接在 Program.cs 中注册 OpenTelemetry 服务:

var builder = WebApplication.CreateBuilder(args);

// 添加 OpenTelemetry Tracing
builder.Services.AddOpenTelemetryTracing(tracerProviderBuilder =>
{
  tracerProviderBuilder
    .AddAspNetCoreInstrumentation() // 自动追踪 MVC/Controller 请求
    .AddHttpClientInstrumentation() // 自动追踪 HttpClient 调用
    .AddSource("MyApp.Diagnostic") // 手动创建 Activity 的命名源(按需)
    .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("my-api"))
    .AddOtlpExporter(opt =>
    {
      opt.Endpoint = new Uri("http://localhost:4317"); // OTLP gRPC 地址
    });
});

var app = builder.Build();

注意:
– AddService 设置服务名,用于在观测平台中区分服务;
– OTLP endpoint 默认是 gRPC(4317),若用 HTTP/JSON 则改用 4318 并设置 opt.Protocol = OtlpExportProtocol.HttpProtobuf;;
– 若本地测试,可先用 otel-collector 或 Jaeger all-in-one 接收数据。

手动添加自定义追踪(Activity)

对关键业务逻辑打点,比如订单处理、缓存操作:

using var activity = MyActivitySource.StartActivity("ProcessOrder", ActivityKind.Internal);
activity?.SetTag("order.id", orderId);
activity?.SetTag("user.id", userId);
try
{
  // 业务逻辑
  activity?.SetStatus(ActivityStatusCode.Ok);
}
catch (Exception ex)
{
  activity?.SetStatus(ActivityStatusCode.Error, ex.Message);
  activity?.RecordException(ex);
  throw;
}

提前定义 ActivitySource(建议静态单例):

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
public static readonly ActivitySource MyActivitySource =
    new ActivitySource("MyApp.Diagnostic");

这样就能在 Jaeger 或 Grafana Tempo 中看到带标签的 Span,并关联异常信息。

启用 Metrics(指标采集)

OpenTelemetry .NET 的 Metrics 支持较新(.NET 6+ 稳定),可用于记录请求计数、延迟直方图等:

builder.Services.AddOpenTelemetryMetrics(metrics =>
{
  metrics
    .AddAspNetCoreInstrumentation() // 自动采集 HTTP 请求次数、延迟等
    .AddMeter("MyApp.Metrics") // 手动上报时用的 Meter 名称
    .AddOtlpExporter(opt => opt.Endpoint = new Uri("http://localhost:4317"));
});

然后在代码中使用:

private static readonly Meter MyMeter = new("MyApp.Metrics");
private static readonly Counter RequestCounter = MyMeter.CreateCounter("app.requests.count");

RequestCounter.Add(1, new("endpoint", "/api/orders"));

目前 .NET 的 Metrics 导出默认为 OTLP,Prometheus 需配合 otel-collector 做格式转换。

基本上就这些。配置不复杂但容易忽略 Resource、Endpoint、Instrumentation 启用顺序。上线前建议先本地连 Jaeger 验证 Span 是否生成,再逐步加 Metrics 和日志(Logs 可通过 OpenTelemetry.Extensions.Logging 补充)。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1092

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3191

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

905

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

332

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习