WatchDog is a Realtime Message, Event, HTTP (Request & Response) and Exception logger and viewer for ASP.Net Core Web Apps and APIs. It allows developers log and view messages, events, http requests made to their web application and also exception caught during runtime in their web applications, all in Realtime. It leverages SignalR for real-time monitoring and LiteDb a Serverless MongoDB-like database with no configuration with the option of using your external databases.
WatchDog is a Realtime Message, Event, HTTP (Request & Response) and Exception logger and viewer for ASP.Net Core Web Apps and APIs. It allows developers log and view messages, events, http requests made to their web application and also exception caught during runtime in their web applications, all in Realtime.
It leverages SignalR for real-time monitoring and LiteDb a Serverless MongoDB-like database with no configuration with the option of using your external databases (MSSQL, MySQl, Postgres, MongoDB).
General Features
RealTime HTTP Request, Response, and Exception Logger
In-code message and event logging
User Friendly Logger Views
Search Option for HTTP and Exception Logs
Filtering Option for HTTP Logs using HTTP Methods and StatusCode
Logger View Authentication
Auto Clear Logs Option
What's New
MongoDB Support
ILogger Support (Sink ILogger logs to WatchDog)
Trace/Event ID in Logs
Breaking Changes
SqlDriverOption is now DbDriverOption (>= 1.4.0)
Support
.NET Core 3.1 and newer
Installation
Install via .NET CLI
dotnet add package WatchDog.NET --version 1.4.7
Install via Package Manager
Install-Package WatchDog.NET --version 1.4.7
Usage
To enable WatchDog to listen for requests, use the WatchDog middleware provided by WatchDog.
Add WatchDog Namespace in Startup.cs
using WatchDog;
Register WatchDog service in Startup.cs under ConfigureService()
services.AddWatchDogServices();
Setup AutoClear Logs Optional
This clears the logs after a specific duration.
NOTE
When IsAutoClear = true
Default Schedule Time is set to Weekly, override the settings like below:
NOTE
If your project uses authentication, then app.UseWatchDog(); should come after app.UseRouting(), app.UseAuthentication(), app.UseAuthorization(), in that order
Optional Configurations: Optional
Blacklist: List of routes, paths or endpoints to be ignored (should be a comma separated string like below).
Serializer: If not default, specify the type of global json serializer/converter used
CorsPolicy: Policy Name if project uses CORS
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"
});
Add WatchDog Exception Logger Optional
This is used to log in-app exceptions that occur during a particular HTTP request.
NOTE
Add Exception Logger before the main WatchDog Middleware, preferably at the top of the middleware hierarchy so as to catch possible early exceptions.
