Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IzyPro/WatchDog
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.
https://github.com/IzyPro/WatchDog
devtools dotnet insights logging monitoring package web
Last synced: 11 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/IzyPro/WatchDog
- Owner: IzyPro
- License: mit
- Created: 2022-01-31T05:30:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T00:21:07.000Z (7 months ago)
- Last Synced: 2024-05-16T12:32:37.141Z (6 months ago)
- Topics: devtools, dotnet, insights, logging, monitoring, package, web
- Language: C#
- Homepage:
- Size: 12.1 MB
- Stars: 570
- Watchers: 13
- Forks: 81
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - IzyPro/WatchDog - 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. (C\#)
README
# 
# WatchDog
[](https://github.com/IzyPro/WatchDog)
[](https://www.nuget.org/packages/WatchDog.NET#versions-tab)
[](https://www.nuget.org/packages/WatchDog.NET#versions-tab)
[](https://github.com/IzyPro/WatchDog/blob/main/LICENSE)
[](https://twitter.com/intent/tweet?hashtags=WatchDog&original_referer=https%3A%2F%2Fdeveloper.twitter.com%2F&ref_src=twsrc%5Etfw%7Ctwcamp%5Ebuttonembed%7Ctwterm%5Eshare%7Ctwgr%5E&related=twitterapi%2Ctwitter&text=Hello%2C%20world!%0DCheck%20out%20this%20awesome%20developer%20tool&url=https%3A%2F%2Fgithub.com%2FIzyPro%2FWatchDog&via=HQWatchdog)
## Introduction
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
- Official support for .NET8
- Support for .NET8 UseOutputCache
- Blacklisting using Regex
- Bug Fixes
### Breaking Changes
- SqlDriverOption is now DbDriverOption (>= v1.4.0)
## Support
- .NET Core 3.1 and newer
## Installation
Install via .NET CLI
```bash
dotnet add package WatchDog.NET --version 1.4.11
```
Install via Package Manager
```bash
Install-Package WatchDog.NET --version 1.4.11
```
## Usage
To enable WatchDog to listen for requests, use the WatchDog middleware provided by WatchDog.
Add WatchDog Namespace in `Startup.cs`
```c#
using WatchDog;
```
### Register WatchDog service in `Startup.cs` under `ConfigureService()`
```c#
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:
```c#
services.AddWatchDogServices(opt =>
{
opt.IsAutoClear = true;
opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
});
```
### Setup Logging to External Db (MSSQL, MySQL, PostgreSQL & MongoDb) `Optional`
Add Database Connection String and Choose DbDriver Option
```c#
services.AddWatchDogServices(opt =>
{
opt.IsAutoClear = true;
opt.SetExternalDbConnString = "Server=localhost;Database=testDb;User Id=postgres;Password=root;";
opt.DbDriverOption = WatchDogDbDriverEnum.PostgreSql;
});
```
### Add WatchDog middleware in the HTTP request pipeline in `Startup.cs` under `Configure()`
# 
>**NOTE**
>Add Authentication option like below: `Important`
This authentication information (Username and Password) will be used to access the log viewer.
```c#
app.UseWatchDog(opt =>
{
opt.WatchPageUsername = "admin";
opt.WatchPagePassword = "Qwerty@123";
});
```
>**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.
- UseOutputCache: If your application uses [ASP.NET Output Cache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/output). This feature is only available for .NET8 and above.
- UseRegexForBlacklisting: Enables the use of Regex to blacklist request routes, paths or endpoints.
```c#
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;
});
```
#### 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.
```c#
app.UseWatchDogExceptionLogger();
...
app.UseWatchDog(opt =>
{
opt.WatchPageUsername = "admin";
opt.WatchPagePassword = "Qwerty@123";
...
});
```
### Log Messages/Events
```
WatchLogger.Log("...Test Log...");
WatchLogger.LogWarning(JsonConvert.Serialize(model));
WatchLogger.LogError(res.Content, eventId: reference);
```
# 
#### Sink Logs from ILogger
You can also sink logs from the .NET ILogger into WatchDog
For .NET 6 and above
```
builder.Logging.AddWatchDogLogger();
```
For .NET Core 3.1, configure logging and add `.AddWatchDogLogger()` to the `CreateHostBuilder` method of the `Program.cs` class
```
Host.CreateDefaultBuilder(args)
.ConfigureLogging( logging =>
{
logging.AddWatchDogLogger();
})
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup();
});
```
### View Logs and Exception
Start your server and head to `/watchdog` to view the logs.
>Example: https://myserver.com/watchdog or https://localhost:[your-port]/watchdog
Still confused? Check out the implementation in the [WatchDogCompleteTestAPI](https://github.com/IzyPro/WatchDog/tree/main/WatchDogCompleteTestAPI) folder or the .NET 6 implementation in the [WatchDogCompleteApiNet6](https://github.com/IzyPro/WatchDog/tree/main/WatchDogCompleteApiNet6) folder.
## Contribution
Feel like something is missing? Fork the repo and send a PR.
Encountered a bug? Fork the repo and send a PR.
Alternatively, open an issue and we'll get to it as soon as we can.
## Credit
Kelechi Onyekwere - [Github](https://github.com/Khelechy) [Twitter](https://twitter.com/khelechy1337)
Israel Ulelu - [Github](https://github.com/IzyPro) [Twitter](https://twitter.com/IzyPro_)