Bugsnag C#（對於開發者的運行原理）

在 .NET 專案中設定 Bugsnag C

首先，您需要將 Bugsnag 加入您的專案。 其方法是從 .NET 的套件管理程式 NuGet 安裝 Bugsnag 套件。 進入 Visual Studio 中的 NuGet 主控台。 運行以下命令：

Install-Package Bugsnag

。

基本程式碼範例

安裝 Bugsnag 之後，下一步就是在您的應用程式中設定它，讓您的 Bugsnag 設定成為 私人唯讀的 Bugsnag 實例，以加強安全性與控制。 要使用 Bugsnag 客戶端初始化您的專案，您必須先取得 Bugsnag API 金鑰。 這將您的應用程式連接至 Bugsnag 面板。

using Bugsnag;

namespace YourNamespace
{
    class Program
    {
        static void Main(string[] args)
        {
            // Initialize Bugsnag configuration with your API key
            var settings = new Configuration("api_key_here");
            var client = new Client(settings);

            // Example of manually notifying Bugsnag of an issue
            try
            {
                // Your code here. For example:
                throw new System.NotImplementedException("This is a test exception.");
            }
            catch (System.Exception ex)
            {
                // Notify Bugsnag of the exception
                client.Notify(ex);
            }
        }
    }
}

using Bugsnag;

namespace YourNamespace
{
    class Program
    {
        static void Main(string[] args)
        {
            // Initialize Bugsnag configuration with your API key
            var settings = new Configuration("api_key_here");
            var client = new Client(settings);

            // Example of manually notifying Bugsnag of an issue
            try
            {
                // Your code here. For example:
                throw new System.NotImplementedException("This is a test exception.");
            }
            catch (System.Exception ex)
            {
                // Notify Bugsnag of the exception
                client.Notify(ex);
            }
        }
    }
}

Imports Bugsnag

Namespace YourNamespace
	Friend Class Program
		Shared Sub Main(ByVal args() As String)
			' Initialize Bugsnag configuration with your API key
			Dim settings = New Configuration("api_key_here")
			Dim client As New Client(settings)

			' Example of manually notifying Bugsnag of an issue
			Try
				' Your code here. For example:
				Throw New System.NotImplementedException("This is a test exception.")
			Catch ex As System.Exception
				' Notify Bugsnag of the exception
				client.Notify(ex)
			End Try
		End Sub
	End Class
End Namespace

本程式碼片段示範如何在一個簡單的 .NET 主控台應用程式中設定 Bugsnag。 Bugsnag notifier 的Notify 方法會將捕捉到的異常傳送給 Bugsnag。 它不僅能在生產中報告異常，還能讓您在 Bugsnag 面板中看到錯誤，簡化異常處理。

現在您已經設定好 Bugsnag 並準備好回報錯誤，讓我們深入瞭解它的功能，以及如何使用這些功能來有效監控您的應用程式。

自動錯誤報告

Bugsnag 的核心優勢之一是能夠自動擷取和報告未擷取的異常。 這表示在您的應用程式中，任何您沒有手動捕捉的異常仍會回報到 Bugsnag 面板。 以下是如何啟用自動錯誤報告：

var settings = new Configuration("your_bugsnag_api_key_here")
{
    AutoCaptureSessions = true // Automatically captures and reports sessions
};
var client = new Client(settings);

var settings = new Configuration("your_bugsnag_api_key_here")
{
    AutoCaptureSessions = true // Automatically captures and reports sessions
};
var client = new Client(settings);

Dim settings = New Configuration("your_bugsnag_api_key_here") With {.AutoCaptureSessions = True}
Dim client As New Client(settings)

此設定可確保監控每個階段，並自動報告任何未擷取的異常，讓您全面掌握應用程式的穩定性。

詳細錯誤控制的設定選項

自訂 Bugsnag 報告錯誤的方式，可以大幅提升您所收到的錯誤資訊的實用性。Bugsnag C# 提供了各種配置選項來精細錯誤報告。 例如，您可以指定忽略哪些異常、新增自訂診斷資訊，以及控制隨錯誤報告傳送的使用者資料數量：

var settings = new Configuration("your_bugsnag_api_key_here")
{
    ProjectNamespaces = new[] { "YourNamespace" }, // Only report errors from specific namespaces
    IgnoreClasses = new[] { "System.Exception" }, // Ignore specific exception types
    ReleaseStage = "production" // Set the current release stage of your application
};

var settings = new Configuration("your_bugsnag_api_key_here")
{
    ProjectNamespaces = new[] { "YourNamespace" }, // Only report errors from specific namespaces
    IgnoreClasses = new[] { "System.Exception" }, // Ignore specific exception types
    ReleaseStage = "production" // Set the current release stage of your application
};

Dim settings = New Configuration("your_bugsnag_api_key_here") With {
	.ProjectNamespaces = { "YourNamespace" },
	.IgnoreClasses = { "System.Exception" },
	.ReleaseStage = "production"
}

此設定有助於在確保使用者隱私和資料安全的同時，將焦點放在對您的應用程式最重要的錯誤上。

使用使用者資料和元資料強化錯誤報告

在錯誤報告中加入使用者資訊和自製元資料，可以提供有價值的上下文，讓問題的診斷和修復變得更容易。 以下是如何強化您的錯誤報告：

