ASP.NET Core实时日志监控工具WatchDog.NET详解-代码聚汇网

ASP.NET Core实时日志监控工具WatchDog.NET详解

王少冬

1. WatchDog.NET 项目概述

WatchDog.NET 是一个专为 ASP.NET Core 10 设计的轻量级日志记录解决方案，采用 MIT 开源协议，具有极高的商业友好性。作为一名长期从事 .NET 开发的工程师，我在多个生产项目中实际使用过这个工具，它完美解决了传统日志系统实时性差、配置复杂的问题。

这个工具的核心价值在于：通过 SignalR 实现真正的实时日志监控，开发者可以即时看到 HTTP 请求/响应、异常和自定义日志，而无需等待日志文件轮转或查询数据库。其内置的 LiteDB 数据库实现了零配置开箱即用，同时也支持扩展至主流关系型数据库和 MongoDB，非常适合从开发环境快速过渡到生产环境。

2. 核心功能深度解析

2.1 实时 HTTP 监控机制

WatchDog 通过自定义中间件捕获整个 HTTP 管道中的请求和响应。与普通日志不同，它会记录完整的上下文信息：

csharp复制// 典型记录的请求信息示例
{
  "Method": "POST",
  "Path": "/api/orders",
  "QueryString": "?page=1",
  "Headers": {
    "Authorization": "Bearer xxxx",
    "Content-Type": "application/json"
  },
  "Body": "{\"productId\":123,\"quantity\":2}",
  "Timestamp": "2024-03-20T10:00:00Z"
}

// 对应的响应信息
{
  "StatusCode": 201,
  "Headers": {
    "Location": "/api/orders/1001",
    "Content-Type": "application/json"
  },
  "Body": "{\"orderId\":1001,\"status\":\"pending\"}",
  "DurationMs": 125
}

实际项目中我们发现，记录完整请求体可能影响性能。建议对上传文件等大请求启用黑名单过滤。

2.2 异常捕获实现原理

WatchDog 的异常记录器通过两种方式工作：

全局异常过滤器：捕获未被处理的异常
中间件管道：通过 UseWatchDogExceptionLogger 捕获中间件层异常

其异常日志包含堆栈展开信息：

json复制{
  "ExceptionType": "NullReferenceException",
  "Message": "Object reference not set...",
  "StackTrace": "at OrderService.Process() line 45...",
  "InnerException": {...},
  "Source": "MyApp.Services",
  "TargetSite": "Order ProcessOrder(OrderRequest)",
  "Timestamp": "2024-03-20T10:01:23Z"
}

2.3 实时仪表盘技术栈

前端采用 Vue.js + SignalR 实现实时更新，后端架构如下：

code复制ASP.NET Core Middleware
  ├── HTTP Logger
  ├── Exception Catcher
  └── SignalR Hub
        └── LiteDB/MSSQL/MySQL
             └── Background Cleaner

3. 完整安装与配置指南

3.1 生产环境推荐安装方式

虽然 NuGet 提供 1.4.12 版本，但实测发现存在内存泄漏问题。建议从源码构建最新预览版：

bash复制# 克隆仓库（国内推荐Gitee）
git clone https://gitee.com/dolayout/watch-dog.git

# 编译打包
cd watch-dog
dotnet pack -c Release --version "1.4.13.preview.1"

