ISC.OpenTelemetryExtension 1.1.7

Hướng Dẫn Sử Dụng ISC.OpentelemetryExtension

1️⃣ Giới Thiệu

ISC.OpentelemetryExtension là một thư viện giúp tích hợp OpenTelemetry vào ứng dụng .NET một cách dễ dàng. Thư viện hỗ trợ:

• Cấu hình TracerProviderBuilder một cách linh hoạt.
• Cung cấp sẵn các instrumentation phổ biến.
• Cho phép bổ sung instrumentation đặc thù.

2️⃣ Cài Đặt

Thêm package vào dự án:

 dotnet add package ISC.OpentelemetryExtension

3️⃣ Cách Gọi Code Từ Program.cs

Trong Program.cs, gọi phương thức AddTracing để cấu hình tracing:

using ISC.OpentelemetryExtension;
using OpenTelemetry.Trace;

var builder = WebApplication.CreateBuilder(args);

// Đăng ký OpenTelemetry Tracing
builder.Services.AddTracing(
    serviceName: "TenPhongBan-TenDuAn",
    exporterEndpoint: "http://otel-collector:4317",
    enviroment: "Development" //Nếu không truyền sẽ tự động lấy môi trường hiện tại của instance    
);

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

Lưu ý: TracingService.Configure là phương thức mặc định của thư viện để tự động cấu hình tracing.

4️⃣ Tuỳ Chỉnh TracerProviderBuilder

Nếu cần cấu hình TracerProviderBuilder theo nhu cầu, bạn có thể cung cấp một delegate vào AddTracing:

builder.Services.AddTracing(
    serviceName: "MyCustomService",
    exporterEndpoint: "http://otel-collector:4317",
    configureTracing: builder =>
    {
        builder.SetSampler(new AlwaysOnSampler()); // Ghi lại toàn bộ dữ liệu
    }
);

Mẹo: Bạn có thể thay đổi SetSampler(new TraceIdRatioBasedSampler(0.5f)) để lấy 50% lượng dữ liệu thay vì toàn bộ.

5️⃣ Bổ Sung Instrumentation Đặc Thù

Nếu bạn muốn bổ sung các instrumentation đặc thù ngoài Program.cs, có thể dùng tham số extendInstrumentation:

builder.Services.AddTracing(
    serviceName: "MyAdvancedService",
    exporterEndpoint: "http://otel-collector:4317",
    configureTracing: TracingService.Configure,
    extendInstrumentation: builder =>
    {
        builder.AddMongoDBInstrumentation(); // Thêm MongoDB Instrumentation
    }
);

Nếu bạn muốn bật/tắt các Instrumentation chỉ cần cấu hình appsettings.json của bạn như sau:

{
  "Tracing": {
    "EnableMySql": true
  }
}

Ví dụ, nếu bạn cần logging thời gian mở connection và thực thi query SQL:

builder.Services.AddTracing(
    serviceName: "MySQLService",
    exporterEndpoint: "http://otel-collector:4317",
    configureTracing: builder =>
    {
        builder.AddSqlClientInstrumentation(opt =>
        {
            opt.SetDbStatementForText = true; // Ghi lại truy vấn SQL
            opt.RecordException = true; // Ghi lại lỗi
        });
    }
);

6️⃣ Kết Luận

• Dùng AddTracing để dễ dàng tích hợp OpenTelemetry vào Program.cs.
• Tuỳ chỉnh TracerProviderBuilder để thay đổi sampler, thêm instrumentation.
• Bổ sung instrumentation đặc thù bằng tham số extendInstrumentation.

Nếu có câu hỏi, hãy liên hệ đội phát triển ISC.OpentelemetryExtension! 🚀