O que é OpenTelemetry?

O OpenTelemetry é uma estrutura de observabilidade independente de fornecedor, criada especialmente para aplicativos nativos da nuvem. A instrumentação automática do OpenTelemetry fornece uma API única para coletar informações de telemetria, incluindo logs, rastreamento e métricas. Com o uso desses dados abrangentes, os desenvolvedores podem depurar problemas com eficácia, identificar gargalos de desempenho e obter uma compreensão completa do comportamento do programa. O OpenTelemetry oferece suporte à instrumentação automática e manual para uma coleta de dados de telemetria abrangente e flexível.

Criar e configurar o OpenTelemetry

using OpenTelemetry.Trace;
using OpenTelemetry.Exporter.Jaeger;
using OpenTelemetry.Resources;

public void ConfigureServices(IServiceCollection services)
{
    // Configure OpenTelemetry
    services.AddOpenTelemetry().WithTracing(builder =>
    {
        // Configure Jaeger exporter. The 'serviceName' can be read from environment variables
        builder
            .SetResourceBuilder(
                ResourceBuilder.CreateDefault()
                    .AddService("YourServiceName"))
            .AddAspNetCoreInstrumentation()
            .AddJaegerExporter(opt =>
            {
                opt.AgentHost = "localhost"; // Jaeger agent host
                opt.AgentPort = 14250; // Jaeger agent port
            });
    });
    // Other service configurations...
}

using OpenTelemetry.Trace;
using OpenTelemetry.Exporter.Jaeger;
using OpenTelemetry.Resources;

public void ConfigureServices(IServiceCollection services)
{
    // Configure OpenTelemetry
    services.AddOpenTelemetry().WithTracing(builder =>
    {
        // Configure Jaeger exporter. The 'serviceName' can be read from environment variables
        builder
            .SetResourceBuilder(
                ResourceBuilder.CreateDefault()
                    .AddService("YourServiceName"))
            .AddAspNetCoreInstrumentation()
            .AddJaegerExporter(opt =>
            {
                opt.AgentHost = "localhost"; // Jaeger agent host
                opt.AgentPort = 14250; // Jaeger agent port
            });
    });
    // Other service configurations...
}

Imports OpenTelemetry.Trace
Imports OpenTelemetry.Exporter.Jaeger
Imports OpenTelemetry.Resources

Public Sub ConfigureServices(ByVal services As IServiceCollection)
	' Configure OpenTelemetry
	services.AddOpenTelemetry().WithTracing(Sub(builder)
		' Configure Jaeger exporter. The 'serviceName' can be read from environment variables
		builder.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("YourServiceName")).AddAspNetCoreInstrumentation().AddJaegerExporter(Sub(opt)
				opt.AgentHost = "localhost" ' Jaeger agent host
				opt.AgentPort = 14250 ' Jaeger agent port
		End Sub)
	End Sub)
	' Other service configurations...
End Sub

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Add Prometheus metrics middleware if using Prometheus
    app.UseHttpMetrics();
    // Other middleware configurations...
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Add Prometheus metrics middleware if using Prometheus
    app.UseHttpMetrics();
    // Other middleware configurations...
}

Public Sub Configure(ByVal app As IApplicationBuilder, ByVal env As IWebHostEnvironment)
	' Add Prometheus metrics middleware if using Prometheus
	app.UseHttpMetrics()
	' Other middleware configurations...
End Sub

Começando

Install-Package OpenTelemetry
Install-Package OpenTelemetry.Instrumentation.AspNetCore
Install-Package OpenTelemetry.Exporter.Jaeger
Install-Package IronPdf

Utilizando OpenTelemetry com IronPDF

Abra o arquivo Startup.cs do seu aplicativo ASP.NET Core para acessar o método ConfigureServices. Para configurar o IronPDF, inclua o código a seguir.

using IronPdf;

public void ConfigureServices(IServiceCollection services)
{
    // Configure IronPDF
    services.AddSingleton<HtmlToPdf>();
    // Other service configurations...
}

using IronPdf;

