ASP .NET CORE 6 在项目中集成WatchDog开源项目

概念

WatchDog是一个开源的项目,可以实现对.Net 应用程序和API实现实时应用日志和性能监控平台。可以实现实时记录和查看应用程序中的消息、事件、HTTP请求和响应,以及运行时捕获的异常,有效帮助开发人员去排查应用异常,提升开发效率和减低运维成本。

项目集成

1、安装 WatchDog 包

可以使用 NuGet 包管理器来安装它:

复制代码
dotnet add package WatchDog
2、配置WatchDog

在程序主入口Pragram.cs里配置:

复制代码
//整合WatchDog:性能异常监控
builder.Services.AddWatchDogServices(option =>
{
    option.IsAutoClear = true;
    option.ClearTimeSchedule = WatchDog.src.Enums.WatchDogAutoClearScheduleEnum.Hourly;
});
builder.Logging.AddWatchDogLogger();
3、启用WatchDog

在Pragram.cs文件里启用WatchDog中间件和配置登录的账号密码:

复制代码
//添加WatchDog
app.UseWatchDogExceptionLogger();
app.UseWatchDog(config =>
{
    config.WatchPageUsername = "admin";
    config.WatchPagePassword = "123456";   
});

app.Run();

运行测试

启动项目运行

访问https://localhost:8085/watchdog 对应自己应用的地址和端口,可以看到WatchDog的登录界面,使用设置的账号密码登录

使用WatchDog功能

踩坑异常解决

异常

如果你运行项目时也出现如下异常:

fail: Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware1 An unhandled exception has occurred while executing the request. System.InvalidOperationException: Property 'JsonResult.SerializerSettings' must be an instance of type 'Newtonsoft.Json.JsonSerializerSettings'. at Microsoft.AspNetCore.Mvc.NewtonsoftJson.NewtonsoftJsonResultExecutor.GetSerializerSettings(JsonResult result) at Microsoft.AspNetCore.Mvc.NewtonsoftJson.NewtonsoftJsonResultExecutor.ExecuteAsync(ActionContext context, JsonResult result) at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeResultAsync>g__Logged|22_0(ResourceInvoker invoker, IActionResult result) at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeResultFilters>g__Awaited|28_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted) at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeFilterPipelineAsync>g__Awaited|20_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted) at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeAsync>g__Logged|17_1(ResourceInvoker invoker) at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeAsync>g__Logged|17_1(ResourceInvoker invoker) at Microsoft.AspNetCore.Routing.EndpointMiddleware.<Invoke>g__AwaitRequestTask|6_0(Endpoint endpoint, Task requestTask, ILogger logger) at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context) at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context) at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context) at WatchDog.src.WatchDog.InvokeAsync(HttpContext context) at WatchDog.src.WatchDogExceptionLogger.InvokeAsync(HttpContext context) at WatchDog.src.WatchDogExceptionLogger.InvokeAsync(HttpContext context) at StackExchange.Profiling.MiniProfilerMiddleware.Invoke(HttpContext context)

解决

这个问题通常出现在 ASP.NET Core 项目中,当项目中使用了 Microsoft.AspNetCore.Mvc.NewtonsoftJson 包来处理 JSON 序列化时,可能会与其他包或配置产生冲突,这里时因为与WatchDog默认的序列化配置冲突,需要设置WatchDog的序列化采用NewtonsoftJson。

代码修复如下,在Pragram.cs文件里启用WatchDog中间件和配置登录的账号密码时,设置WatchDog的序列化为NewtonsoftJson:

复制代码
app.UseWatchDog(config =>
{
    config.WatchPageUsername = "admin";
    config.WatchPagePassword = "123456";
    //设置序列化采用Newtonsoft
    config.Serializer = WatchDog.src.Enums.WatchDogSerializerEnum.Newtonsoft;
});

重新运行,登录WatchDog界面,控制器没有前面的异常打印输出,说明异常已解决修复。

总结:

很好用的一个开源项目,有助于开发者,方便实时记录和查看一些信息。

相关推荐
风云3 小时前
从 NLite 到 Vane.Container 1.0:压箱十六年的自研 DI 容器开源
.net·di·mini 容器·nlite
Risehuxyc4 小时前
C# 发展历史
开发语言·c#
kyle~6 小时前
C# --- 反射
开发语言·c#
Jeff-Tsai10 小时前
Day 21:业务逻辑定制与 Plugin 的四个时点
.net·架构设计·erp·definition-driven
IT规划师11 小时前
Redis 核心机制 | 键生命周期与 TTL 管理
redis·.net
暴走约伯1 天前
【VFX工具链源码拆解 09】终极工业化闭环:基于 ID 规则驱动的全自动场景建档、骨骼挂载与男转女场景迁移
unity·c#·游戏引擎·材质
Jeff-Tsai1 天前
Day 20:多语言定制与资源结构
.net·架构设计·erp·definition-driven
用户788477316342 天前
WinForms 迁移 WPF:Upgrade Assistant 覆盖 30%,剩下 70% 我手写了六周
c#
寂寞的船2 天前
【Unity知识速递】第13期 Unity 内存泄漏排查实战:从 Memory Profiler 到 Lua 引用泄漏的生产级全链路诊断
unity·junit·c#·游戏引擎·lua
Jeff-Tsai2 天前
Day 19:定制层的范围与叠加粒度
.net·架构设计·erp·definition-driven