简介

创建动态、数据驱动、内容丰富的 PDF 文档是现代软件开发中许多领域的典型需求。无论是创建账单、报告还是文档，企业都非常依赖于快速生成高质量 PDF 的能力。然而，当应用程序变得越来越复杂、规模越来越大时，跟踪和了解 PDF 生产流程的有效性对于维护应用程序的健康和确保用户的愉悦感变得至关重要。

本文旨在讨论开发人员如何利用 IronPDF 和 OpenTelemetry.NET 的功能改进 PDF 生成操作，并提供有关应用程序性能的重要见解。我们将探讨这两种技术的特点和优势，并展示它们如何和谐地共同优化 .NET 应用程序中 PDF 的创建和监控。

什么是 OpenTelemetry？

OpenTelemetry 是一个厂商中立的可观察性框架，专为云原生应用程序而创建。OpenTelemetry 自动仪器提供了一个用于收集遥测信息（包括日志、跟踪和指标）的单一 API。利用这些广泛的数据，开发人员可以有效地调试问题、找出性能瓶颈并全面了解程序行为。OpenTelemetry 支持自动和手动仪器，以实现全面而灵活的遥测数据收集。

OpenTelemetry 的关键组件

• 应用程序接口：为了检测应用程序并生成遥测数据，OpenTelemetry 规定了一套标准化的应用程序接口。这就简化了检测程序，并保证了各种编程语言的一致性。
• SDKs：对于仪器应用程序，OpenTelemetry 提供了针对特定语言的 SDK。在 .NET SDK 的帮助下，开发人员可以轻松地将 OpenTelemetry 功能集成到他们的 .NET 项目中。
• 导出器：这些部分负责将收集到的遥测数据传输到后端系统，以便对其进行存储和检查。许多广泛使用的后端系统的导出器，如 Zipkin (追踪)普罗米修斯 (度量)和 Jaeger (追踪)OpenTelemetry支持以下功能。
• 自动仪器：这种方法简化了 .NET Core 应用程序的过程。OpenTelemetry 库可以自动捕获网络应用程序或服务中常见操作的数据。这消除了手动代码修改，简化了集成过程。
• 手动仪表：为实现对数据收集的精细控制，OpenTelemetry 为手动仪表化提供了强大的 API。通过这种方法，您可以捕获与您独特的应用程序逻辑相关的特定指标和跟踪。它对于 .NET Framework 应用程序或自动仪器无法满足您的特定需求的情况特别有用。

在 .NET 中使用 OpenTelemetry 的优势

将 OpenTelemetry 集成到您的 .NET 应用程序中具有多种优势：

• 供应商中立性：OpenTelemetry 通过与各种后端系统毫不费力地集成，为您的应用程序提供灵活性和面向未来的功能。您无需更改仪器代码即可切换后端系统。
• 标准化方法：通过统一的应用程序接口（API），可以更轻松地对应用程序的各个领域进行仪表化。开发人员可以使用相同的 API 来收集日志、跟踪和指标，从而使代码更易于阅读和维护。
• 深入的性能分析：OpenTelemetry 提供丰富的数据 (指标、跟踪和日志) 进行全面的性能分析。通过这一包罗万象的视角，您可以找到需要优化的地方，并确定问题的根本原因。
• 更好的故障排除：开发人员可以利用 OpenTelemetry 捕获的丰富跟踪数据，跟踪请求通过应用程序的路径，从而更轻松地发现并解决问题。
• 提高可扩展性：应用程序的复杂性不会妨碍 OpenTelemetry 的扩展能力。新的功能或服务无需修改大量代码就可轻松实现。

创建和配置 OpenTelemetry

在 ASP.NET 应用程序中配置 OpenTelemetry

需要在应用程序中配置 OpenTelemetry；对于 ASP.NET Core 应用程序，通常是在 Startup.cs 文件的 ConfigureServices 方法中进行配置。这是 Jaeger 输出程序配置的示例：

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

