.net core-利用OpenObserve 实现OpenTelemetry可观测性标准（Logs，Traces，Metrics）

1. 什么是 OpenObserve？

• OpenObserve 是一个开源的可观测性平台（支持日志、指标、追踪），旨在成为 Elasticsearch/Datadog 的轻量级替代方案。
  
• 它支持通过 OpenTelemetry（OTLP）协议接收数据。
  

2. 搭建 OpenObserve

• docker 本地运行或部署 OpenObserve（参考 官方文档）：
  
• docker run -d --name openobserve -p 5080:5080 -e ZO_ROOT_USER_EMAIL="root@example.com" -e ZO_ROOT_USER_PASSWORD="root123" public.ecr.aws/zinclabs/openobserve:latest
  
• 访问 http://localhost:5080（默认账号：root@example.com，密码：root123）。
  

3. .NET Core 的 OpenTelemetry 配置

• 安装必要的 NuGet 包：
  
  
  
  
  
  
  

4. 在 .NET Core 中配置 OpenTelemetry

1. var builder = WebApplication.CreateBuilder(args);<br>//base
2. var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes("root@example.com:root123"));
3. // 配置OpenTelemetry 日志Log
4. builder.Logging.ClearProviders();
6. var resourceBuilder = ResourceBuilder.CreateDefault()
7.     .AddService("xxxapi")
8.     .AddAttributes(new Dictionary<string, object>
9.     {
10.         ["environment"] = "development",
11.         ["service.version"] = "1.0.0"
12.     });
14. builder.Logging.AddOpenTelemetry(logging => {
15.     logging.IncludeFormattedMessage = true;
16.     logging.SetResourceBuilder(resourceBuilder)
17.         .AddConsoleExporter()  // Keep console logging for debugging
18.         .AddOtlpExporter(otlpOptions => {
19.             otlpOptions.BatchExportProcessorOptions = new BatchExportProcessorOptions
20.             {
21.                 MaxQueueSize = 100,        // 减小队列避免堆积
22.                 MaxExportBatchSize = 10,   // 减小批量大小
23.                 ScheduledDelayMilliseconds = 500, // 更频繁导出
24.             };
25.             otlpOptions.Endpoint = new Uri("http://localhost:5080/api/default/v1/logs");
26.             otlpOptions.Headers = $"Authorization=Basic {credentials}";
27.             otlpOptions.Protocol = OpenTelemetry.Exporter.OtlpExportProtocol.HttpProtobuf;
28.         });
29. });
31. // Add services to the container.
32. builder.Services.AddControllers();
33. builder.Services.AddEndpointsApiExplorer();
34. builder.Services.AddSwaggerGen(c =>
35. {
36.     c.SwaggerDoc("v1", new OpenApiInfo { Title = "xxx API", Version = "v1" });
37. });
38. builder.Services.AddHttpClient();
40. // 配置 OpenTelemetry 追踪Tracing
41. builder.Services.AddOpenTelemetry()
42.     .WithTracing(builder => builder
43.         .SetResourceBuilder(resourceBuilder)
44.         .AddSource("xxxapi")
45.         .AddAspNetCoreInstrumentation()
46.         .AddHttpClientInstrumentation()
47.         .AddOtlpExporter(opts =>
48.         {
49.             opts.Endpoint = new Uri("http://localhost:5080/api/default/v1/traces");
50.             opts.Headers = $"Authorization=Basic {credentials}";
51.             opts.Protocol = OpenTelemetry.Exporter.OtlpExportProtocol.HttpProtobuf;
52.         }));
54. var app = builder.Build();
55.       
56. // Configure the HTTP request pipeline.
57. if (app.Environment.IsDevelopment())
58. {
59.     app.UseSwagger();
60.     app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "xxx API v1"));
61. }
63. app.UseHttpsRedirection();
64. app.UseAuthorization();
65. app.MapControllers();
67. app.Run();

复制代码

5. 关键细节

• OTLP 端点：OpenObserve 使用 /api/default/接收 OTLP 数据。
  
• 认证：默认使用基本认证（账号 root@example.com，密码 root123）。需将凭据编码为 Base64：
  1. // 将 "root@example.com:root123" 转为 Base64
  2. var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes("root@example.com:root123"));
  3. opt.Headers = $"Authorization=Basic {credentials}";

  复制代码
• 数据类型：上述配置会向 OpenObserve 发送追踪（Traces）、指标（Metrics）和日志（Logs）。
  

6. 在 OpenObserve 中验证数据

• 访问 http://localhost:5080：
  
  
  
  • 日志：在 Logs Explorer 中查看。
    
  • 
    
     
    
  • 追踪：在 Traces Explorer 中查看。
    
  • 
    
     
    
  • 指标：在 Metrics Explorer 中查看。
    
  • 
    
     
    
  
  

7. 故障排除

• 确保 OpenObserve 正在运行。
  
• 检查 OTLP 端点和认证头是否正确。
  
• 启用 OpenTelemetry 的诊断输出（调试用）：
       logging.AddConsoleExporter() //将日志数据输出到控制台
       tracing.AddConsoleExporter() //将追踪数据输出到控制台
  1.  

  复制代码

更多参考：

• OpenObserve 文档
  
• OpenTelemetry .NET 文档
  
• https://github.com/openobserve/dotnet-opentelemetry-tracing-application.git
  

 

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！