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

在 .NET 專案中配置 Bugsnag C

首先，您需要將 Bugsnag 新增到您的專案中。 這是透過從 NuGet（.NET 的套件管理器）安裝 Bugsnag 套件來實現的。 在 Visual Studio 中開啟 NuGet 控制台。 運行以下命令：

Install-Package Bugsnag

Bugsnag C#（開發者使用方法）：圖 1 - 透過 Visual Studio 中的 NuGet 控制台安裝 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);
            }
        }
    }
}

此程式碼片段示範如何在簡單的 .NET 控制台應用程式中設定 Bugsnag。 Bugsnag 通知器的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);

此配置可確保監控每個會話，並自動報告任何未捕獲的異常，從而為您提供應用程式穩定性的全面概覽。

詳細錯誤控制的配置選項

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

這種設定有助於專注於對應用程式最重要的錯誤，同時確保用戶隱私和資料安全。

利用用戶資料和元資料增強錯誤報告

在錯誤報告中添加用戶資訊和自訂元數據可以提供有價值的上下文訊息，從而更容易診斷和解決問題。 以下是如何改進錯誤報告的方法：

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

這段程式碼片段會將使用者詳細資料和有關訂單的自訂元資料新增至每個錯誤報告。 了解這些補充資訊對於理解導致錯誤的具體情況至關重要。

透過利用 Bugsnag C# 的這些功能，您可以更深入地了解影響應用程式的錯誤，根據實際使用者影響確定修復的優先級，並最終提高軟體的可靠性和使用者體驗。

為什麼要將 IronPDF 與 BugSnag 合併？

將 IronPDF 與 BugSnag 結合使用，可以提升您在文件管理系統中維護品質的能力。 IronPDF 負責處理繁重的 PDF 生成和操作工作，而 BugSnag 則充當您的守護者，監控並捕獲發生的任何異常或錯誤。

安裝 IronPDF 庫

首先，請確保 IronPDF 已整合到您的專案中。 如果你使用 NuGet 套件管理器，那就輕而易舉了。 只需在軟體包管理器控制台中執行以下命令：

Install-Package IronPdf

此命令會取得最新版本的 IronPDF 並將其整合到您的專案中，為您開始產生和操作 PDF 做好準備。

您也可以使用 NuGet 套件管理器安裝 IronPDF 庫。 使用工具列上的工具功能表開啟 NuGet 套件管理器。 然後轉到瀏覽選項卡並蒐索 IronPDF。 點擊 IronPDF 搜尋結果，然後點擊安裝按鈕。 它會將 IronPDF 庫安裝到您的專案中。

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

現在，讓我們來看一個實際例子。 假設您正在根據 HTML 內容產生 PDF，並且希望無縫地捕獲和記錄任何潛在問題。 以下是一個例子：

確保 BugSnag 已設定：在深入程式碼之前，請確保 BugSnag 已在您的專案中正確設定。 通常情況下，您需要在啟動配置中完成此操作，使用您的 API 金鑰註冊 BugSnag。

產生具有錯誤日誌記錄的 PDF：在此步驟中，您將看到如何使用 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;
        }
    }
}

在這個例子中， ChromePdfRenderer用於將 HTML 內容轉換為 PDF。 如果出現問題，將呼叫 BugSnag 的Notify方法，記錄異常，而不會中斷應用程式流程。