public void ConfigureServices(IServiceCollection services)
{
    // Configure IronPDF
    services.AddSingleton<HtmlToPdf>();
    // Other service configurations...
}

Imports IronPdf

Public Sub ConfigureServices(ByVal services As IServiceCollection)
	' Configure IronPDF
	services.AddSingleton(Of HtmlToPdf)()
	' Other service configurations...
End Sub

Este código garante que uma instância de HtmlToPdf seja criada e usada pelo aplicativo somente configurando o serviço HtmlToPdf do IronPDF como um singleton.

Você pode rastrear e observar os processos de geração de PDF em seus aplicativos .NET integrando o OpenTelemetry .NET ao IronPDF. Vamos examinar o exemplo de código em detalhes, analisando cada etapa passo a passo:

using Microsoft.AspNetCore.Mvc;
using OpenTelemetry.Trace;
using System.Diagnostics;
using Microsoft.Extensions.Logging;
using IronPdf;

namespace DemoWebApplication.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class DemoController : ControllerBase
    {
        private readonly HtmlToPdf _htmlToPdf;
        private readonly ILogger<DemoController> _logger;
        private readonly Tracer _tracer;

        public DemoController(ILogger<DemoController> logger, HtmlToPdf htmlToPdf, TracerProvider tracerProvider)
        {
            _tracer = tracerProvider.GetTracer("Demo");
            _htmlToPdf = htmlToPdf;
            _logger = logger;
        }

        [HttpGet]
        public FileContentResult Generate()
        {
            // Define the PDF file name
            string fileName = "Sample.pdf";

            // Generate PDF from HTML content
            _logger.LogInformation("Generating PDF...");
            var pdfBytes = GeneratePdf("Hello, IronPDF!");

            // Return the PDF as a file result
            return new FileContentResult(pdfBytes, "application/pdf")
            {
                FileDownloadName = fileName
            };
        }

        private byte[] GeneratePdf(string htmlContent)
        {
            // Start a tracing activity for PDF generation
            using (var activity = _tracer.StartActiveSpan("PDF Generation"))
            {
                var pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent);

                // Log PDF generation
                _logger.LogInformation("PDF generated successfully.");

                return pdfDocument.BinaryData;
            }
        }
    }
}

using Microsoft.AspNetCore.Mvc;
using OpenTelemetry.Trace;
using System.Diagnostics;
using Microsoft.Extensions.Logging;
using IronPdf;

namespace DemoWebApplication.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class DemoController : ControllerBase
    {
        private readonly HtmlToPdf _htmlToPdf;
        private readonly ILogger<DemoController> _logger;
        private readonly Tracer _tracer;

        public DemoController(ILogger<DemoController> logger, HtmlToPdf htmlToPdf, TracerProvider tracerProvider)
        {
            _tracer = tracerProvider.GetTracer("Demo");
            _htmlToPdf = htmlToPdf;
            _logger = logger;
        }

        [HttpGet]
        public FileContentResult Generate()
        {
            // Define the PDF file name
            string fileName = "Sample.pdf";

            // Generate PDF from HTML content
            _logger.LogInformation("Generating PDF...");
            var pdfBytes = GeneratePdf("Hello, IronPDF!");

            // Return the PDF as a file result
            return new FileContentResult(pdfBytes, "application/pdf")
            {
                FileDownloadName = fileName
            };
        }

        private byte[] GeneratePdf(string htmlContent)
        {
            // Start a tracing activity for PDF generation
            using (var activity = _tracer.StartActiveSpan("PDF Generation"))
            {
                var pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent);

                // Log PDF generation
                _logger.LogInformation("PDF generated successfully.");

                return pdfDocument.BinaryData;
            }
        }
    }
}

Imports Microsoft.AspNetCore.Mvc
Imports OpenTelemetry.Trace
Imports System.Diagnostics
Imports Microsoft.Extensions.Logging
Imports IronPdf

