Opentelemetry C# (Geliştiriciler İçin Nasıl Çalışır)

Gerekli Paketleri Ekleme

İlk olarak, projenize gerekli OpenTelemetry paketlerini ekleyin. Terminalinizi açın ve proje dizininize gidin. Sonra, aşağıdaki paketleri NuGet Paket Yöneticisi CLI kullanarak yükleyin:

dotnet add package OpenTelemetry -Version <version>
dotnet add package OpenTelemetry.Extensions.Hosting -Version <version>
dotnet add package OpenTelemetry.Instrumentation.AspNetCore -Version <version>
dotnet add package OpenTelemetry.Exporter.Console -Version <version>

dotnet add package OpenTelemetry -Version <version>
dotnet add package OpenTelemetry.Extensions.Hosting -Version <version>
dotnet add package OpenTelemetry.Instrumentation.AspNetCore -Version <version>
dotnet add package OpenTelemetry.Exporter.Console -Version <version>

ile her paketin en son sürümünü değiştirin.

OpenTelemetry'yi Uygulamanızda Yapılandırma

Gerekli paketleri ekledikten sonra, OpenTelemetry'yi uygulamanızda yapılandırmanız gerekiyor. Bu, OpenTelemetry SDK'sını kurmayı ve hangi telemetri verisini toplayacağını belirtmeyi içerir. OpenTelemetry, .NET uygulamalarıyla sorunsuz bir entegrasyon için enstrümantasyon kütüphaneleri sunar.

Projenizde Startup.cs dosyanızı açın ve aşağıdaki kod parçacığında gösterildiği gibi ConfigureServices yöntemini OpenTelemetry'yi eklemek için değiştirin:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddOpenTelemetryTracing(builder =>
    {
        builder.AddAspNetCoreInstrumentation()
               .AddHttpClientInstrumentation()
               .AddConsoleExporter();
    });
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddOpenTelemetryTracing(builder =>
    {
        builder.AddAspNetCoreInstrumentation()
               .AddHttpClientInstrumentation()
               .AddConsoleExporter();
    });
}

Public Sub ConfigureServices(ByVal services As IServiceCollection)
	services.AddControllers()
	services.AddOpenTelemetryTracing(Sub(builder)
		builder.AddAspNetCoreInstrumentation().AddHttpClientInstrumentation().AddConsoleExporter()
	End Sub)
End Sub

Bu kod parçacığı, ASP.NET Core uygulamalarından ve HTTP istemci çağrılarından telemetri verilerini toplamak ve ardından bu verileri konsola aktarmak için OpenTelemetry'yi nasıl yapılandıracağınızı gösterir. AddAspNetCoreInstrumentation yöntemi, ASP.NET Core uygulamalarına gelen HTTP istekleri için otomatik olarak enstrümantasyonu etkinleştirir.

Metrikleri Toplama

Metrik toplamak için ayrıca, izleme yerine metriklere odaklanarak OpenTelemetry Metrikler API'si yapılandırmanız gerekecek.

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddOpenTelemetryMetrics(builder =>
    {
        builder.AddAspNetCoreInstrumentation()
               .AddHttpClientInstrumentation()
               .AddConsoleExporter(options => options.Targets = ConsoleExporterOutputTargets.Console);
    });
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddOpenTelemetryMetrics(builder =>
    {
        builder.AddAspNetCoreInstrumentation()
               .AddHttpClientInstrumentation()
               .AddConsoleExporter(options => options.Targets = ConsoleExporterOutputTargets.Console);
    });
}

Public Sub ConfigureServices(ByVal services As IServiceCollection)
	services.AddControllers()
	services.AddOpenTelemetryMetrics(Sub(builder)
		builder.AddAspNetCoreInstrumentation().AddHttpClientInstrumentation().AddConsoleExporter(Sub(options) options.Targets = ConsoleExporterOutputTargets.Console)
	End Sub)
End Sub

Bu kurulum, ASP.NET Core ve HTTP istemci enstrümantasyonundan yapılan yerleşik metriklerin toplanmasını sağlamakta, kolay görüntüleme için bunları konsola aktarmaktadır.

Özel Metrikler Oluşturma

OpenTelemetry otomatik olarak birçok yararlı metrik toplarken, uygulamanıza özgü özel metrikler toplamak isteyebilirsiniz. Enstrümantasyon kütüphanesi tarafından sağlanan bir genişletme metodu kullanmak, telemetriyi otomatik olarak toplamakla kalmaz, aynı zamanda geliştiricilere yayılan metrikler üzerinde daha ayrıntılı kontrol sağlar. Bu, özel metrikler oluşturmak ve kaydetmek için kodunuzu manuel olarak enstrüman ederek başarılabilir.

var meter = new Meter("MyCustomMetrics", "1.0");
var counter = meter.CreateCounter<int>("custom_request_count", description: "Counts custom requests");
app.Use((context, next) =>
{
    counter.Add(1, new KeyValuePair<string, object>("path", context.Request.Path));
    return next();
});

var meter = new Meter("MyCustomMetrics", "1.0");
var counter = meter.CreateCounter<int>("custom_request_count", description: "Counts custom requests");
app.Use((context, next) =>
{
    counter.Add(1, new KeyValuePair<string, object>("path", context.Request.Path));
    return next();
});

Dim meter As New Meter("MyCustomMetrics", "1.0")
Dim counter = meter.CreateCounter(Of Integer)("custom_request_count", description:= "Counts custom requests")
app.Use(Function(context, [next])
	counter.Add(1, New KeyValuePair(Of String, Object)("path", context.Request.Path))
	Return [next]()
End Function)

