WatchDog.NET 1.0.0

Prefix Reserved

This package has been deprecated as it has critical bugs.

Additional Details

The static files required to display the viewer is being ignored by nuget.
We are currently working on a fix and a new version will be provided as soon as possible

There is a newer version of this package available.
See the version list below for details.

dotnet add package WatchDog.NET --version 1.0.0

NuGet\Install-Package WatchDog.NET -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="WatchDog.NET" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add WatchDog.NET --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: WatchDog.NET, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install WatchDog.NET as a Cake Addin
#addin nuget:?package=WatchDog.NET&version=1.0.0

// Install WatchDog.NET as a Cake Tool
#tool nuget:?package=WatchDog.NET&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

WatchDog

Introduction

WatchDog is a Realtime HTTP (Request & Response) and Exception logger and viewer for ASP.Net Core Web Apps and APIs. It allows developers log and view http requests made to their web application and also exception caught during runtime in their web applications in Realtime. It leverages on LiteDb a Serverless MongoDB-like database with no configuration and SignalR for real-time monitoring.

General Features

RealTime HTTP Request and Response Logger
RealTime Exception Logger
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

Installation

Install via .NET CLI

dotnet add package WatchDog --version 1.0.0

Install via Package Manager

Install-Package WatchDog --version 1.0.0

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.

services.AddWatchDogServices(opt => 
{ 
   opt.IsAutoClear = true; 
});

NOTE When IsAutoClear = true Default Schedule Time is set to Weekly, override the settings like below:

services.AddWatchDogServices(opt => 
{ 
   opt.IsAutoClear = true;
   opt.ClearTimeSchedule = WatchDogAutoClearScheduleEnum.Monthly;
});

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.

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
 });

Add list of routes you want to ignore by the logger: `Optional`

List of routes, paths or specific strings to be ignored should be a comma separated string like below.

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
   opt.Blacklist = "Test/testPost, weatherforecast";
 });

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

app.UseWatchDogExceptionLogger();

app.UseWatchDog(opt => 
{ 
   opt.WatchPageUsername = "admin"; 
   opt.WatchPagePassword = "Qwerty@123"; 
   opt.Blacklist = "Test/testPost, weatherforecast";
 });

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 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 Twitter

Israel Ulelu - Github Twitter

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp3.1 is compatible.

Product

.NET

.NET Core

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETCoreApp 3.1
- LiteDB (>= 5.0.11)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.Mvc (>= 2.2.0)
- Microsoft.AspNetCore.Routing (>= 2.2.2)
- Microsoft.AspNetCore.SignalR (>= 1.1.0)
- Microsoft.AspNetCore.SignalR.Core (>= 1.1.0)
- Microsoft.AspNetCore.StaticFiles (>= 2.2.0)
- Microsoft.Extensions.FileProviders.Abstractions (>= 3.1.22)
- Microsoft.Extensions.FileProviders.Embedded (>= 3.1.22)
- Microsoft.Extensions.FileProviders.Physical (>= 3.1.22)
- Microsoft.Extensions.Logging.Abstractions (>= 3.1.22)
- Microsoft.IO.RecyclableMemoryStream (>= 2.2.0)
- Newtonsoft.Json (>= 13.0.1)

NuGet packages (7)

Showing the top 5 NuGet packages that depend on WatchDog.NET:

Package	Downloads
GuoKun.CPS 国坤CPS库	187.9K
LC.Web.Base LC.Web.Base	13.0K
Chaosage.Core.Setup Chaosage开发平台API配置规范	7.5K
Szyj.MicroService.Api.Basic 尚哲医健微服务api.host基架,去掉 Abp.Autofac	547
PluginCore.Plugins.WatchDogPlugin PluginCore Plugins: WatchDogPlugin	494

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.4.11	13,722	3/31/2024
1.4.10	31,935	5/19/2023
1.4.7	5,605	4/19/2023
1.4.6	22,521	2/16/2023
1.4.3	11,659	2/1/2023
1.4.2	3,914	1/18/2023
1.4.1	1,223	1/17/2023
1.4.0	1,688	1/16/2023
1.3.3	13,168	12/14/2022
1.3.3-rc	1,494	11/7/2022
1.3.2	24,775	9/18/2022
1.3.1	5,935	8/9/2022
1.3.0	3,216	7/19/2022
1.2.1	4,742	6/7/2022
1.2.0	1,572	5/15/2022
1.1.0	2,383	4/30/2022
1.0.2	1,158	4/30/2022
1.0.1	1,191	4/30/2022
1.0.0	1,194	4/29/2022