public void ConfigureServices(IServiceCollection services)
{
    // Configure OpenTelemetry
    builder.Services.AddOpenTelemetry().WithTracing(options =>
    {
        // Configure Jaeger exporter
        // serviceName we can read from environment variables
        options
            .SetResourceBuilder(
                ResourceBuilder.CreateDefault()
                    .AddService(serviceName))
            .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
    builder.Services.AddOpenTelemetry().WithTracing(options =>
    {
        // Configure Jaeger exporter
        // serviceName we can read from environment variables
        options
            .SetResourceBuilder(
                ResourceBuilder.CreateDefault()
                    .AddService(serviceName))
            .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
	builder.Services.AddOpenTelemetry().WithTracing(Sub(options)
		' Configure Jaeger exporter
		' serviceName we can read from environment variables
		options.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(serviceName)).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

用服务名称代替 "serviceName"。根据 Jaeger 配置选项，更改 Jaeger 代理主机和端口。

添加 OpenTelemetry 中间件

您必须在 ASP.NET Core 应用程序中加入 OpenTelemetry 中间件，以获得对传入 HTTP 请求的自动监测。在您的 Startup.cs 文件的 Configure 方法中，添加中间件：

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

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

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

开始追踪

设置好一切后，OpenTelemetry 将开始跟踪传入的 HTTP 请求，并自行向配置好的 Jaeger 后端发送遥测信息。

验证和监控

你可以检查Jaeger后台的跟踪，以确认OpenTelemetry运行正常。打开Jaeger用户界面 (Jaeger UI 通常可在 http://localhost:16686 获取) 并查找与您的服务相关的痕迹。

选择后台系统 (可选)

OpenTelemetry 不是基本仪器的必备工具，但它能与其他后端操作系统集成，以存储和处理遥测数据。常用的选项包括官方支持的操作系统：

• 机甲 (追踪)

• 普罗米修斯 (度量)

• 齐普金 (追踪)

入门

什么是 IronPDF？

流行的 .NET 软件包 IronPDF 允许您在 .NET 程序中创建、编辑和渲染 PDF 文档。处理 PDF 的功能非常多，包括：将 HTML 页面转换为 PDF；从 PDF 中提取文本和图像；在已有的 PDF 文档中添加文本、图像和形状；以及从 HTML 内容、照片或原始数据生成 PDF。

IronPDF 的两大优势是易用和简单。由于其直观的 API 和全面的文档，开发人员可以毫不费力地在其 .NET 项目中开始创建 PDF。IronPDF 的效率和速度是帮助开发人员快速高效地创建高质量 PDF 文档的额外特点。

IronPDF 的部分优势：

• 从 HTML、图片和原始数据生成 PDF
• 从 PDF 文件中提取文本和图片
• 在 PDF 文件中加入水印、页眉和页脚
• 通过加密和密码保护 PDF 文件
• 能够以电子方式签署和填写表格

安装 NuGet 软件包

OpenTelemetry 的不同组件有多个 NuGet 软件包。您可以根据需要安装所需的软件包。向可观测性后端发送遥测数据 (如 Jaeger、Zipkin 或 Prometheus)因此，您至少需要 OpenTelemetry 软件包和应用程序框架的仪器软件包。 (如 ASP.NET Core)和一个输出程序包。此外，确保在项目中安装了 IronPDF 软件包。要安装它，请使用 NuGet 软件包管理器控制台：

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

使用 OpenTelemetry 与 IronPDF

打开 ASP.NET Core 应用程序的 Startup.cs 文件，进入 ConfigureServices 函数。要设置 IronPDF，请包含以下代码。

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

通过将 IronPDF 的 "HtmlToPdf "服务配置为单例，该代码可确保应用程序仅创建并使用 "HtmlToPdf "实例。

通过将 OpenTelemetry.NET 与 IronPDF 集成，您可以跟踪和观察 .NET 应用程序中的 PDF 生成过程。让我们深入研究一下代码示例，一步一步地检查每一个步骤：

using Microsoft.AspNetCore.Mvc;
using OpenTelemetry.Trace;
using System.Diagnostics;
using System.Net;
using System.Net.Http.Headers;

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

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

        [HttpGet]
        public FileContentResult Generate()
        {
            string fileName = "Sample.pdf";
            var stream = GeneratePdf("Hello IronPDF");
            return new FileContentResult(stream, "application/octet-stream")
            {
                FileDownloadName = fileName
            };
        }

        private byte[] GeneratePdf(string htmlContent)
        {
            using (var activity = _tracer.StartActiveSpan("PDF Generation"))
            {
                var pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent);
                var pdfBytes = pdfDocument.BinaryData;
                return pdfBytes;
            }
        }
    }
}

using Microsoft.AspNetCore.Mvc;
using OpenTelemetry.Trace;
using System.Diagnostics;
using System.Net;
using System.Net.Http.Headers;

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

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

        [HttpGet]
        public FileContentResult Generate()
        {
            string fileName = "Sample.pdf";
            var stream = GeneratePdf("Hello IronPDF");
            return new FileContentResult(stream, "application/octet-stream")
            {
                FileDownloadName = fileName
            };
        }

        private byte[] GeneratePdf(string htmlContent)
        {
            using (var activity = _tracer.StartActiveSpan("PDF Generation"))
            {
                var pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent);
                var pdfBytes = pdfDocument.BinaryData;
                return pdfBytes;
            }
        }
    }
}

