.NET 开源实时监控系统 - WatchDog

builder.Services.AddWatchDogServices(opt =>  
{  
    opt.IsAutoClear = true;  
    opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;  
    opt.DbDriverOption = WatchDogDbDriverEnum.Mongo;  
    opt.SetExternalDbConnString = "mongodb://localhost:27017";  
});  
builder.Logging.AddWatchDogLogger();

对于 .NET Core 3.1

在 Program.cs 类的 CreateHostBuilder 方法中配置日志记录，并添加 .AddWatchDogLogger()。

Host.CreateDefaultBuilder(args)
 .ConfigureLogging( logging =>
 {
     logging.AddWatchDogLogger();
 })
 .ConfigureWebHostDefaults(webBuilder =>
 {
     webBuilder.UseStartup<Startup>();
 });

3、添加异常记录器

在主要的WatchDog中间件之前添加异常日志记录器，最好将其放置在中间件的最上面，以便捕捉可能的早期异常。

app.UseWatchDogExceptionLogger();

...

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
   ...
 });

4、设置自动清除日志（可选）

该功能可在特定时间后自动清除日志。

注意：当IsAutoClear设置为true时，默认的清除计划时间为每周。

如需覆盖默认设置，请按照以下方式进行配置：

services.AddWatchDogServices(opt => 
{ 
   opt.IsAutoClear = true;
   opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
});

5、设置日志记录到外部数据库（可选）

将日志记录到数据库，如SQL Server (MSSQL)、MySQL、PostgreSQL 或 MongoDB，可以根据需求配置。

添加数据库连接字符串：提供数据库的连接字符串。
选择数据库驱动选项：根据所使用的数据库类型选择合适的驱动程序。

services.AddWatchDogServices(opt => 
{
   opt.IsAutoClear = true; 
   opt.SetExternalDbConnString = "Server=localhost;Database=testDb;
   User Id=postgres;Password=root;"; 
   opt.DbDriverOption = WatchDogDbDriverEnum.PostgreSql; 
});

6、设置访问日志的账号密码

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
 });

注意：如果你的项目使用权限验证，那么 app.UseWatchDog(); 应该在 app.UseRouting(), app.UseAuthentication(), 和 app.UseAuthorization() 之后按顺序添加。

7、配置说明和示例

黑名单：要忽略的路由、路径或端点列表（应为逗号分隔的字符串，如下所示）。
序列化器：如果不使用默认的全局 JSON 序列化器/转换器，请指定类型。
CORS策略：如果项目使用了跨源资源共享（CORS），请指定策略名称。
使用Output缓存：如果项目使用了ASP.NET Output缓存。功能仅适用于 .NET 8 及以上版本。
使用正则表达式黑名单：启用使用正则表达式来黑名单化请求路由、路径或端点。

示例配置

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
   //Optional
   opt.Blacklist = "Test/testPost, api/auth/login"; 
   //Prevent logging for specified endpoints
   opt.Serializer = WatchDogSerializerEnum.Newtonsoft; 
   //If your project use a global json converter
   opt.CorsPolicy = "MyCorsPolicy";
   opt.UseOutputCache = true;
   opt.UseRegexForBlacklisting = true;
 });

8、记录消息/事件

WatchLogger.Log("...Test Log...");
WatchLogger.LogWarning(JsonConvert.Serialize(model));
WatchLogger.LogError(res.Content, eventId: reference);

9、查看日志和异常

启动服务器并访问 /watchdog 来查看日志。

示例：

https://myserver.com/watchdog
https://localhost:[your-port]/watchdog

项目效果

1、WatchDog登录

2、WatchDog 日志

3、请求日志

4、消息/事件

项目地址

Github：https://github.com/IzyPro/WatchDog

总结

WatchDog 是一款强大且易于使用的.NET开源实时应用监控系统。通过使用WatchDog，我们可以轻松实现对.NET应用的实时监控，提高应用的稳定性和可靠性。希望这篇文章能够帮助你更好地理解和使用WatchDog。

最后

如果你觉得这篇文章对你有帮助，不妨点个赞支持一下！你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助，欢迎随时留言。

也可以加入微信公众号[DotNet技术匠] 社区，与其他热爱技术的同行一起交流心得，共同成长！

标签：opt,数据库,实时,开源,WatchDog,NET,日志
From： https://blog.csdn.net/u012573563/article/details/141559563

.NET 开源实时监控系统 - WatchDog

前言

项目介绍

功能特点

项目技术栈

工作原理

1、支持.NET版本

2、下载源码

安装与配置

1、WatchDog 安装

2、WatchDog 服务注册