OpenTelemetry C#（開發者使用指南）

新增所需的套件

首先，在您的專案中加入必要的 OpenTelemetry 套件。 開啟您的終端機，並導航至您的專案目錄。 然後，使用 NuGet Package Manager 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 Metrics 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 Package Manager 進行這項工作。 開啟您的終端機，並導航至您的專案目錄。 然後，執行下列指令安裝 IronPdf：

dotnet add package IronPDF

dotnet add package IronPDF

使用 IronPDF 生成 PDF 並使用 OpenTelemetry 進行監控

以下是如何使用 OpenTelemetry 產生一個簡單 PDF 文件並監控運作的範例。 以下範例假設您已在應用程式中設定 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，其中包含一個方法 GeneratePdf，用來產生 PDF 文件。 我們使用 IronPDF 的 ChromePdfRenderer 類將 HTML 呈現為 PDF 文件。 透過 OpenTelemetry，我們啟動一個名為"Generate PDF"的新活動來監控這項作業。 我們在活動中加入自訂標籤，以提供 PDF 產生過程的其他相關資訊，例如 PDF 的大小、內容類型和輸出路徑。 我們也會捕捉任何異常，以便在同一活動中適當地記錄錯誤。