Opentelemetry C#（开发人员如何使用）

添加必需的软件包

首先，向您的项目添加必要的 OpenTelemetry 软件包。 打开终端并导航到您的项目目录。 然后，使用 NuGet 包管理器 CLI 安装以下软件包：

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>

将 替换为每个软件包的最新版本。

在您的应用程序中配置 OpenTelemetry

添加所需的软件包后，您需要在您的应用程序中配置 OpenTelemetry。 这涉及到设置 OpenTelemetry SDK 并指定需要收集的遥测数据。 OpenTelemetry 提供了用于与 .NET 应用程序无缝集成的仪器库。

打开项目中的 Startup.cs 文件，并修改 ConfigureServices 方法以包含如下代码片段所示的 OpenTelemetry：

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();
    });
}

此代码片段显示了如何配置 OpenTelemetry 以从 ASP.NET Core 应用程序和 HTTP 客户端调用中收集遥测数据，然后将这些数据导出到控制台。 AddAspNetCoreInstrumentation 方法自动启用 ASP.NET Core 应用程序中传入 HTTP 请求的仪器化。

收集指标

要收集指标，您还需要配置 OpenTelemetry 指标 API，重点是指标而不是跟踪。

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);
    });
}

此设置启用从 ASP.NET Core 和 HTTP 客户端仪器收集内置指标，并将其导出到控制台以便于查看。

创建自定义指标

虽然 OpenTelemetry 自动收集许多有用的指标，但您可能希望收集针对您应用程序的自定义指标。 利用仪器库提供的扩展方法不仅能自动收集遥测数据，还能让开发人员对发出的指标进行更细粒度的控制。 这可以通过手动仪器化您的代码来实现，以创建和记录自定义指标。

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();
});

此代码片段演示了如何创建一个自定义指标来计数应用程序中的请求，并为每个指标加上请求路径标签。 通过利用 OpenTelemetry 提供的扩展方法，开发人员可以对遥测数据收集过程施加更细致的控制。

设置 IronPDF。

首先，您需要将 IronPDF 添加到您的 .NET 项目中。 您可以使用 NuGet 包管理器来完成此操作。 打开终端并导航到您的项目目录。 然后，运行以下命令来安装 IronPDF：

dotnet add package IronPDF

dotnet add package IronPDF

使用 IronPDF 生成 PDF 并使用 OpenTelemetry 进行监控

下面是一个如何生成简单 PDF 文档并使用 OpenTelemetry 监控操作的示例。 以下示例假设您已如前所示在应用程序中配置 OpenTelemetry。

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;
        }
    }
}

在此示例中，我们创建了一个新的服务类 PdfService，其中包含用于生成 PDF 文档的 GeneratePdf 方法。 我们使用 IronPDF 的 ChromePdfRenderer 类将 HTML 渲染为 PDF 文档。 使用 OpenTelemetry，我们启动了一个名为"生成 PDF"的新活动，以监控此操作。 我们为活动添加了自定义标签，以提供有关 PDF 生成过程的附加背景信息，例如 PDF 的大小、内容类型和输出路径。 我们还会捕获任何异常，以便在同一活动中适当地记录错误。