翼度科技»论坛 编程开发 .net 查看内容

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

6

主题

6

帖子

18

积分

新手上路

Rank: 1

积分
18
前言

在平时的开发中随着我们系统应用不断地迭代变的复杂,对应用的实时监控变得越来越重要。实时监控不仅可以帮助我们快速定位问题,还能在出现问题时及时采取措施,减少业务中断的时间。
本文将介绍一个名为WatchDog的.NET开源实时应用监控系统,它可以帮助我们轻松实现对.NET应用的实时监控。
项目介绍

WatchDog是一个开源(MIT License)、免费的实时应用监控系统,专为ASP.NET Core Web应用程序和API设计。我们可以实时记录和查看应用程序中的消息、事件、HTTP请求和响应,以及运行时捕获的异常。
一个高效的监控系统不仅能提高应用的可用性和可靠性,还能帮助我们更快地解决问题。WatchDog是一款专为.NET应用设计的开源实时应用监控系统,它提供了一系列强大的功能来帮助我们监控应用的状态和性能。

功能特点


  • 实时日志记录:能够实时记录HTTP请求、响应以及运行时捕获的异常。
  • 代码内日志记录:支持在代码中记录消息和事件。
  • 日志视图查看:提供易于使用的日志查看界面。
  • 日志搜索功能:支持对HTTP请求和异常日志进行搜索。
  • HTTP日志筛选:可根据HTTP方法和状态码筛选HTTP日志。
  • 日志视图认证:提供日志视图的访问权限控制。
  • 自动日志清理:支持自动清除旧的日志记录。
  • 报警通知:支持通过邮件、短信等多种方式发送报警通知,确保能够及时得到反馈。
  • 灵活配置:可以根据应用需求进行灵活的配置,适应不同的监控需求。
  • 易于集成:通过简单的API调用即可集成到现有的.NET应用中。
项目技术栈


  • 后端:基于.NET Core 或 .NET 5及以上版本。
  • 前端:使用 React 或 Angular等前端框架搭建的用户界面。
  • 数据库:支持MySQL、PostgreSQL等关系型数据库,以及MongoDB等NoSQL数据库。
  • 官方支持 .NET 8:新增对 .NET 8 的官方支持。
  • .NET 8 中的 Output Cache 支持:增加了对 .NET 8 中使用 Output Cache 的支持。
  • 使用正则表达式黑名单:新增了使用正则表达式进行黑名单过滤的功能。
工作原理

WatchDog 利用 SignalR 实现了实时监控,并使用LiteDb作为无需配置的类似MongoDB的服务器端数据库,同时也支持使用外部数据库(如MSSQL、MySQL、PostgreSQL、MongoDB)。
1、支持.NET版本

.NET Core 3.1 及更高版本。
2、下载源码

通过下载源码,可以进行学习和应用,具体操作如下图所示:

安装与配置

1、WatchDog 安装

搜索 WatchDog.NETNuGet包进行安装,具体如下图所示:

<img alt="">
2、WatchDog 服务注册

在ASP.NET Core Web API 的Program.cs或 Startup.cs中注册 WatchDog 服务。
从ILogger 记录日志到 WatchDog
还可以将来自.NET的ILogger的日志记录到 WatchDog 中。
适用于 .NET 6 及以上版本
  1. builder.Services.AddWatchDogServices(opt =>  
  2. {  
  3.     opt.IsAutoClear = true;  
  4.     opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;  
  5.     opt.DbDriverOption = WatchDogDbDriverEnum.Mongo;  
  6.     opt.SetExternalDbConnString = "mongodb://localhost:27017";  
  7. });  
  8. builder.Logging.AddWatchDogLogger();  
复制代码
对于 .NET Core 3.1
在 Program.cs 类的 CreateHostBuilder 方法中配置日志记录,并添加 .AddWatchDogLogger()。
  1. Host.CreateDefaultBuilder(args)
  2. .ConfigureLogging( logging =>
  3. {
  4.      logging.AddWatchDogLogger();
  5. })
  6. .ConfigureWebHostDefaults(webBuilder =>
  7. {
  8.      webBuilder.UseStartup<Startup>();
  9. });
复制代码
3、添加异常记录器

在主要的WatchDog中间件之前添加异常日志记录器,最好将其放置在中间件的最上面,以便捕捉可能的早期异常。
  1. app.UseWatchDogExceptionLogger();
  2. ...
  3. app.UseWatchDog(opt =>
  4. {
  5.    opt.WatchPageUsername = "admin";
  6.    opt.WatchPagePassword = "Qwerty@123";
  7.    ...
  8. });
复制代码
4、设置自动清除日志(可选)

该功能可在特定时间后自动清除日志。
注意:当IsAutoClear设置为true时,默认的清除计划时间为每周。
如需覆盖默认设置,请按照以下方式进行配置:
  1. services.AddWatchDogServices(opt =>
  2. {
  3.    opt.IsAutoClear = true;
  4.    opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
  5. });
复制代码
5、设置日志记录到外部数据库(可选)

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

  • 添加数据库连接字符串:提供数据库的连接字符串。
  • 选择数据库驱动选项:根据所使用的数据库类型选择合适的驱动程序。
  1. services.AddWatchDogServices(opt =>
  2. {
  3.    opt.IsAutoClear = true;
  4.    opt.SetExternalDbConnString = "Server=localhost;Database=testDb;
  5.    User Id=postgres;Password=root;";
  6.    opt.DbDriverOption = WatchDogDbDriverEnum.PostgreSql;
  7. });
复制代码
6、设置访问日志的账号密码
  1. app.UseWatchDog(opt =>
  2. {
  3.    opt.WatchPageUsername = "admin";
  4.    opt.WatchPagePassword = "Qwerty@123";
  5. });
复制代码
注意:如果你的项目使用权限验证,那么 app.UseWatchDog(); 应该在 app.UseRouting(), app.UseAuthentication(), 和 app.UseAuthorization() 之后按顺序添加。
7、配置说明和示例


  • 黑名单:要忽略的路由、路径或端点列表(应为逗号分隔的字符串,如下所示)。
  • 序列化器:如果不使用默认的全局 JSON 序列化器/转换器,请指定类型。
  • CORS策略:如果项目使用了跨源资源共享(CORS),请指定策略名称。
  • 使用Output缓存:如果项目使用了ASP.NET Output缓存。功能仅适用于 .NET 8 及以上版本。
  • 使用正则表达式黑名单:启用使用正则表达式来黑名单化请求路由、路径或端点。
示例配置
  1. app.UseWatchDog(opt =>
  2. {
  3.    opt.WatchPageUsername = "admin";
  4.    opt.WatchPagePassword = "Qwerty@123";
  5.    //Optional
  6.    opt.Blacklist = "Test/testPost, api/auth/login";
  7.    //Prevent logging for specified endpoints
  8.    opt.Serializer = WatchDogSerializerEnum.Newtonsoft;
  9.    //If your project use a global json converter
  10.    opt.CorsPolicy = "MyCorsPolicy";
  11.    opt.UseOutputCache = true;
  12.    opt.UseRegexForBlacklisting = true;
  13. });
复制代码
8、记录消息/事件
  1. WatchLogger.Log("...Test Log...");
  2. WatchLogger.LogWarning(JsonConvert.Serialize(model));
  3. WatchLogger.LogError(res.Content, eventId: reference);
复制代码
9、查看日志和异常

启动服务器并访问 /watchdog 来查看日志。
示例
  1. https://myserver.com/watchdog
  2. https://localhost:[your-port]/watchdog
复制代码
项目效果

1、WatchDog登录


<img alt="">
2、WatchDog 日志


<img alt="">
3、请求日志


<img alt="">
4、消息/事件


<img alt="">
项目地址

Github:https://github.com/IzyPro/WatchDog
总结

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

如果你觉得这篇文章对你有帮助,不妨点个赞支持一下!你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助,欢迎随时留言。
也可以加入微信公众号[DotNet技术匠] 社区,与其他热爱技术的同行一起交流心得,共同成长!


来源:https://www.cnblogs.com/1312mn/p/18379779
免责声明:由于采集信息均来自互联网,如果侵犯了您的权益,请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x

举报 回复 使用道具