client.BeforeNotify(report =>
{
    report.Event.User = new User { Id = "user_id", Name = "User Name", Email = "user@example.com" };
    report.Event.AddMetadata("Order", new { OrderId = 123, Status = "Processing" });
});

client.BeforeNotify(report =>
{
    report.Event.User = new User { Id = "user_id", Name = "User Name", Email = "user@example.com" };
    report.Event.AddMetadata("Order", new { OrderId = 123, Status = "Processing" });
});

client.BeforeNotify(Sub(report)
	report.Event.User = New User With {
		.Id = "user_id",
		.Name = "User Name",
		.Email = "user@example.com"
	}
	report.Event.AddMetadata("Order", New With {
		Key .OrderId = 123,
		Key .Status = "Processing"
	})
End Sub)

此程式碼片段會在每個錯誤報告中加入使用者詳細資訊和訂單的自訂元資料。 這種額外的上下文對於理解導致錯誤的情況可能非常重要。

利用 Bugsnag C# 的這些功能，您可以更深入地瞭解影響應用程式的錯誤，並根據實際的使用者影響排定修復的優先順序，最終改善軟體的可靠性和使用者體驗。

為什麼要將 IronPDF 與 BugSnag 合併？

將 IronPDF 與 BugSnag 搭配使用，可提升您維持文件管理系統品質的能力。 當 IronPDF 處理 PDF 產生與處理的繁重工作時，BugSnag 則擔任您的監護人，監控並擷取發生的任何異常或錯誤。

安裝 IronPdf 函式庫

為了開展工作，請確保 IronPDF 是您專案的一部分。 如果您正在使用 NuGet Package Manager，那就輕而易舉了。 只需在套件管理員控制台執行以下指令即可：

Install-Package IronPdf

此指令會取得 IronPDF 的最新版本，並將其與您的專案整合，為您開始產生和處理 PDF 做好準備。

您也可以使用 NuGet Package Manager 安裝 IronPDF 函式庫。 使用工具列上的工具功能表進入 NuGet Package Manager。 然後前往瀏覽索引標籤，搜尋 IronPdf。 點選 IronPdf 搜尋結果，然後按下安裝按鈕。 它會在您的專案中安裝 IronPdf 函式庫。

程式碼範例：在 IronPDF 上下文中使用 BugSnag 捕捉錯誤。

現在，讓我們來看看一個實例。 試想一下，您正在從 HTML 內容產生 PDF，並希望無縫捕捉和記錄任何潛在的問題。 以下是一個範例：

Ensure BugSnag is Configured（確認 BugSnag 已設定好）：在深入閱讀程式碼之前，請確認 BugSnag 已在您的專案中設定妥當。 您通常會在啟動組態中使用您的 API 金鑰註冊 BugSnag。

Generate PDF with Error Logging：在此步驟中，您將看到如何使用 IronPDF 從 HTML 生成 PDF，並隨附 BugSnag 以隨時捕捉任何錯誤。

using IronPdf;
using Bugsnag;

public class PdfGenerator
{
    private readonly IClient _bugsnagClient;

    public PdfGenerator(IClient bugsnagClient)
    {
        _bugsnagClient = bugsnagClient;
    }

    public void GeneratePdfFromHtml(string htmlContent)
    {
        try
        {
            // Use IronPDF to render HTML as PDF
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the rendered PDF to a file
            pdf.SaveAs("example.pdf");
        }
        catch (Exception ex)
        {
            // Notify Bugsnag of the exception
            _bugsnagClient.Notify(ex);

            // Optionally re-throw the exception for further handling
            throw;
        }
    }
}

using IronPdf;
using Bugsnag;

public class PdfGenerator
{
    private readonly IClient _bugsnagClient;

    public PdfGenerator(IClient bugsnagClient)
    {
        _bugsnagClient = bugsnagClient;
    }

    public void GeneratePdfFromHtml(string htmlContent)
    {
        try
        {
            // Use IronPDF to render HTML as PDF
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the rendered PDF to a file
            pdf.SaveAs("example.pdf");
        }
        catch (Exception ex)
        {
            // Notify Bugsnag of the exception
            _bugsnagClient.Notify(ex);

            // Optionally re-throw the exception for further handling
            throw;
        }
    }
}

Imports IronPdf
Imports Bugsnag

Public Class PdfGenerator
	Private ReadOnly _bugsnagClient As IClient

	Public Sub New(ByVal bugsnagClient As IClient)
		_bugsnagClient = bugsnagClient
	End Sub

	Public Sub GeneratePdfFromHtml(ByVal htmlContent As String)
		Try
			' Use IronPDF to render HTML as PDF
			Dim renderer = New ChromePdfRenderer()
			Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)

			' Save the rendered PDF to a file
			pdf.SaveAs("example.pdf")
		Catch ex As Exception
			' Notify Bugsnag of the exception
			_bugsnagClient.Notify(ex)

			' Optionally re-throw the exception for further handling
			Throw
		End Try
	End Sub
End Class

在本範例中，ChromePdfRenderer 用於將 HTML 內容轉換為 PDF。 如果出錯，BugSnag 的 Notify 方法會被呼叫，在不中斷應用程式流程的情況下記錄異常。