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

Gerekli Paketlerin Eklenmesi

Öncelikle, gerekli OpenTelemetry paketlerini projenize ekleyin. Terminalinizi açın ve proje dizininize gidin. Ardından, NuGet Paket Yöneticisi CLI'sini kullanarak aşağıdaki paketleri kurun:

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.

Uygulamanızda OpenTelemetry'nin Yapılandırılması

Gerekli paketleri ekledikten sonra, uygulamanızda OpenTelemetry'yi yapılandırmanız gerekecek. Bu, OpenTelemetry SDK'sını ayarlamayı ve toplanacak telemetri verilerini belirtmeyi içerir. OpenTelemetry, .NET uygulamaları ile sorunsuz entegrasyon için enstrümantasyon kütüphaneleri sunar.

Projenizdeki Startup.cs dosyasını açın ve OpenTelemetry'yi dahil etmek için ConfigureServices yöntemini aşağıdaki kod parçasında gösterildiği gibi 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çası, 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'nin nasıl yapılandırılacağını gösterir. AddAspNetCoreInstrumentation yöntemi, ASP.NET Core uygulamalarına gelen HTTP istekleri için otomatik olarak enstrümantasyon sağlar.

Metrik Toplama

Metrik toplamak için ayrıca, izlemeye göre metriklere odaklanarak OpenTelemetry Metrik API'sini yapılandırmanız gerekecektir.

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 yapılandırma, yerleşik metriklerin ASP.NET Core ve HTTP istemci enstrümantasyonundan toplanmasına ve kolayca görüntülenebilmeleri için konsola aktarılmasını sağlayacaktır.

Özel Metrikler Oluşturma

OpenTelemetry birçok yararlı metriği otomatik olarak toplasa da, uygulamanıza özel metrikler toplamak isteyebilirsiniz. Enstrümantasyon kütüphanesi tarafından sağlanan bir uzantı yönteminin kullanılması sadece telemetriyi otomatik olarak toplamakla kalmaz, ayrıca geliştiricilere yayımlanan metrikler üzerinde daha ince kontrol sağlar. Bu, özel metrikler oluşturmak ve kaydetmek için kodunuzu manuel olarak enstrümante ederek gerçekleştirilebilir.

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çası, uygulamanıza yapılan istekleri sayan ve her metriği istek yolu ile etiketleyen özel bir metriğin nasıl oluşturulacağını göstermektedir. OpenTelemetry tarafından sağlanan uzatma yöntemlerinden faydalanarak, geliştiriciler telemetri veri toplama süreci üzerinde daha ince kontrol sağlayabilir.

IronPDF Kurulumu

Öncelikle IronPDF'yi .NET projenize eklemeniz gerekiyor. Bunu NuGet Paket Yöneticisi'ni kullanarak yapabilirsiniz. Terminalinizi açın ve proje dizininize gidin. Daha sonra, IronPDF'yi kurmak için aşağıdaki komutu çalıştırın:

dotnet add package IronPDF

dotnet add package IronPDF

IronPDF ve OpenTelemetry ile PDF Oluşturma

Aşağıda, basit bir PDF belgesi oluşturma ve OpenTelemetry'yi kullanarak işlemi izleme örneği verilmiştir. Aşağıdaki örnek, daha önce gösterildiği gibi OpenTelemetry'nin uygulamanızda zaten yapılandırıldığını varsayar.

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 örnekle, PDF belgesi oluşturmaya yönelik bir yöntem GeneratePdf içeren yeni bir hizmet sınıfı PdfService oluşturuyoruz. IronPDF'nin ChromePdfRenderer sınıfını, HTML'yi PDF belgesi olarak işlemek için kullanıyoruz. OpenTelemetry ile bu işlemi izlemek için 'Generate PDF' adında yeni bir etkinlik başlatıyoruz. PDF oluşturma süreci hakkında ek bağlam sağlamak için etkinliğe özel etiketler ekliyoruz, örneğin PDF'nin boyutu, içerik türü ve çıktı yolu gibi. Ayrıca, aynı etkinlik içinde hataları uygun şekilde kaydetmek için herhangi bir istisnayı yakalıyoruz.