WatchDog.SDK 0.1.0-alpha

WatchDog

Introduction

WatchDog is a real-time cloud-based monitoring, logging, security and alert solutions for software applications.

Support

• .NET Core 3.1 and newer

Installation

Install via .NET CLI

dotnet add package WatchDog.SDK --version 1.0.0

Install via Package Manager

Install-Package WatchDog.SDK --version 1.0.0

Usage

Use the WatchDog middleware as shown below:

Add WatchDog Namespace in Startup.cs for .NET 3.1 and below and in Program.cs for .NET 5 and above

using WatchDog;

For .NET 3.1 and below, register WatchDog in Startup.cs under ConfigureService()

services.AddWatchDog(config =>
{
    config.AppID = "YOUR-APP-ID";
    config.AppKey = "YOUR-APP-KEY";
    config.Blacklist = "password, token, clientSecret";
});

For .NET 5 and above, in Program.cs

builder.Services.AddWatchDog(config =>
{
    config.AppID = "YOUR-APP-ID";
    config.AppKey = "YOUR-APP-KEY";
    config.Blacklist = "password, token, clientSecret";
});

Add WatchDog middleware to the HTTP request pipeline

For .NET 3.1 and below Startup.cs under Configure() For .NET 5 and above Program.cs

app.UseWatchDog();

Logging

_logger.LogEvent("Testing Event Logging", true, "xTCZ", data: JsonSerializer.Serialize(Summaries), metadata: "Metadata Stuff");
_logger.LogIncident("Severe Incident", IncidentSeverity.Critical);
_logger.LogException(ex);

_logger.LogInformation($"Response: {JsonSerializer.Serialize(result)}");
_logger.LogDebug("..DEBUG..");
_logger.LogTrace("..TRACE..");
_logger.LogError("..ERROR..");
_logger.LogCritical("..CRITICAL..");
_logger.LogWarning("..WARNING..");

Sink Logs from ILogger

You can also sink logs from the .NET ILogger into WatchDog

For .NET 5 and above

builder.Logging.AddWatchDogLogger();

For .NET Core 3.1 and below, configure logging and add .AddWatchDogLogger() to the builder creation method of the Program.cs class

Host.CreateDefaultBuilder(args)
 .ConfigureLogging( logging =>
 {
     logging.AddWatchDogLogger();
 })
 .ConfigureWebHostDefaults(webBuilder =>
 {
     webBuilder.UseStartup<Startup>();
 });

Enjoy!

Copyright

Copyright (c) 2024 WatchDogHQ https://www.watchdoghq.co

Documentation

https://www.docs.watchdoghq.co