CloudYxt.OpenTelemetry 1.1.0

CloudYxt .Net Core针对OpenTelemetry常规操作库

appsettings.json的最精简配置(配置目标和数据流)

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "OpenTelemetry": {    
    "Exporter": {
      "Endpoint": "http://xxxx/api/default",
      "Authorization": "Basic 认证BASE64",
      "StreamName": "数据流名称"
    }
  }
}

appsettings.json的完整配置方法

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "OpenTelemetry": {
    "Enabled": true,

    //服务名称和版本
    "Service": {      
      "Name": "CloudYxt.OpenTelemetry.Debug",   //未配置时自动取程序集名称
      "Version": "1.0.0",                       //未配置时自动取程序集版本号
      "Environment": "Production"               //可选
    },

    //扩展字段
    "ResourceAttributes": {
      "company": "xxx",
      "department": "部门",
      "system": ""
    },

    "Exporter": {
      "Endpoint": "http://xxxx/api/default",
      "Authorization": "Basic 认证BASE64",
      "StreamName": "数据流名称"
    },

    // 注意：未配置时默认为"Enabled": true
    "Logging": {
      "Enabled": true
    },

    // 注意：未配置时默认为"Enabled": false
    "Metrics": {
      "Enabled": true,
      "Runtime": true,
      "AspNetCore": true,
      "HttpClient": true
    },

    // 注意：未配置时默认为"Enabled": false
    "Tracing": {
      "Enabled": true,
      "AspNetCore": true,
      "HttpClient": true,
      "Sampling": 1.0
    }
  }
}

如果是 Web API

var builder = WebApplication.CreateBuilder(args);

// 添加日志
builder.Logging.AddOpenTelemetryLoggingExtensions(builder.Configuration);

// 使用无扩展字段
builder.Services.AddOpenTelemetryExtensions(builder.Configuration);
// 或
// 使用自定义扩展字段
builder.Services.AddOpenTelemetryExtensions(builder.Configuration, new Dictionary<string, string>
{
    ["application_role"] = "i'am a webapi"
});

builder.Services.AddControllers();

var app = builder.Build();

app.MapControllers();

app.Run();

如果是 Worker Service

在Program.cs中定义

var builder = Host.CreateApplicationBuilder(args);

// 添加日志
builder.Logging.AddOpenTelemetryLoggingExtensions(builder.Configuration);

// 使用无扩展字段
builder.Services.AddOpenTelemetryExtensions(builder.Configuration);
// 或
// 使用自定义扩展字段
builder.Services.AddOpenTelemetryExtensions(builder.Configuration, new Dictionary<string, string>
{
    ["application_role"] = "i'am a worker"
    ["host_ip"] = NetworkHelper.GetLocalIPv4()
});

var host = builder.Build();

await host.RunAsync();

日志方法扩展

// 将一个对象格式化为字符串
_logger.LogInformation("result is {json_result}", json.ToLogJson());

获取本机IPv4地址

// 获取本机首选IPv4地址
NetworkHelper.GetLocalIPv4()
// 获取本机全部IPv4地址
NetworkHelper.GetLocalIPv4All()