Czym jest OpenTelemetry?

OpenTelemetry to niezależna od dostawcy platforma do monitorowania, stworzona specjalnie dla aplikacji natywnych dla chmury. Automatyczna instrumentacja OpenTelemetry zapewnia jeden interfejs API do zbierania informacji telemetrycznych, w tym logów, śledzenia i metryk. Korzystając z tych obszernych danych, programiści mogą skutecznie debugować problemy, wskazywać wąskie gardła wydajności i uzyskać pełne zrozumienie zachowania programu. OpenTelemetry obsługuje zarówno automatyczną, jak i ręczną instrumentację, umożliwiając kompleksowe i elastyczne gromadzenie danych telemetrycznych.

Utwórz i skonfiguruj 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

Pierwsze kroki

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

Korzystanie z OpenTelemetry z IronPDF

Otwórz plik Startup.cs aplikacji .NET Core, aby uzyskać dostęp do metody ConfigureServices. Aby skonfigurować IronPDF, należy dołączyć poniższy kod.

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

Ten kod gwarantuje, że instancja HtmlToPdf zostanie utworzona i używana przez aplikację wyłącznie poprzez skonfigurowanie usługi HtmlToPdf IronPDF jako singletonu.

Możesz śledzić i obserwować procesy generowania plików PDF w swoich aplikacjach .NET poprzez integrację OpenTelemetry.NET z IronPDF. Przyjrzyjmy się przykładowemu kodowi bardziej szczegółowo, omawiając każdy krok po kolei:

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

W tym przykładzie:

• Wstawiamy HtmlToPdf, ILogger i TracerProvider do DemoController.
• Metoda Generate rozpoczyna pobieranie pliku, zwracając dynamicznie utworzony plik PDF o treści "Hello, IronPDF!".
• Metoda GeneratePdf wykorzystuje HtmlToPdf.RenderHtmlAsPdf do renderowania pliku PDF i generuje dane binarne tego pliku.
• Kod wykorzystuje OpenTelemetry do śledzenia procesu generowania plików PDF i rejestruje dane śledzenia.

Wygenerowany plik PDF na podstawie powyższego kodu źródłowego:

Poniżej znajduje się zrzut ekranu z wygenerowanym śladem z interfejsu użytkownika Jaeger:

Wnioski

OpenTelemetry to przełomowe rozwiązanie w zakresie optymalizacji wydajności aplikacji .NET i monitorowania ich stanu. Zapewnia programistom dogłębne zrozumienie wewnętrznego działania ich aplikacji, oferując niezależną od dostawcy i znormalizowaną metodę gromadzenia, analizowania i eksportowania danych telemetrycznych (metryki, ślady i logi).

Dzięki integracji OpenTelemetry.NET z IronPDF programiści mogą usprawnić procesy tworzenia plików PDF i uzyskać wgląd w wydajność swoich aplikacji. Wykorzystując implementację OpenTelemetry.NET do ręcznego instrumentowania procesów generowania plików PDF, programiści mogą śledzić ścieżki wykonania, monitorować wskaźniki wydajności i wskazywać obszary wymagające optymalizacji. Ponadto scentralizowane gromadzenie i analiza wskaźników monitorowania są możliwe dzięki eksportowaniu danych telemetrycznych do platform obserwowalności, co daje programistom możliwość utrzymania sprawności ich aplikacji i zapewnienia bezbłędnego doświadczenia użytkownika.

Integracja implementacji OpenTelemetry.NET i IronPDF może usprawnić proces tworzenia plików PDF przez programistów oraz zagwarantować skalowalność, wydajność i niezawodność aplikacji .NET. Integracja tych technologii pomaga programistom sprostać wymaganiom współczesnego tworzenia oprogramowania i osiągać doskonałe wyniki, niezależnie od tego, czy chodzi o tworzenie faktur, raportów czy dokumentacji.

W przypadku zakupu w pakiecie IronPDF jest dostępny w przystępnej cenie i obejmuje dożywotnią licencję. Pakiet oferuje doskonałą wartość za jedyne $799, co stanowi jednorazową opłatę za wiele systemów. Oferuje posiadaczom licencji całodobowe wsparcie techniczne online. Więcej szczegółów na temat zlecenia można znaleźć na stronie internetowej Iron Software. Zapoznaj się z produktami Iron Software, aby dowiedzieć się więcej o oferowanych przez firmę rozwiązaniach.