Replace WithScope

[tengl]

Hi!

We use the deprecated WithScope in a few places, and is looking to replace it but we can´t find out how. We want to log to console and to Sentry. The log to Sentry should include custom tags and context. In the example below I have tried different scenarios but the only scenario that replaces WithScope looks like this:

SentrySdk.ConfigureScope(scope =>
{
    scope.SetTag("ExtraTag", "IsSet");
    scope.Contexts["ExtraContext"] = new { IsSet = true };
});
logger.LogCritical("6. Logged to console and Sentry with extra tags and context");
SentrySdk.ConfigureScope(scope =>
{
    scope.UnsetTag("ExtraTag");
    scope.Contexts.Remove("ExtraContext", out _);
});

And that does not look very good.

Full code here

SentryScopeService.cs

using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Sentry;

internal class SentryScopeService : IHostedService
{
    private readonly ILogger<SentryScopeService> logger;
    private readonly IHostApplicationLifetime lifetime;

    public SentryScopeService(ILogger<SentryScopeService> logger, IHostApplicationLifetime lifetime)
    {
        this.logger = logger;
        this.lifetime = lifetime;
    }

    public Task StartAsync(CancellationToken cancellationToken)
    {
        SentrySdk.CaptureMessage("1. Only logged to Sentry including initial tags and context.");

        logger.LogInformation("2. Logged to console and Sentry with initial tags and context");

        SentrySdk.WithScope(scope =>
        {
            scope.SetTag("ExtraTag", "IsSet");
            scope.Contexts["ExtraContext"] = new { IsSet = true };
            // This is the scenario I want to support, using the normal logger and setting tags and context.
            logger.LogWarning("3. Logged to console and Sentry with extra tags and context");
        });

        using (
            logger.BeginScope(
                new Dictionary<string, object>()
                {
                    ["ExtraTag"] = "IsSet",
                    ["ExtraContext"] = "IsSetAsTag"
                }
            )
        )
        {
            // This could be a replacement for WithScope.
            // But how do I set contexts in Sentry? Scope is only set as tags.
            logger.LogCritical("4. Scope logged as tag in Sentry");
        }

        // This could also work as a replacement, but this will not log to console.
        SentrySdk.CaptureMessage(
            "5. This is not logged to console",
            scope =>
            {
                scope.SetTag("ExtraTag", "IsSet");
                scope.Contexts["ExtraContext"] = new { IsSet = true };
            },
            SentryLevel.Fatal
        );

        // Is the code below the only solution that can replace WithScope?
        SentrySdk.ConfigureScope(scope =>
        {
            scope.SetTag("ExtraTag", "IsSet");
            scope.Contexts["ExtraContext"] = new { IsSet = true };
        });
        logger.LogCritical("6. Logged to console and Sentry with extra tags and context");
        SentrySdk.ConfigureScope(scope =>
        {
            scope.UnsetTag("ExtraTag");
            scope.Contexts.Remove("ExtraContext", out _);
        });

        logger.LogInformation("7. Restored to initial tags and context");

        lifetime.StopApplication();
        return Task.CompletedTask;
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

Program.cs

// See https://aka.ms/new-console-template for more information

using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.DependencyInjection;

var host = Host.CreateDefaultBuilder(args)
    .ConfigureLogging(
        (hostContext, logging) =>
        {
            _ = logging.ClearProviders();
            _ = logging.AddSimpleConsole(o =>
            {
                o.IncludeScopes = true;
            });
            logging.AddFilter("Microsoft", LogLevel.Warning);
            logging.SetMinimumLevel(LogLevel.Debug);

            _ = logging.AddSentry(options =>
            {
                options.Dsn =
                    "<YOUR_DSN>";
                options.Environment = hostContext.HostingEnvironment.EnvironmentName;
                options.MinimumEventLevel = LogLevel.Debug;
                options.ConfigureScope(scope =>
                {
                    scope.SetTag("InitialTag", "IsSet");
                    scope.Contexts["InitialContext"] = new { IsSet = true };
                });
            });
        }
    )
    .ConfigureServices(
        (hostContext, services) =>
        {
            var configuration = hostContext.Configuration;

            _ = services.AddHostedService<SentryScopeService>();
        }
    )
    .Build();

await host.RunAsync();

SentryScopeExample.csproj

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

<ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
    <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
    <PackageReference Include="Sentry.Extensions.Logging" Version="3.20.1" />
  </ItemGroup>
</Project>

(See also discussion here)

[tengl]

I ended up creating an extension method that looks like this:

public static class LoggingExtensions
{
    public static void LogWithSentryScope(
        this ILogger logger,
        string? message,
        Action<Scope> configureScope,
        LogLevel logLevel = LogLevel.Information
    )
    {
        using var _ = SentrySdk.PushScope();
        SentrySdk.ConfigureScope(configureScope);
        logger.Log(logLevel, message);
    }
}

[mattjohnsonpint]

PushScope is indeed the best replacement currently. See also: getsentry/sentry-docs#5460 (comment)