讲师中心 微信公众号
AI工具推荐 视频效率加速

C# ActivitySource和ActivityListener方法 C#如何使用System.Diagnostics.Activity进行分布式追踪

落涛姑娘_2137

落涛姑娘_2137

发布时间:2026-03-11 11:38:03

|

292人浏览过

|

来源于php中文网

原创

ActivitySource 和 ActivityListener 是 .NET 6+ 内置的分布式追踪核心原语,必须通过 ActivitySource.StartActivity() 创建 activity 并检查 null,监听器需注册且 ShouldListenTo 匹配 source 名称与版本,跨进程需手动传播 traceparent。

c# activitysource和activitylistener方法 c#如何使用system.diagnostics.activity进行分布式追踪

ActivitySource 和 ActivityListener 是 .NET 6+ 中实现 OpenTelemetry 兼容分布式追踪的核心原语,不是“可选插件”,而是 System.Diagnostics 内置的轻量级遥测基础设施。直接用它们能绕过 SDK 封装,精准控制 span 生命周期和上下文传播,但必须手动处理采样、导出、上下文注入/提取——不配 ActivitySource 的 Activity 不会触发监听器。

如何创建并启动一个可被监听的 Activity

关键点:必须通过 ActivitySource 创建,不能 new Activity;且需调用 StartActivity() 并检查返回值是否为 null(采样被拒绝时返回 null)。

常见错误是忽略采样结果,对 null 值继续调用 SetTag() 或 Stop(),导致 NullReferenceException。

  • ActivitySource 实例应全局复用(如 static readonly),避免重复注册同名 source
  • 调用 StartActivity() 前,确保已注册 ActivityListener,否则 activity 不会被捕获
  • span 名称建议用稳定字符串(如 "OrderService.ProcessPayment"),避免拼接动态 ID
private static readonly ActivitySource MySource = new("MyCompany.OrderService");

public void ProcessOrder(string orderId)
{
    using var activity = MySource.StartActivity("ProcessOrder", ActivityKind.Server);
    if (activity is null) return; // 被采样器丢弃

    activity.SetTag("order.id", orderId);
    activity.AddEvent(new ActivityEvent("ValidationStarted"));

    try
    {
        // ... 执行业务逻辑
    }
    catch (Exception ex)
    {
        activity.SetStatus(ActivityStatusCode.Error, ex.Message);
        activity.RecordException(ex);
        throw;
    }
}

如何用 ActivityListener 接收并处理跨服务的 Activity

ActivityListener 不是事件订阅器,而是生命周期钩子容器。它只响应由 ActivitySource 创建、且未被采样拒绝的 activity。监听器必须显式启用(ShouldListenTo)并设置回调(ActivityStarted / ActivityStopped)。

容易踩的坑:忘记调用 ActivityListener.Register(),或在 ShouldListenTo 中返回 false 导致完全静默。

C#
C#

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

下载
  • ShouldListenTo 接收 ActivitySource 实例,应比对 Name 和 Version,而非字符串相等(版本可能为 null)
  • ActivityStarted 在 span 开始时触发,此时 Activity.Id 已生成,但 ParentId 可能为空(根 span)
  • ActivityStopped 触发时,Activity.Duration 已填充,适合做耗时统计或导出
var listener = new ActivityListener
{
    ShouldListenTo = src => src.Name == "MyCompany.OrderService",
    ActivityStarted = activity => {
        Console.WriteLine($"Started: {activity.OperationName} ({activity.Id})");
        // 注入 traceparent 到 HTTP header 或消息头
    },
    ActivityStopped = activity => {
        if (activity.Status == ActivityStatusCode.Error)
            LogError(activity);
        // 导出到 Jaeger/Zipkin/OTLP 等后端
    }
};
ActivitySource.AddActivityListener(listener); // 必须注册!

如何传递 TraceContext 跨进程(HTTP/gRPC/消息队列)

.NET 原生不自动传播 context,必须手动注入和提取 traceparent 和 tracestate。依赖 Activity.Current?.Context 获取当前 trace ID、span ID、trace flags;用 ActivityContext.CreateImmutable() 构造传入 context。

典型错误:把 Activity.Id 当作 trace ID 使用(它是 span ID 的 W3C 格式),实际 trace ID 需从 Activity.Context.TraceId 提取。

  • HTTP 客户端调用前:用 propagator.Inject()(推荐 W3CActivityPropagator)写入 traceparent header
  • HTTP 服务端接收后:用 propagator.Extract() 从 header 构造 ActivityContext,再传给 StartActivity(..., parentContext)
  • gRPC 场景下,用 Metadata 替代 header;消息队列需将 trace context 序列化进 message headers 字段
// 客户端注入示例(HttpClient)
using var propagator = new W3CActivityPropagator();
var context = Activity.Current?.Context ?? default;
propagator.Inject(new PropagationContext(context, Baggage.Current), httpRequest,
    (req, key, value) => req.Headers.TryAddWithoutValidation(key, value));

为什么 ActivitySource 没有触发 ActivityListener

最常见原因不是代码写错,而是执行时机或配置缺失:监听器注册晚于 activity 启动、source name 拼写大小写不一致、目标 activity 被采样器拒绝、或运行在 .NET 5 及更早版本(ActivitySource 仅 .NET 6+ 支持)。

调试建议:临时在 ShouldListenTo 里打日志,确认是否被调用;用 Activity.Current 检查当前是否有活跃 activity;用 dotnet-trace CLI 工具采集 runtime trace 验证 activity 是否真正发出。

  • 确保项目 TargetFramework 是 net6.0 或更高
  • 不要在 ActivityListener 回调中阻塞(如同步 HTTP 请求),会拖慢整个请求链路
  • 若使用 OpenTelemetry .NET SDK,它内部已封装 ActivitySource 和 ActivityListener,此时不应再手动注册 listener,否则可能重复导出

真正难的是上下文传播的完整性——比如异步任务切换、线程池回调、Timer 回调中 Activity.Current 会丢失,必须显式传递 ActivityContext 并在新 scope 中重新 StartActivity。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3729

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2468

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1420

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1358

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1436

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2398

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

4000

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

19035

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn