.NET 开源实时监控系统 - WatchDog - Powered by Discuz! Archiver

溜弯發表於 2024-8-27 11:14:00

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

<h2 data-tool="mdnice编辑器">前言</h2>
在平时的开发中随着我们系统应用不断地迭代变的复杂，对应用的实时监控变得越来越重要。实时监控不仅可以帮助我们快速定位问题，还能在出现问题时及时采取措施，减少业务中断的时间。
本文将介绍一个名为WatchDog的.NET开源实时应用监控系统，它可以帮助我们轻松实现对.NET应用的实时监控。
<h2 data-tool="mdnice编辑器">项目介绍</h2>
WatchDog是一个开源（MIT License）、免费的实时应用监控系统，专为ASP.NET Core Web应用程序和API设计。我们可以实时记录和查看应用程序中的消息、事件、HTTP请求和响应，以及运行时捕获的异常。
一个高效的监控系统不仅能提高应用的可用性和可靠性，还能帮助我们更快地解决问题。WatchDog是一款专为.NET应用设计的开源实时应用监控系统，它提供了一系列强大的功能来帮助我们监控应用的状态和性能。
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000428512-1388516627.png" width="700" loading="lazy" style="display: block; margin-left: auto; margin-right: auto">
<h2 data-tool="mdnice编辑器">功能特点</h2>
<ul>
<li data-tool="mdnice编辑器">实时日志记录：能够实时记录HTTP请求、响应以及运行时捕获的异常。</li>
<li data-tool="mdnice编辑器">代码内日志记录：支持在代码中记录消息和事件。</li>
<li data-tool="mdnice编辑器">日志视图查看：提供易于使用的日志查看界面。</li>
<li data-tool="mdnice编辑器">日志搜索功能：支持对HTTP请求和异常日志进行搜索。</li>
<li data-tool="mdnice编辑器">HTTP日志筛选：可根据HTTP方法和状态码筛选HTTP日志。</li>
<li data-tool="mdnice编辑器">日志视图认证：提供日志视图的访问权限控制。</li>
<li data-tool="mdnice编辑器">自动日志清理：支持自动清除旧的日志记录。</li>
<li data-tool="mdnice编辑器">报警通知：支持通过邮件、短信等多种方式发送报警通知，确保能够及时得到反馈。</li>
<li data-tool="mdnice编辑器">灵活配置：可以根据应用需求进行灵活的配置，适应不同的监控需求。</li>
<li data-tool="mdnice编辑器">易于集成：通过简单的API调用即可集成到现有的.NET应用中。</li>
</ul>
<h2 data-tool="mdnice编辑器">项目技术栈</h2>
<ul>
<li data-tool="mdnice编辑器">后端：基于.NET Core 或 .NET 5及以上版本。</li>
<li data-tool="mdnice编辑器">前端：使用 React 或 Angular等前端框架搭建的用户界面。</li>
<li data-tool="mdnice编辑器">数据库：支持MySQL、PostgreSQL等关系型数据库，以及MongoDB等NoSQL数据库。</li>
<li data-tool="mdnice编辑器">官方支持 .NET 8：新增对 .NET 8 的官方支持。</li>
<li data-tool="mdnice编辑器">.NET 8 中的 Output Cache 支持：增加了对 .NET 8 中使用 Output Cache 的支持。</li>
<li data-tool="mdnice编辑器">使用正则表达式黑名单：新增了使用正则表达式进行黑名单过滤的功能。</li>
</ul>
<h2 data-tool="mdnice编辑器">工作原理</h2>
WatchDog 利用 SignalR 实现了实时监控，并使用LiteDb作为无需配置的类似MongoDB的服务器端数据库，同时也支持使用外部数据库（如MSSQL、MySQL、PostgreSQL、MongoDB）。
<h3 data-tool="mdnice编辑器">1、支持.NET版本</h3>
.NET Core 3.1 及更高版本。
<h3 data-tool="mdnice编辑器">2、下载源码</h3>
通过下载源码，可以进行学习和应用，具体操作如下图所示：
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000605183-1782123077.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<h2>安装与配置</h2>
<h3 data-tool="mdnice编辑器">1、WatchDog 安装</h3>
搜索 <code>WatchDog.NET</code>NuGet包进行安装，具体如下图所示：
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000551803-1149807395.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<img alt="">
<h3 data-tool="mdnice编辑器">2、WatchDog 服务注册</h3>
在ASP.NET Core Web API 的<code>Program.cs</code>或 <code>Startup.cs</code>中注册 WatchDog 服务。
从ILogger 记录日志到 WatchDog
还可以将来自.NET的<code>ILogger</code>的日志记录到 WatchDog 中。
适用于 .NET 6 及以上版本
<div class="cnblogs_code">
<pre>builder.Services.AddWatchDogServices(opt =>
{
opt.IsAutoClear = true;
opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
opt.DbDriverOption = WatchDogDbDriverEnum.Mongo;
opt.SetExternalDbConnString = "mongodb://localhost:27017";
});
builder.Logging.AddWatchDogLogger();</pre>
</div>
对于 .NET Core 3.1
在 <code>Program.cs</code> 类的 <code>CreateHostBuilder</code> 方法中配置日志记录，并添加 <code>.AddWatchDogLogger()</code>。
<div class="cnblogs_code">
<pre>Host.CreateDefaultBuilder(args)
.ConfigureLogging( logging =>
{
logging.AddWatchDogLogger();
})
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});</pre>
</div>
<h3 data-tool="mdnice编辑器">3、添加异常记录器</h3>
在主要的WatchDog中间件之前添加异常日志记录器，最好将其放置在中间件的最上面，以便捕捉可能的早期异常。
<div class="cnblogs_code">
<pre>app.UseWatchDogExceptionLogger();

...

app.UseWatchDog(opt =>
{
opt.WatchPageUsername = "admin";
opt.WatchPagePassword = "Qwerty@123";
...
});</pre>
</div>
<h3 data-tool="mdnice编辑器">4、设置自动清除日志（可选）</h3>
该功能可在特定时间后自动清除日志。
注意：当<code>IsAutoClear</code>设置为<code>true</code>时，默认的清除计划时间为每周。
如需覆盖默认设置，请按照以下方式进行配置：
<div class="cnblogs_code">
<pre>services.AddWatchDogServices(opt =>
{
opt.IsAutoClear = true;
opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
});</pre>
</div>
<h3 data-tool="mdnice编辑器">5、设置日志记录到外部数据库（可选）</h3>
将日志记录到数据库，如SQL Server (MSSQL)、MySQL、PostgreSQL 或 MongoDB，可以根据需求配置。
<ul data-tool="mdnice编辑器">
<li>添加数据库连接字符串：提供数据库的连接字符串。</li>
<li>选择数据库驱动选项：根据所使用的数据库类型选择合适的驱动程序。</li>
</ul>
<div class="cnblogs_code">
<pre>services.AddWatchDogServices(opt =>
{
opt.IsAutoClear = true;
opt.SetExternalDbConnString = "Server=localhost;Database=testDb;
User Id=postgres;Password=root;";
opt.DbDriverOption = WatchDogDbDriverEnum.PostgreSql;
});</pre>
</div>
<h3 data-tool="mdnice编辑器">6、设置访问日志的账号密码</h3>
<div class="cnblogs_code">
<pre>app.UseWatchDog(opt =>
{
opt.WatchPageUsername = "admin";
opt.WatchPagePassword = "Qwerty@123";
});</pre>
</div>
注意：如果你的项目使用权限验证，那么 <code>app.UseWatchDog();</code> 应该在 <code>app.UseRouting()</code>, <code>app.UseAuthentication()</code>, 和 <code>app.UseAuthorization()</code> 之后按顺序添加。
<h3 data-tool="mdnice编辑器">7、配置说明和示例</h3>
<ul data-tool="mdnice编辑器">
<li>黑名单：要忽略的路由、路径或端点列表（应为逗号分隔的字符串，如下所示）。</li>
<li>序列化器：如果不使用默认的全局 JSON 序列化器/转换器，请指定类型。</li>
<li>CORS策略：如果项目使用了跨源资源共享（CORS），请指定策略名称。</li>
<li>使用Output缓存：如果项目使用了ASP.NET Output缓存。功能仅适用于 .NET 8 及以上版本。</li>
<li>使用正则表达式黑名单：启用使用正则表达式来黑名单化请求路由、路径或端点。</li>
</ul>
示例配置
<div class="cnblogs_code">
<pre>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;
});</pre>
</div>
<h3 data-tool="mdnice编辑器">8、记录消息/事件</h3>
<div class="cnblogs_code">
<pre>WatchLogger.Log("...Test Log...");
WatchLogger.LogWarning(JsonConvert.Serialize(model));
WatchLogger.LogError(res.Content, eventId: reference);</pre>
</div>
<h3 data-tool="mdnice编辑器">9、查看日志和异常</h3>
启动服务器并访问 <code>/watchdog</code> 来查看日志。
示例：
<div class="cnblogs_code">
<pre>https://myserver.com/watchdog
https://localhost:/watchdog</pre>
</div>
<h2 data-tool="mdnice编辑器">项目效果</h2>
<h3 data-tool="mdnice编辑器">1、WatchDog登录</h3>
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000616044-620086039.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<img alt="">
<h3 data-tool="mdnice编辑器">2、WatchDog 日志</h3>
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000610819-290977633.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<img alt="">
<h3 data-tool="mdnice编辑器">3、请求日志</h3>
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000622483-922049654.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<img alt="">
<h3 data-tool="mdnice编辑器">4、消息/事件</h3>
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240826000632068-514733386.png" width="700" style="display: block; margin-left: auto; margin-right: auto">
<img alt="">
<h2 data-tool="mdnice编辑器">项目地址</h2>
Github：https://github.com/IzyPro/WatchDog
<h2 data-tool="mdnice编辑器">总结</h2>
WatchDog 是一款强大且易于使用的.NET开源实时应用监控系统。通过使用WatchDog，我们可以轻松实现对.NET应用的实时监控，提高应用的稳定性和可靠性。希望这篇文章能够帮助你更好地理解和使用WatchDog。
<h2 class="md-end-block md-p">最后</h2>
如果你觉得这篇文章对你有帮助，不妨点个赞支持一下！你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助，欢迎随时留言。
也可以加入微信公众号 社区，与其他热爱技术的同行一起交流心得，共同成长！
<img src="https://img2024.cnblogs.com/blog/576536/202408/576536-20240814113403514-910171896.png" alt="" style="display: block; margin-left: auto; margin-right: auto"> 
来源：https://www.cnblogs.com/1312mn/p/18379779

頁: [1]

琼殿技术论坛's Archiver

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