MoneyTree.Telemetry 可观测性

📋 概述

MoneyTree.Telemetry 基于 OpenTelemetry SDK 薄封装，提供开箱即用的可观测性能力，涵盖 Traces（分布式追踪）、Metrics（指标采集）、Logs（结构化日志）三大支柱，并自动注入 TenantId、UserId、CorrelationId 等业务上下文。

🏗️ 项目文件结构

MoneyTree.Telemetry/
├── MoneyTree.Telemetry.csproj
├── GlobalUsings.cs
├── Abstractions/
│   └── ITelemetryProvider.cs               # 遥测提供者接口
├── Core/
│   ├── TelemetryOptions.cs                 # 遥测配置选项
│   └── TelemetryDefaults.cs               # 遥测默认配置
├── Exporters/
│   ├── ConsoleTelemetryExporter.cs         # 控制台导出器
│   ├── JaegerTelemetryExporter.cs          # Jaeger 导出器
│   └── OpenTelemetryCollectorExporter.cs   # OTel Collector 导出器
├── Enrichers/
│   ├── TenantIdEnricher.cs                 # 租户 ID 增强器
│   ├── CorrelationIdEnricher.cs            # 关联 ID 增强器
│   └── ServiceInfoEnricher.cs              # 服务信息增强器
├── Instrumentation/
│   ├── AspNetCoreInstrumentation.cs        # ASP.NET Core 仪表
│   ├── EFCoreInstrumentation.cs            # EF Core 仪表
│   ├── HttpClientInstrumentation.cs        # HttpClient 仪表
│   └── CacheInstrumentation.cs            # 缓存仪表
├── Middleware/
│   └── TelemetryMiddleware.cs              # 遥测中间件
└── Extensions/
    ├── TelemetryBuilder.cs                 # 流畅配置构造器
    └── TelemetryExtensions.cs             # DI 注册扩展

📊 三大支柱

📤 导出器

🚀 快速开始

基础配置

// Program.cs
using MoneyTree.Telemetry.Extensions;

var builder = WebApplication.CreateBuilder(args);

builder.Services.ConfigureMoneyTreeTelemetry(t =>
{
    t.WithServiceName("OrderService")
     .WithServiceVersion("2.0.0")
     .WithEnvironment("Production")
     .UseConsole()
     .UseOpenTelemetryCollector("http://otel-collector:4317")
     .WithTenantEnricher()
     .WithCorrelationIdEnricher()
     .WithSampleRate(0.5);
});

var app = builder.Build();
app.UseMoneyTreeTelemetry();
app.Run();

生产环境配置

builder.Services.ConfigureMoneyTreeTelemetry(t =>
{
    t.WithServiceName("OrderService")
     .WithEnvironment("Production")
     .UseOpenTelemetryCollector()
     .WithTenantEnricher()
     .WithSensitivePaths("/api/auth/", "/api/payment/card");
});

📈 自动仪表

🏷️ 上下文增强器

增强器自动为所有遥测数据附加业务上下文：

🔒 生产安全

敏感路径屏蔽

t.WithSensitivePaths(
    "/api/auth/login",
    "/api/auth/register",
    "/api/payment/card"
);

命中路径的 DisplayName、http.target、http.route、url.path 全部替换为 SENSITIVE_PATH。

SensitiveDataProcessor（自动脱敏）

框架内置 BaseProcessor<Activity> 在 Span 导出前自动处理以下脱敏：

可通过 Builder API 扩展：

t.WithSensitiveHeaders("X-Custom-Token")
 .WithSensitiveQueryParams("custom_secret");

网络层防护（运维）