Merge pull request #160 from getsentry/feature/aspnetcore-configure-scope

feat: UseSentry:ConfigureScope

Author: bruno-garcia

samples/Sentry.Samples.AspNetCore.Mvc/Program.cs

@@ -2,6 +2,7 @@
 using System.Net;
 using Microsoft.AspNetCore;
 using Microsoft.AspNetCore.Hosting;
+using Sentry;
 
 namespace Samples.AspNetCore.Mvc
 {
@@ -39,6 +40,9 @@ public static IWebHost BuildWebHost(string[] args) =>
 
                     options.MaxQueueItems = 100;
                     options.ShutdownTimeout = TimeSpan.FromSeconds(5);
+
+                    // Configures the root scope
+                    options.ConfigureScope(s => s.SetTag("Always sent", "this tag"));
                 })
                 .Build();
     }

samples/Sentry.Samples.ME.Logging/Program.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using Microsoft.Extensions.Logging;
+using Sentry;
 using Sentry.Extensions.Logging;
 using Sentry.Protocol;
 
@@ -28,6 +29,8 @@ private static void Main()
                 // Don't keep as a breadcrumb or send events for messages of level less than Critical with exception of type DivideByZeroException
                 o.AddLogEntryFilter((category, level, eventId, exception)
                     => level < LogLevel.Critical && exception?.GetType() == typeof(DivideByZeroException));
+
+                o.ConfigureScope(s => s.SetTag("RootScope", "sent with all events"));
             }))
         {
             var logger = loggerFactory.CreateLogger<Program>();

src/Sentry.AspNetCore/SentryMiddleware.cs

@@ -51,6 +51,14 @@ public SentryMiddleware(
             _next = next ?? throw new ArgumentNullException(nameof(next));
             _hubAccessor = hubAccessor ?? throw new ArgumentNullException(nameof(hubAccessor));
             _options = options?.Value;
+            if (_options != null)
+            {
+                var hub = _hubAccessor();
+                foreach (var callback in _options.ConfigureScopeCallbacks)
+                {
+                    hub.ConfigureScope(callback);
+                }
+            }
             _hostingEnvironment = hostingEnvironment;
             _logger = logger;
         }

src/Sentry.Extensions.Logging/SentryLoggerFactoryExtensions.cs

@@ -50,6 +50,11 @@ public static ILoggerFactory AddSentry(
                 hub = HubAdapter.Instance;
             }
 
+            foreach (var callback in options.ConfigureScopeCallbacks)
+            {
+                hub.ConfigureScope(callback);
+            }
+
             factory.AddProvider(new SentryLoggerProvider(hub, SystemClock.Clock, options));
             return factory;
         }

src/Sentry.Extensions.Logging/SentryLoggingOptions.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Immutable;
 using Microsoft.Extensions.Logging;
 using Sentry.Protocol;
@@ -50,9 +51,20 @@ public class SentryLoggingOptions : SentryOptions
         /// </summary>
         public bool InitializeSdk { get; set; } = true;
 
+        /// <summary>
+        /// Add a callback to configure the scope upon SDK initialization
+        /// </summary>
+        /// <param name="action">The function to invoke when initializing the SDK</param>
+        public void ConfigureScope(Action<Scope> action) => ConfigureScopeCallbacks = ConfigureScopeCallbacks.Add(action);
+
         /// <summary>
         /// Log entry filters
         /// </summary>
         internal ImmutableList<ILogEntryFilter> Filters { get; set; } = ImmutableList<ILogEntryFilter>.Empty;
+
+        /// <summary>
+        /// List of callbacks to be invoked when initializing the SDK
+        /// </summary>
+        internal ImmutableList<Action<Scope>> ConfigureScopeCallbacks { get; set; } = ImmutableList<Action<Scope>>.Empty;
     }
 }

test/Sentry.AspNetCore.Tests/MiddlewareLoggerIntegration.cs

@@ -9,6 +9,7 @@
 using Sentry.Extensions.Logging;
 using Sentry.Infrastructure;
 using Sentry.Internal;
+using Sentry.Protocol;
 using Xunit;
 
 namespace Sentry.AspNetCore.Tests
@@ -102,6 +103,21 @@ public async Task InvokeAsync_LoggerPushesScope_LoggerMessage_AsBreadcrumb()
                 Arg.Is<Scope>(e => e.Breadcrumbs.Any(b => b.Message == expectedCrumb)));
         }
 
+        [Fact]
+        public async Task InvokeAsync_OptionsConfigureScope_AffectsAllRequests()
+        {
+            const SentryLevel expected = SentryLevel.Debug;
+            _fixture.Options.ConfigureScope(s => s.Level = expected);
+            _fixture.RequestDelegate = context => throw new Exception();
+            var sut = _fixture.GetSut();
+
+            await Assert.ThrowsAsync<Exception>(async () => await sut.InvokeAsync(_fixture.HttpContext));
+
+            _fixture.Client.Received(1).CaptureEvent(
+                Arg.Any<SentryEvent>(),
+                Arg.Is<Scope>(e => e.Level == expected));
+        }
+
         public void Dispose() => _fixture.Dispose();
     }
 }

test/Sentry.Extensions.Logging.Tests/SentryLoggerFactoryExtensionsTests.cs

@@ -1,13 +1,35 @@
+using System;
 using Microsoft.Extensions.Logging;
 using NSubstitute;
 using Sentry.Extensibility;
 using Sentry.Internal;
+using Sentry.Protocol;
 using Xunit;
 
 namespace Sentry.Extensions.Logging.Tests
 {
     public class SentryLoggerFactoryExtensionsTests
     {
+        [Fact]
+        public void AddSentry_ConfigureScope_InvokesCallback()
+        {
+            const SentryLevel expected = SentryLevel.Debug;
+            var sut = Substitute.For<ILoggerFactory>();
+            var hub = Substitute.For<IHub>();
+            var scope = new Scope(new SentryOptions());
+            hub.When(w => w.ConfigureScope(Arg.Any<Action<Scope>>()))
+                .Do(info => info.Arg<Action<Scope>>()(scope));
+            SentrySdk.UseHub(hub);
+
+            sut.AddSentry(o =>
+            {
+                o.InitializeSdk = false; // use the mock above
+                o.ConfigureScope(s => s.Level = expected);
+            });
+
+            Assert.Equal(expected, scope.Level);
+        }
+
         [Fact]
         public void AddSentry_InitializeSdkFalse_HubAdapter()
         {

test/Sentry.Extensions.Logging.Tests/SentryLoggerProviderTests.cs

@@ -1,6 +1,7 @@
 using System;
 using NSubstitute;
 using Sentry.Infrastructure;
+using Sentry.Protocol;
 using Xunit;
 
 namespace Sentry.Extensions.Logging.Tests