ASP.NET 中如何使用Exceptionless分布式日志收集框架

# ASP.NET 中如何使用Exceptionless分布式日志收集框架

## 目錄
1. [什么是Exceptionless](#什么是exceptionless)
2. [Exceptionless核心功能](#exceptionless核心功能)
3. [環境準備](#環境準備)
4. [ASP.NET Core集成Exceptionless](#aspnet-core集成exceptionless)
   - [4.1 安裝NuGet包](#41-安裝nuget包)
   - [4.2 基礎配置](#42-基礎配置)
   - [4.3 高級配置](#43-高級配置)
5. [日志記錄實踐](#日志記錄實踐)
   - [5.1 基本日志記錄](#51-基本日志記錄)
   - [5.2 異常捕獲](#52-異常捕獲)
   - [5.3 自定義事件](#53-自定義事件)
6. [儀表板使用指南](#儀表板使用指南)
7. [性能優化建議](#性能優化建議)
8. [常見問題解答](#常見問題解答)
9. [總結](#總結)

## 什么是Exceptionless

Exceptionless是一個開源的分布式日志收集框架，專門為.NET應用程序設計。它提供實時錯誤報告、日志收集和應用監控功能，具有以下特點：

- 支持結構化日志記錄
- 提供強大的搜索和過濾功能
- 支持事件富化（添加額外上下文）
- 具備實時通知能力
- 提供直觀的儀表板

與ELK等日志系統相比，Exceptionless更專注于.NET生態，提供了更精細的錯誤分析和更簡單的集成方式。

## Exceptionless核心功能

1. **錯誤跟蹤**：自動捕獲未處理異常
2. **日志收集**：支持多級日志（Debug, Info, Warning, Error）
3. **事件富化**：自動收集請求頭、環境變量等上下文信息
4. **實時通知**：支持郵件、Slack等通知渠道
5. **趨勢分析**：識別錯誤發生頻率和模式

## 環境準備

### 部署選項
1. **SaaS服務**：直接使用官方托管服務（免費版有限制）
2. **自托管**：通過Docker或IIS部署（推薦生產環境使用）

```bash
# 使用Docker快速啟動自托管服務
docker run -d -p 5000:80 -p 5001:443 exceptionless/exceptionless:latest

ASP.NET Core要求

• .NET Core 3.1+
• 推薦使用最新LTS版本

ASP.NET Core集成Exceptionless

4.1 安裝NuGet包

dotnet add package Exceptionless.AspNetCore
dotnet add package Exceptionless

4.2 基礎配置

在Program.cs中添加服務注冊：

builder.Services.AddExceptionless(builder.Configuration["Exceptionless:ApiKey"]);

在appsettings.json中添加配置：

{
  "Exceptionless": {
    "ApiKey": "YOUR_API_KEY_HERE",
    "ServerUrl": "http://localhost:5000" // 自托管地址
  }
}

4.3 高級配置

// 自定義配置
ExceptionlessClient.Default.Configuration
    .SetDefaultMinLogLevel(LogLevel.Information)
    .UseInMemoryStorage()
    .UseReferenceIds();

// 添加自定義標簽
ExceptionlessClient.Default.CreateLog("AppStart").AddTags("Startup").Submit();

日志記錄實踐

5.1 基本日志記錄

// 控制器中使用
public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Home page visited at {Time}", DateTime.UtcNow);
        return View();
    }
}

5.2 異常捕獲

自動捕獲未處理異常：

// 在Program.cs中
app.UseExceptionless();

// 手動捕獲
try {
    // 可能出錯的代碼
} catch (Exception ex) {
    ex.ToExceptionless().Submit();
}

5.3 自定義事件

// 創建自定義事件
var eventBuilder = ExceptionlessClient.Default.CreateLog("CustomEvent")
    .SetMessage("用戶執行了關鍵操作")
    .SetProperty("UserId", user.Id)
    .SetGeo(latitude, longitude);

// 添加標簽和上下文
eventBuilder.AddTags("Security", "Audit")
    .AddObject(context.HttpContext.Request);

// 提交事件
eventBuilder.Submit();

儀表板使用指南

1. 事件查看：按時間、類型、標簽過濾
2. 錯誤分析：查看堆棧跟蹤和上下文數據
3. 趨勢圖表：分析錯誤頻率變化
4. 通知規則：配置閾值告警

性能優化建議

1. 批量提交：啟用UseInMemoryStorage()后自動批量處理
2. 日志級別控制：生產環境避免記錄Debug日志
3. 上下文精簡：只收集必要信息
4. 異步提交：默認已啟用，無需額外配置

// 性能優化配置示例
ExceptionlessClient.Default.Configuration
    .UseInMemoryStorage()
    .SetBatchSize(50)
    .SetBatchInterval(TimeSpan.FromSeconds(15));

常見問題解答

Q：如何過濾敏感信息？

ExceptionlessClient.Default.Configuration.AddDataExclusion(
    "Password", "CreditCard" // 排除包含這些字段的數據
);

Q：本地開發時如何禁用？

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionless();
}

Q：如何自定義錯誤分組？

ex.ToExceptionless()
    .SetUserIdentity(userId)
    .SetUserDescription(email, comment)
    .Submit();

總結

Exceptionless為ASP.NET Core應用提供了強大的日志收集和錯誤跟蹤能力。通過本文介紹，您應該能夠：

1. 完成基礎集成和配置
2. 記錄不同級別的日志信息
3. 有效利用儀表板分析問題
4. 優化日志收集性能

對于企業級應用，建議使用自托管方案并結合APM工具進行全方位監控。

延伸閱讀： - Exceptionless官方文檔 - ASP.NET Core日志最佳實踐 - 分布式日志系統比較 “`

注：實際使用時需要： 1. 替換YOUR_API_KEY_HERE為真實API Key 2. 更新自托管地址（如使用） 3. 補充實際的儀表板截圖URL 4. 根據實際.NET版本調整代碼示例