Opentelemetry em C# (Como funciona para desenvolvedores)

Adicionando os pacotes necessários

Primeiro, adicione os pacotes OpenTelemetry necessários ao seu projeto. Abra o terminal e navegue até o diretório do seu projeto. Em seguida, instale os seguintes pacotes usando a CLI do Gerenciador de Pacotes 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>

Substituir com a versão mais recente de cada pacote.

Configurando o OpenTelemetry em seu aplicativo

Após adicionar os pacotes necessários, você precisa configurar o OpenTelemetry em sua aplicação. Isso envolve configurar o SDK OpenTelemetry e especificar quais dados de telemetria devem ser coletados. O OpenTelemetry oferece bibliotecas de instrumentação para integração perfeita com aplicativos .NET .

Abra o arquivo Startup.cs em seu projeto e modifique o método ConfigureServices para incluir OpenTelemetry, conforme mostrado no trecho de código abaixo:

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

Este trecho de código mostra como configurar o OpenTelemetry para coletar dados de telemetria de aplicativos ASP.NET Core e chamadas de clientes HTTP e, em seguida, exportar esses dados para o console. O método AddAspNetCoreInstrumentation habilita automaticamente a instrumentação para solicitações HTTP recebidas em aplicativos ASP.NET Core .

Coletando métricas

Para coletar métricas, você também precisará configurar a API OpenTelemetry Metrics, com foco em métricas em vez de rastreamento.

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

Essa configuração permite a coleta de métricas integradas do ASP.NET Core e da instrumentação do cliente HTTP, exportando-as para o console para facilitar a visualização.

Criação de métricas personalizadas

Embora o OpenTelemetry colete automaticamente muitas métricas úteis, você pode querer coletar métricas personalizadas específicas para sua aplicação. Utilizar um método de extensão fornecido pela biblioteca de instrumentação não só coleta telemetria automaticamente, como também oferece aos desenvolvedores um controle mais granular sobre as métricas emitidas. Isso pode ser conseguido instrumentando manualmente seu código para criar e registrar métricas personalizadas.

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)

Este trecho de código demonstra como criar uma métrica personalizada que contabiliza as solicitações para seu aplicativo, associando cada métrica ao caminho da solicitação. Ao aproveitar os métodos de extensão fornecidos pelo OpenTelemetry, os desenvolvedores podem exercer um controle mais preciso sobre o processo de coleta de dados de telemetria.

Configurando o IronPDF

Primeiro, você precisa adicionar o IronPDF ao seu projeto .NET . Você pode fazer isso usando o Gerenciador de Pacotes NuGet . Abra o terminal e navegue até o diretório do seu projeto. Em seguida, execute o seguinte comando para instalar o IronPDF:

dotnet add package IronPDF

dotnet add package IronPDF

Geração de um PDF com IronPDF e monitoramento com OpenTelemetry

Abaixo, segue um exemplo de como gerar um documento PDF simples e monitorar a operação usando o OpenTelemetry. O exemplo a seguir pressupõe que você já tenha configurado o OpenTelemetry em sua aplicação, conforme mostrado anteriormente.

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

Neste exemplo, criamos uma nova classe de serviço chamada PdfService que inclui um método GeneratePdf para gerar um documento PDF. Utilizamos a classe ChromePdfRenderer do IronPDF para renderizar HTML como um documento PDF. Com o OpenTelemetry, iniciamos uma nova atividade chamada "Gerar PDF" para monitorar essa operação. Adicionamos tags personalizadas à atividade para fornecer contexto adicional sobre o processo de geração de PDF, como o tamanho do PDF, o tipo de conteúdo e o caminho de saída. Também capturamos quaisquer exceções para registrar erros adequadamente dentro da mesma atividade.