Namespace DemoWebApplication.Controllers
	<ApiController>
	<Route("[controller]")>
	Public Class DemoController
		Inherits ControllerBase

		Private ReadOnly _htmlToPdf As HtmlToPdf
		Private ReadOnly _logger As ILogger(Of DemoController)
		Private ReadOnly _tracer As Tracer

		Public Sub New(ByVal logger As ILogger(Of DemoController), ByVal htmlToPdf As HtmlToPdf, ByVal tracerProvider As TracerProvider)
			_tracer = tracerProvider.GetTracer("Demo")
			_htmlToPdf = htmlToPdf
			_logger = logger
		End Sub

		<HttpGet>
		Public Function Generate() As FileContentResult
			' Define the PDF file name
			Dim fileName As String = "Sample.pdf"

			' Generate PDF from HTML content
			_logger.LogInformation("Generating PDF...")
			Dim pdfBytes = GeneratePdf("Hello, IronPDF!")

			' Return the PDF as a file result
			Return New FileContentResult(pdfBytes, "application/pdf") With {.FileDownloadName = fileName}
		End Function

		Private Function GeneratePdf(ByVal htmlContent As String) As Byte()
			' Start a tracing activity for PDF generation
			Using activity = _tracer.StartActiveSpan("PDF Generation")
				Dim pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent)

				' Log PDF generation
				_logger.LogInformation("PDF generated successfully.")

				Return pdfDocument.BinaryData
			End Using
		End Function
	End Class
End Namespace

Neste exemplo:

• Nós injetamos o HtmlToPdf, ILogger e TracerProvider no DemoController.
• O método Generate inicia o download de um arquivo, retornando um PDF criado dinamicamente com o conteúdo "Olá, IronPDF!".
• O método GeneratePdf usa o HtmlToPdf.RenderHtmlAsPdf para renderizar o PDF e gera os dados binários do PDF.
• O código utiliza o OpenTelemetry para rastrear o processo de geração do PDF e registra os dados de rastreamento.

Resultado em PDF gerado a partir do código-fonte acima:

Abaixo está a captura de tela do rastreamento gerado pela interface do usuário do Jaeger:

Conclusão

O OpenTelemetry é um divisor de águas para a otimização do desempenho e o monitoramento da integridade de aplicações .NET . Isso proporciona aos desenvolvedores uma compreensão completa do funcionamento interno de seus aplicativos, oferecendo um método padronizado e independente de fornecedores para coletar, analisar e exportar dados de telemetria (métricas, rastreamentos e registros).

Ao integrar o OpenTelemetry .NET com o IronPDF, os desenvolvedores podem aprimorar os fluxos de trabalho para a criação de PDFs e obter informações sobre o desempenho de seus aplicativos. Ao utilizar a implementação OpenTelemetry .NET para instrumentar manualmente os processos de geração de PDFs, os desenvolvedores podem rastrear os caminhos de execução, monitorar as métricas de desempenho e identificar regiões que precisam de otimização. Além disso, a coleta e análise centralizadas de métricas de monitoramento são viabilizadas pela exportação de dados de telemetria para plataformas de observabilidade, permitindo que os desenvolvedores preservem a integridade de seus aplicativos e ofereçam uma experiência de usuário impecável.

A integração da implementação OpenTelemetry .NET com o IronPDF pode aprimorar os fluxos de trabalho dos desenvolvedores na criação de PDFs e garantir escalabilidade, desempenho e confiabilidade em aplicações .NET . A integração dessas tecnologias ajuda os desenvolvedores a atender às necessidades do desenvolvimento de software moderno e a produzir resultados excelentes, seja na criação de faturas, relatórios ou documentação.

Quando adquirido em pacote, o IronPDF tem um preço justo e inclui uma licença vitalícia. O pacote oferece um ótimo custo-benefício por apenas $799, que é uma taxa única para muitos sistemas. Oferece aos titulares de licença suporte técnico online 24 horas por dia, 7 dias por semana. Por favor, visite o site da Iron Software para obter mais detalhes sobre a cobrança. Explore os produtos da Iron Software para saber mais sobre as soluções que ela oferece.