NorthWestNodes.Common 0.4.5

NorthWest Nodes common library

The NorthWest Nodes Common Library is a class library written in C# using the .NET Core 7.0 framework. It contains several common functions used throughout the closed- and open-source projects at NorthWest Nodes (https://northwestnodes.com).

One of its main features is a highly flexible Datadog logger.

Installation

• Install-Package NorthWestNodes.Common
• dotnet add package NorthWestNodes.Common

Datadog logger

Configuration

Namespaces:

• NorthWestNodes.Common.Logging
• NorthWestNodes.Common.Logging.Datadog

Environment variables:

• DD_API_KEY: the API key for your Datadog app
• DD_HOST: the Host column in Datadog
• DD_SERVICE: the Service column in Datadog
• DD_SOURCE: the Source column in Datadog

Usage examples

Send a basic Datadog log event:

Log log = DDLog.Create();
log.WriteInfo("An INFO log event message appearing in Datadog's message column");

Dynamic enrichtments

Send a Datadog log event with a dynamic enrichment. Dynamic enrichments get removed/reset after each Write operation:

Stopwatch sw = Stopwatch.StartNew();
// do a thing
sw.Stop();

Log log = DDLog.Create();
log
    .EnrichDynamic("responseTime", sw.ElapsedMilliseconds)
    .WriteInfo("An INFO log event message appearing in Datadog's message column");

Static enrichments

Send a Datadog log event with a static enrichment. Static enrichments do not get removed after each Write operation. Can be used in combination with Dynamic enrichtments:

Log log = DDLog.Create();
log.EnrichStatic("network", "source-network");

log
    .EnrichDynamic("someField", someVariable)
    .WriteInfo("An INFO log event message appearing in Datadog's message column");

Log levels

You can set the log level and calling the appropriate Write*** function will log messages accordingly:

Log log = DDLog.Create();
log.SetLogLevel(LogLevel.Error); // only errors and up
log.WriteInfo("Hello world"); // will NOT be processed
log.WriteFatal("Ack, mein leben!"); // will be processed

Log event dispatching

The Datadog logger uses a background Task to dispatch log events in batches. By default a batch contains a maximum of 10 log events and each a maximum age of 5 seconds before being forcibly dispatched regardless of how many items a batch contains.