Sentry.Extensions.Logging 0.0.1-preview5

Below you will find a basic introduction to the SDK and its API.

For more details, please: refer to the SDK documentation

Description

Integration of Microsoft.Extensions.Logging with Sentry

Depends on the main Sentry SDK and makes all its features available to use.

Main features

• BeginScope data added to scope
• LogInformation or higher added as breadcrumb. Sent with next events.
• LogError or higher automatically captures an event
• Strong named

By default, LogError or LogCritical by will send an event to Sentry. That can be configured to any level or disable altogether.

Log messages of level Information or higher will be kept as breadcrumbs and if an event is sent, all breadcrumbs from that transaction are included.

These levels can be configured so that the level you define, tracks breadcrumbs, sends events or completely disable it.

That means that log mesages logged by you or the framework, related to the failed transaction, will be added to the event!

Sample:

 using (var loggerFactory = new LoggerFactory()
            .AddConsole(LogLevel.Trace)
            .AddSentry(o =>
            {
                // Initialize the SDK, alternative to relying on previously called: `using(SentrySdk.Init)`:
                // this is useful when Logging is the first or is the only integration enabled:
                o.Init(i =>
                {
                    i.Dsn = new Dsn("https://5fd7a6cda8444965bade9ccfd3df9882@sentry.io/1188141");
                    i.MaxBreadcrumbs = 150; // Increasing from default 100
                });

                // Optionally configure options: The default values are:
                o.MinimumBreadcrumbLevel = LogLevel.Information; // It requires at least this level to store breadcrumb
                o.MinimumEventLevel = LogLevel.Error; // This level or above will result in event sent to Sentry
            }))
        {
            var logger = loggerFactory.CreateLogger<Program>();

            logger.LogTrace("1 - By *default* this log level is ignored by Sentry.");

            logger.LogInformation("2 - Information messages are stored as Breadcrumb, sent with the next event.");

            logger.LogError("3 - This generates an event, captured by sentry and includes breadcrumbs (2) tracked in this transaction.");

            using (logger.BeginScope(new Dictionary<string, string>
                {
                    {"A", "some value"},
                    {"B", "more value"},
                }))
            {
                logger.LogWarning("4 - Breadcrumb that only exists inside this scope");

                logger.LogError("5 - An event that includes the scoped key-value (A, B) above and also the breadcrumbs: (2, 4) and event (3)");
            }
        }
    }
}