0

0

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

幻夢星雲

幻夢星雲

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

|

252人浏览过

|

来源于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 生命周期和上下文传播,但必须手动处理采样、导出、上下文注入/提取——不配 ActivitySourceActivity 不会触发监听器。

如何创建并启动一个可被监听的 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 导致完全静默。

Moshi Chat
Moshi Chat

法国AI实验室Kyutai推出的端到端实时多模态AI语音模型,具备听、说、看的能力,不仅可以实时收听,还能进行自然对话。

下载
  • ShouldListenTo 接收 ActivitySource 实例,应比对 NameVersion,而非字符串相等(版本可能为 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,必须手动注入和提取 traceparenttracestate。依赖 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,它内部已封装 ActivitySourceActivityListener,此时不应再手动注册 listener,否则可能重复导出

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是分布式
什么是分布式

分布式是一种计算和数据处理的方式,将计算任务或数据分散到多个计算机或节点中进行处理。本专题为大家提供分布式相关的文章、下载、课程内容,供大家免费下载体验。

404

2023.08.11

分布式和微服务的区别
分布式和微服务的区别

分布式和微服务的区别在定义和概念、设计思想、粒度和复杂性、服务边界和自治性、技术栈和部署方式等。本专题为大家提供分布式和微服务相关的文章、下载、课程内容,供大家免费下载体验。

251

2023.10.07

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1565

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

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

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

3

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 11.1万人学习

C 教程
C 教程

共75课时 | 5.3万人学习

C++教程
C++教程

共115课时 | 21.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号