LoggingBuilderExtensions.cs

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging.Configuration;
using Microsoft.Extensions.Options;
using Sentry.Extensions.Logging;
using Sentry.Extensions.Logging.Extensions.DependencyInjection;

// ReSharper disable once CheckNamespace
// Ensures 'AddSentry' can be found without: 'using Sentry;'
namespace Microsoft.Extensions.Logging;

/// <summary>
/// LoggingBuilder extensions.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static class LoggingBuilderExtensions
{
    /// <summary>
    /// Adds the Sentry logging integration.
    /// </summary>
    /// <param name="builder">The builder.</param>
    public static ILoggingBuilder AddSentry(this ILoggingBuilder builder)
        => builder.AddSentry((Action<SentryLoggingOptions>?)null);

    /// <summary>
    /// Adds the Sentry logging integration.
    /// </summary>
    /// <param name="builder">The builder.</param>
    /// <param name="dsn">The DSN.</param>
    public static ILoggingBuilder AddSentry(this ILoggingBuilder builder, string dsn)
        => builder.AddSentry(o => o.Dsn = dsn);

    /// <summary>
    /// Adds the Sentry logging integration.
    /// </summary>
    /// <param name="builder">The builder.</param>
    /// <param name="optionsConfiguration">The options configuration.</param>
    public static ILoggingBuilder AddSentry(this ILoggingBuilder builder, Action<SentryLoggingOptions>? optionsConfiguration)
        => builder.AddSentry<SentryLoggingOptions>(optionsConfiguration);

    internal static ILoggingBuilder AddSentry<TOptions>(
        this ILoggingBuilder builder,
        Action<TOptions>? optionsConfiguration)
        where TOptions : SentryLoggingOptions, new()
    {
        builder.AddConfiguration();

        if (optionsConfiguration != null)
        {
            builder.Services.Configure(optionsConfiguration);
        }

        builder.Services.AddSingleton<IConfigureOptions<TOptions>, SentryLoggingOptionsSetup>();
        builder.Services.AddSingleton<ILoggerProvider, SentryLoggerProvider>();
        builder.Services.AddSingleton<ILoggerProvider, SentryStructuredLoggerProvider>();
        builder.Services.AddSentry<TOptions>();

        // All logs should flow to the SentryLogger, regardless of level.
        // Filtering of events is handled in SentryLogger, using SentryOptions.MinimumEventLevel
        // Filtering of breadcrumbs is handled in SentryLogger, using SentryOptions.MinimumBreadcrumbLevel
        builder.AddFilter<SentryLoggerProvider>(_ => true);

        // Logs from the SentryLogger should not flow to the SentryStructuredLogger as this may cause recursive invocations.
        // Filtering of logs is handled in SentryStructuredLogger, using SentryOptions.MinimumLogLevel
        builder.AddFilter<SentryStructuredLoggerProvider>(static (string? categoryName, LogLevel logLevel) =>
        {
            return categoryName is null
                || categoryName != "Sentry.ISentryClient";
        });

        return builder;
    }
}