Web349.Logging 0.2.0

Web349 Logging Library

This .NET Core 6 library contains the logging functionality used throughout Web349's internal and external projects. Contains a powerful Datadog logger.

ENV variable configuration

Requirements

• .NET Core 6 Download at dot.net
• System.Text.Json for JSON serialization

Notes

• Each instance of a Logger class creates its own context logger.Context for identification purposes. If not specified during Logger implementation creation, the Context is a new GUID.
• While technically possible, multiple threads should not share the same Logger instance.
• Each Logger context keeps track of an int64 Event ID field allowing for easier identification and log tracing.
• At the moment of writing SlackLogger only supports sending of unenriched, text-only messages. Use Markdown to apply formatting in Slack.
• The SlackLogger name has the follow regular expression limitation: ^[a-zA-Z0-9_]+$.
• The Dispatcher settings only apply to Logger implementations that use a producer/consumer dispatching service to send off the logs (e.g., SlackLogger and DatadogLogger).

Datadog logger usage examples

Logging regular information

Logger logger = new DatadogLogger();
logger.LogInformation("This is the message that will appear in Datadog");

Logging enriched information

Logger logger = new DatadogLogger();
logger
    .Enrich("fieldName", 123)
    .Enrich("anotherFieldName", "some string value")
    .Enrich("foo", serializableBarObject)
.LogInformation("This is the message that will appear in Datadog, with the three fields enriched above");

Logging an Exception

Logger logger = new DatadogLogger();
try
{
	throw new Exception("oops");
}
catch(Exception ex)
{
	logger.LogError(ex.Message, ex);
}

Slack logger usage examples

Logging regular information

// the Slack webhook URL will match to the value set to WEB349_LOGGING_SLACK_WEBHOOKURL_SERVICENAME
// dashes (-) will be replace with an underscore (_) and spaces are removed.
Logger serviceNameLogger = new SlackLogger("serviceName");
serviceNameLogger.LogInformation("a message");

Information censorship usage example

The library has the ability to censor potentially sensitive information from enriched fields. See WEB349_LOGGING_CENSORSHIP_KEYWORDS for more information. The following is an example of information censorship:

Logger logger = new DatadogLogger();
logger
    .Enrich("myFieldNotCensored", obj)
    .Enrich("apiKeyBeingCensored", apiKeyStr) // this field contains 'api' and its value will be censored to '***'
.LogDebug("Hello friend, this is a DEBUG log event with one censored and one uncensored field");

Contribution

Want to help? Comments? Love? Hate? Open up an Issueo or Pull Request on Github: https://github.com/web349/logging

Disclaimer

This software is provided for free, AS IS, without any guarantees whatsoever, because I felt there were no easy-to-use Datadog loggers for .NET Core.