Bu kod parçacığı, uygulamanıza gönderilen istekleri sayan bir özel metriği nasıl oluşturacağınızı, her metriği istek yolu ile etiketleyerek gösterir. OpenTelemetry tarafından sağlanan genişletme metodları kullanarak, geliştiriciler telemetri veri toplama süreci üzerinde daha ayrıntılı kontrol sağlayabilirler.

IronPDF Kurulumu

İlk olarak, .NET projenize IronPDF'i eklemeniz gerekmektedir. Bunu NuGet Paket Yöneticisini kullanarak yapabilirsiniz. Terminalinizi açın ve proje dizininize gidin. Ardından, IronPDF'i yüklemek için aşağıdaki komutu çalıştırın:

dotnet add package IronPDF

dotnet add package IronPDF

IronPDF ile PDF Oluşturma ve OpenTelemetry ile İzleme

Aşağıda, basit bir PDF belgesi oluşturmanın ve OpenTelemetry kullanarak işlemin nasıl izleneceğinin bir örneği vardır. Aşağıdaki örnek, uygulamanızda OpenTelemetry'yi daha önce gösterildiği şekilde yapılandırdığınızı varsaymaktadır.

using IronPdf;
using OpenTelemetry.Trace;

public class PdfService
{
    private readonly Tracer _tracer;

    public PdfService(Tracer tracer)
    {
        _tracer = tracer;
    }

    public void GeneratePdf()
    {
        // Create a new activity for this operation
        using var activity = _tracer.StartActivity("Generate PDF");

        // Simulate adding some attributes related to the operation
        activity?.SetTag("pdf.size", "A4");
        activity?.SetTag("pdf.content", "Hello World");

        try
        {
            // Initialize the PDF generator
            var renderer = new ChromePdfRenderer();

            // Generate a PDF from HTML
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1>");

            // Save the PDF to a file
            var outputPath = "output.pdf";
            pdf.SaveAs(outputPath);

            // Log success
            activity?.SetTag("pdf.status", "Success");
            activity?.SetTag("pdf.outputPath", outputPath);
        }
        catch (Exception ex)
        {
            // Log any exceptions that occur during PDF generation
            activity?.SetTag("pdf.status", "Error");
            activity?.SetTag("pdf.error", ex.Message);
            throw;
        }
    }
}

using IronPdf;
using OpenTelemetry.Trace;

public class PdfService
{
    private readonly Tracer _tracer;

    public PdfService(Tracer tracer)
    {
        _tracer = tracer;
    }

    public void GeneratePdf()
    {
        // Create a new activity for this operation
        using var activity = _tracer.StartActivity("Generate PDF");

        // Simulate adding some attributes related to the operation
        activity?.SetTag("pdf.size", "A4");
        activity?.SetTag("pdf.content", "Hello World");

        try
        {
            // Initialize the PDF generator
            var renderer = new ChromePdfRenderer();

            // Generate a PDF from HTML
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1>");

            // Save the PDF to a file
            var outputPath = "output.pdf";
            pdf.SaveAs(outputPath);

            // Log success
            activity?.SetTag("pdf.status", "Success");
            activity?.SetTag("pdf.outputPath", outputPath);
        }
        catch (Exception ex)
        {
            // Log any exceptions that occur during PDF generation
            activity?.SetTag("pdf.status", "Error");
            activity?.SetTag("pdf.error", ex.Message);
            throw;
        }
    }
}

Imports IronPdf
Imports OpenTelemetry.Trace

Public Class PdfService
	Private ReadOnly _tracer As Tracer

	Public Sub New(ByVal tracer As Tracer)
		_tracer = tracer
	End Sub

	Public Sub GeneratePdf()
		' Create a new activity for this operation
		Dim activity = _tracer.StartActivity("Generate PDF")

		' Simulate adding some attributes related to the operation
		If activity IsNot Nothing Then
			activity.SetTag("pdf.size", "A4")
		End If
		If activity IsNot Nothing Then
			activity.SetTag("pdf.content", "Hello World")
		End If

		Try
			' Initialize the PDF generator
			Dim renderer = New ChromePdfRenderer()

			' Generate a PDF from HTML
			Dim pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1>")

			' Save the PDF to a file
			Dim outputPath = "output.pdf"
			pdf.SaveAs(outputPath)

			' Log success
			If activity IsNot Nothing Then
				activity.SetTag("pdf.status", "Success")
			End If
			If activity IsNot Nothing Then
				activity.SetTag("pdf.outputPath", outputPath)
			End If
		Catch ex As Exception
			' Log any exceptions that occur during PDF generation
			If activity IsNot Nothing Then
				activity.SetTag("pdf.status", "Error")
			End If
			If activity IsNot Nothing Then
				activity.SetTag("pdf.error", ex.Message)
			End If
			Throw
		End Try
	End Sub
End Class

Bu örnekte, bir PdfService adlı yeni bir servis sınıfı oluşturuyoruz ve PDF belgesi oluşturmak için bir GeneratePdf yöntemi içerir. HTML'i bir PDF belgesi olarak işlemek için IronPDF'nin ChromePdfRenderer sınıfını kullanıyoruz. OpenTelemetry ile bu işlemi izlemek için 'Generate PDF' adında yeni bir etkinlik başlatıyoruz. PDF oluşturma sürecine ilişkin ek bağlam sağlamak için etkinliğe PDF boyutu, içerik türü ve çıktı yolu gibi özel etiketler ekliyoruz. Ayrıca, aynı etkinlik içinde hataları doğru bir şekilde kaydetmek için herhangi bir istisnayı yakalıyoruz.