Opentelemetry C# (jak to działa dla programistów)

Dodawanie wymaganych pakietów

Najpierw dodaj niezbędne pakiety OpenTelemetry do swojego projektu. Otwórz swój terminal i przejdź do katalogu projektu. Następnie zainstaluj następujące pakiety za pomocą CLI Menedżera Pakietów NuGet:

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>

Zamień na najnowszą wersję każdego pakietu.

Konfiguracja OpenTelemetry w aplikacji

Po dodaniu niezbędnych pakietów, musisz skonfigurować OpenTelemetry w swojej aplikacji. To obejmuje skonfigurowanie SDK OpenTelemetry i określenie, które dane telemetryczne zbierać. OpenTelemetry oferuje biblioteki instrumentacji do bezproblemowej integracji z aplikacjami .NET.

Otwórz plik Startup.cs w swoim projekcie i zmodyfikuj metodę ConfigureServices, aby uwzględniała OpenTelemetry, jak pokazano w poniższym fragmencie kodu:

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

Ten fragment kodu pokazuje, jak skonfigurować OpenTelemetry do zbierania danych telemetrycznych z aplikacji ASP.NET Core i wywołań klienta HTTP, a następnie eksportować te dane do konsoli. Metoda AddAspNetCoreInstrumentation automatycznie umożliwia instrumentację dla przychodzących żądań HTTP do aplikacji ASP.NET Core.

Zbieranie metryk

Aby zbierać metryki, musisz również skonfigurować API Metryk OpenTelemetry, skupiając się na metrykach zamiast na śledzeniu.

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

Ta konfiguracja umożliwia zbieranie wbudowanych metryk z aplikacji ASP.NET Core i instrumentacji klienta HTTP, eksportując je do konsoli dla łatwego przeglądania.

Tworzenie własnych metryk

Chociaż OpenTelemetry automatycznie zbiera wiele użytecznych metryk, możesz chcieć zbierać własne metryki specyficzne dla twojej aplikacji. Wykorzystanie metody rozszerzającej dostarczonej przez bibliotekę instrumentacyjną nie tylko automatycznie zbiera telemetrykę, ale również daje deweloperom bardziej szczegółową kontrolę nad emitowanymi metrykami. Można to osiągnąć poprzez ręczną instrumentację swojego kodu do tworzenia i rejestrowania własnych metryk.

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)

Ten fragment kodu pokazuje, jak stworzyć własną metrykę, która zlicza żądania do twojej aplikacji, oznaczając każdą metrykę ścieżką żądania. Dzięki wykorzystaniu metod rozszerzających dostarczonych przez OpenTelemetry, deweloperzy mogą sprawować bardziej szczegółową kontrolę nad procesem zbierania danych telemetrycznych.

Konfiguracja IronPDF

Najpierw musisz dodać IronPDF do swojego projektu .NET. Możesz to zrobić, używając Menedżera Pakietów NuGet. Otwórz swój terminal i przejdź do katalogu projektu. Następnie uruchom poniższe polecenie, aby zainstalować IronPDF:

dotnet add package IronPDF

dotnet add package IronPDF

Generowanie PDF z IronPDF i monitorowanie z OpenTelemetry

Poniżej znajduje się przykład, jak wygenerować prosty dokument PDF i monitorować działanie za pomocą OpenTelemetry. Poniższy przykład zakłada, że już skonfigurowałeś OpenTelemetry w swojej aplikacji zgodnie z wcześniejszymi wskazówkami.

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

W tym przykładzie tworzymy nową klasę serwisową PdfService, która zawiera metodę GeneratePdf do generowania dokumentu PDF. Używamy klasy ChromePdfRenderer z IronPDF do renderowania HTML jako dokumentu PDF. Dzięki OpenTelemetry, rozpoczynamy nową aktywność nazwaną "Generate PDF", aby monitorować tę operację. Dodajemy niestandardowe tagi do aktywności, aby dostarczyć dodatkowy kontekst na temat procesu generowania PDF, takie jak wielkość PDF, typ zawartości i ścieżka wyjściowa. Złapamy również wszelkie wyjątki, aby odpowiednio zarejestrować błędy w ramach tej samej aktywności.