Snafets.Extensions.Logging.TracesOnError 1.2.0

Snafets.Extensions.Logging.TracesOnError

provides functionality to enrich log messages with all previous traces

Motivation

When an exception is thrown it is often hard to understand the context of the error. This library provides a way to enrich the log message with all previous traces. This can be very helpful to understand the context of the error. Enabling LogLevel == Trace is often not feasable as in modern cloud environements the cost of logging can often exeed the cost of the application itself. By only logging debug information when an error occurs the cost of logging can be reduced.

Usage

During Setup register TracesOnError, also some parameters are possible to add a logsink or to setup some options.

((ILoggingBuilder)builder).AddTracesOnError();

Log Messages normally, which has no effects on other loggers. But when specifying a ITracesOnErrorLogSink then the error messages are writen to that sink.

((ILogger)logger).LogError(exception, "error message");

To encance the log messages of other loggers use our new extension methods for ILogger:

((ILogger)logger).LogErrorWithTraces(exception, "error message");

Application Insights

To use Application Insights as a log sink, you can use the Snafets.Extensions.Logging.TracesOnError.ApplicationInsights package.

TelemetryClient telemetryClient = ...; // initialize the client as you would normally do
((ILoggingBuilder)builder).AddTracesOnErrorApplicationInsights(telemetryClient);

Examples

Look for some example implementations in our examples folder.

How can I contribute?

You are welcome to contribute!

License

Snafets.Extensions.Logging.TracesOnError is licensed under the MIT license.

Code Quality

This Project uses SonarCloud for code quality checks. You can find the latest analysis at the SonarCloud Dashboard.

Nuget.org

The package is available on Nuget.org