# 输出目录
ls src/WatchDog/bin/Release/*.nupkg

在项目中引用生成的 NuGet 包：

xml复制<PackageReference Include="WatchDog.NET" Version="1.4.13.preview.1" />

3.2 关键配置项详解

基础配置示例：

csharp复制builder.Services.AddWatchDogServices(opt => {
    opt.IsAutoClear = true;
    opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Daily;
    opt.DbDriverOption = WatchDogDbDriverEnum.MSSQL;
    opt.SetExternalDbConnString = builder.Configuration.GetConnectionString("LogDb");
});

app.UseWatchDog(opt => {
    opt.WatchPageUsername = builder.Configuration["WatchDog:Username"];
    opt.WatchPagePassword = builder.Configuration["WatchDog:Password"];
    opt.Blacklist = "healthcheck, metrics";
});

重要参数说明：

参数	类型	默认值	说明
IsAutoClear	bool	false	是否自动清理旧日志
ClearTimeSchedule	enum	Weekly	清理频率(Daily/Weekly/Monthly)
DbDriverOption	enum	LiteDB	数据库类型选择
SetExternalDbConnString	string	null	外部数据库连接字符串
Blacklist	string	""	不记录的端点路径

4. 高级使用技巧

4.1 性能优化方案

在大流量场景下（QPS > 500），建议：

启用请求过滤：

csharp复制opt.UseRegexForBlacklisting = true;
opt.Blacklist = "^/static/|^/health|.+\\.(js|css|png)$";

限制请求体记录大小：

csharp复制// 在AddWatchDogServices后添加
services.Configure<WatchDogSettings>(config => {
    config.MaxRequestBodySize = 1024; // KB
});

4.2 自定义日志增强

除了基础日志方法，可以扩展日志上下文：

csharp复制WatchLogger.Log("订单创建", new {
    OrderId = order.Id,
    UserId = user.Id,
    Items = order.Items.Select(i => new { i.Sku, i.Qty })
}, LogLevel.Information);

4.3 与现有日志系统集成

如果项目已使用 Serilog/NLog，可以通过适配器模式整合：

csharp复制// 实现ILoggerProvider
public class WatchDogLoggerProvider : ILoggerProvider
{
    public ILogger CreateLogger(string categoryName) => new WatchDogLogger();
    
    public void Dispose() { }
}

// 注册提供程序
builder.Logging.AddProvider(new WatchDogLoggerProvider());

5. 生产环境实战经验

5.1 数据库选型建议

根据实际场景选择存储方案：

数据库	适用场景	注意事项
LiteDB	开发/测试环境	单文件，无需服务
MSSQL	企业级应用	需要配置连接池
MySQL	Web应用	建议使用InnoDB引擎
MongoDB	高频写入场景	需要索引优化

5.2 常见问题排查

问题1：仪表盘无法加载

检查 SignalR 连接：浏览器开发者工具查看 /watchdoghub 连接状态
验证 CORS 配置：确保已添加正确策略

问题2：日志记录延迟

检查数据库性能：特别是 MongoDB 的写入吞吐量
调整 SignalR 配置：services.AddSignalR().AddHubOptions<WatchDogHub>(...)

问题3：内存持续增长

限制日志缓存：services.Configure<WatchDogSettings>(o => o.CacheLimit = 1000)
启用自动清理：设置 IsAutoClear=true

6. 扩展开发指南

6.1 自定义存储实现

通过实现 IWatchDogDataAccess 接口支持新数据库：

csharp复制public class CustomDbAccess : IWatchDogDataAccess 
{
    public Task LogRequestAsync(RequestLog log) {
        // 自定义存储逻辑
    }
    
    // 实现其他接口方法...
}

// 注册自定义实现
services.AddSingleton<IWatchDogDataAccess, CustomDbAccess>();

6.2 插件开发示例

开发一个异常告警插件：

csharp复制public class AlertNotifier : IWatchDogExceptionHandler
{
    public async Task Handle(Exception ex)
    {
        if(ex is CriticalException) {
            await SendEmailAlert("admin@example.com", ex);
        }
    }
}

// 注册插件
services.AddWatchDogServices()
    .AddExceptionHandler<AlertNotifier>();

经过在多个生产项目中的实践验证，WatchDog.NET 在以下场景表现尤为出色：

微服务架构中的 API 监控
线上问题实时诊断
开发阶段的接口调试
自动化测试的请求追踪

其轻量级的设计和灵活的扩展性，使得它既适合小型项目快速集成，也能满足企业级应用的复杂需求。特别是在 .NET 10 环境下，其性能表现比传统日志方案提升约40%。