Imports Microsoft.AspNetCore.Mvc
Imports OpenTelemetry.Trace
Imports System.Diagnostics
Imports System.Net
Imports System.Net.Http.Headers

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

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

		Private Function WeatherForecastController(ByVal logger As ILogger(Of WeatherForecastController), ByVal htmlToPdf As HtmlToPdf, ByVal tracerProvider As TracerProvider) As Public
			_tracer = tracerProvider.GetTracer("Demo")
			_htmlToPdf = htmlToPdf
		End Function

		<HttpGet>
		Public Function Generate() As FileContentResult
			Dim fileName As String = "Sample.pdf"
			Dim stream = GeneratePdf("Hello IronPDF")
			Return New FileContentResult(stream, "application/octet-stream") With {.FileDownloadName = fileName}
		End Function

		Private Function GeneratePdf(ByVal htmlContent As String) As Byte()
			Using activity = _tracer.StartActiveSpan("PDF Generation")
				Dim pdfDocument = _htmlToPdf.RenderHtmlAsPdf(htmlContent)
				Dim pdfBytes = pdfDocument.BinaryData
				Return pdfBytes
			End Using
		End Function
	End Class
End Namespace

为了给我们的应用程序生成一个跟踪器实例，我们注入了 "TracerProvider "服务。生成 "方法创建了一个名为 "PDF 生成 "的 OpenTelemetry 活动，以表示正在进行的工作。我们在活动中模仿一些工作 (代入自己的逻辑).我们建立了一个名为 "work_duration_ms "的直方图度量来监控工作的毫秒持续时间。我们为该指标添加一个数据点，将其标记为 "Demo"，值为 "PDF 生成"，并记录持续时间 (在这种情况下为 1000 毫秒).标签为分析提供了额外的语境。

根据上述源代码生成 PDF 输出：

下面是通过 Jaeger 用户界面生成的跟踪画面：

结论

OpenTelemetry 改变了.NET 应用程序性能优化和健康监测的游戏规则。它通过提供一种中立的标准化方法来收集、分析和导出遥测数据，让开发人员彻底了解其应用程序的内部运作情况。 (指标、跟踪和日志).

通过将 OpenTelemetry.NET 与 IronPDF 集成，开发人员可以改进创建 PDF 的工作流程，并深入了解其应用程序的性能。通过利用 OpenTelemetry.NET 实现手动检测 PDF 生成流程，开发人员可以跟踪执行路径、跟踪性能指标并精确定位需要优化的区域。此外，通过将遥测数据导出到可观察性平台，还可实现集中监控指标收集和分析，使开发人员有能力保护其应用程序的健康并提供完美的用户体验。

OpenTelemetry.NET 实现与 IronPDF 的集成可以增强开发人员创建 PDF 的工作流程，并保证 .NET 应用程序的可扩展性、性能和可靠性。这些技术的集成可以帮助开发人员满足现代软件开发的需求，并产生出色的结果，无论是创建发票、报告还是文档。

如果以套餐形式购买，IronPDF 价格合理，并包含终身许可证。该套餐价值不菲，仅需 749 美元，这对许多系统来说都是一次性费用。它为许可证持有者提供全天候在线工程支持。请访问 网站 了解有关指控的更多详情。请访问 网站 了解有关 Iron Software 产品的更多信息。