ASP.NET Extensions 日志采样功能命名优化

在 ASP.NET Extensions 项目中，开发团队最近对日志采样功能进行了一次重要的命名优化。本文将详细介绍这次变更的背景、具体内容以及技术考量。

背景与动机

日志采样是分布式系统中常见的性能优化手段，它通过概率性地选择部分日志进行记录，既能保留关键信息，又能减轻系统负担。在 ASP.NET Extensions 项目中，原本计划使用"ProbabilisticSampler"作为采样器的命名，但在进一步评估后发现这个名称可能与 OpenTelemetry .NET API 中的术语产生冲突。

经过深入讨论，团队决定将相关命名从"Probabilistic"调整为"RandomProbabilistic"，以更准确地表达其功能特性，同时避免潜在的命名冲突。

API 变更详情

这次变更主要涉及以下几个核心类和方法的命名调整：

1. 日志构建器扩展方法：

   • 原方法：AddProbabilisticSampler
   • 新方法：AddRandomProbabilisticSampler

2. 配置选项类：

   • 原类名：ProbabilisticSamplerOptions
   • 新类名：RandomProbabilisticSamplerOptions

3. 过滤规则类：

   • 原类名：ProbabilisticSamplerFilterRule
   • 新类名：RandomProbabilisticSamplerFilterRule

技术考量

在命名讨论过程中，团队考虑了多个备选方案：

1. RandomSampler：虽然简洁，但可能过于通用，无法充分表达其概率特性
2. StochasticSampler：学术性较强，可能增加理解难度
3. UniformRandomSampler：强调了均匀分布特性，但略显冗长
4. LinearRandomSampler：可能误导开发者认为采样是线性的

最终选择"RandomProbabilistic"作为前缀，既保留了概率采样的核心概念，又通过"Random"强调了其随机性特征，同时与 OpenTelemetry 中的"Consistent Probability Sampling"形成明确区分。

使用示例

变更后的 API 使用方式与之前类似，只是名称发生了变化：

// 旧用法
// loggingBuilder.AddProbabilisticSampler(0.1, LogLevel.Information);

// 新用法
loggingBuilder.AddRandomProbabilisticSampler(0.1, LogLevel.Information);

影响评估

这次变更属于纯命名优化，不会影响现有功能逻辑。由于相关 API 是新增功能，不会对已有代码产生兼容性问题。变更的主要目的是：

1. 提高命名的准确性
2. 避免与 OpenTelemetry 术语冲突
3. 为未来可能的扩展保留命名空间

总结

ASP.NET Extensions 团队通过这次命名优化，展示了其对 API 设计严谨性的重视。在分布式系统日益复杂的今天，清晰的术语定义和避免命名冲突对于开发者体验至关重要。这次变更虽然看似微小，但体现了团队对长期维护性和开发者友好性的考量。