Merge pull request #171 from getsentry/feature/in-app-include

feat: InAppInclude

Author: bruno-garcia

samples/Sentry.Samples.Console.Customized/Program.cs

@@ -43,6 +43,9 @@ await SentrySdk.ConfigureScopeAsync(async scope =>
             // To see the lines from non `AppCode`, select `Full`. That'll include non App code like System.*, Microsoft.* and LibraryX.*
             o.AddInAppExclude("LibraryX.");
 
+            // Before excluding all prefixed 'LibraryX.', any stack trace from a type namespaced 'LibraryX.Core' will be considered InApp.
+            o.AddInAppInclude("LibraryX.Core");
+
             // Send personal identifiable information like the username logged on to the computer and machine name
             o.SendDefaultPii = true;
 

src/Sentry/Internal/SentryStackTraceFactory.cs

@@ -134,6 +134,14 @@ private bool IsSystemModuleName(string moduleName)
                 return false;
             }
 
+            foreach (var include in _options.InAppInclude)
+            {
+                if (moduleName.StartsWith(include, StringComparison.Ordinal))
+                {
+                    return false;
+                }
+            }
+
             foreach (var exclude in _options.InAppExclude)
             {
                 if (moduleName.StartsWith(exclude, StringComparison.Ordinal))

src/Sentry/SentryOptions.cs

@@ -65,6 +65,20 @@ public class SentryOptions : IScopeOptions
         /// </example>
         internal ImmutableList<string> InAppExclude { get; set; }
 
+        /// <summary>
+        /// A list of namespaces (or prefixes) considered part of application code
+        /// </summary>
+        /// <remarks>
+        /// Sentry by default filters the stacktrace to display only application code.
+        /// A user can optionally click to see all which will include framework and libraries.
+        /// A <see cref="string.StartsWith(string)"/> is executed
+        /// </remarks>
+        /// <example>
+        /// 'System.CustomNamespace', 'Microsoft.Azure.App'
+        /// </example>
+        /// <seealso href="https://docs.sentry.io/error-reporting/configuration/?platform=csharp#in-app-include"/>
+        internal ImmutableList<string> InAppInclude { get; set; }
+
         /// <summary>
         /// Whether to include default Personal Identifiable information
         /// </summary>
@@ -328,6 +342,8 @@ public SentryOptions()
                     "FSharp.",
                     "Serilog",
                     "Giraffe.");
+
+            InAppInclude = ImmutableList<string>.Empty;
         }
     }
 }

src/Sentry/SentryOptionsExtensions.cs

@@ -48,6 +48,14 @@ public static void AddIntegration(this SentryOptions options, ISdkIntegration in
         public static void AddInAppExclude(this SentryOptions options, string prefix)
             => options.InAppExclude = options.InAppExclude.Add(prefix);
 
+        /// <summary>
+        /// Add prefix to include as in 'InApp' stack trace.
+        /// </summary>
+        /// <param name="options"></param>
+        /// <param name="prefix"></param>
+        public static void AddInAppInclude(this SentryOptions options, string prefix)
+            => options.InAppInclude = options.InAppInclude.Add(prefix);
+
         /// <summary>
         /// Add an exception processor
         /// </summary>

test/Sentry.Tests/Internals/SentryStackTraceFactoryTests.cs

@@ -99,6 +99,19 @@ public void CreateSentryStackFrame_AppNamespaceExcluded_NotInAppFrame()
             Assert.False(actual.InApp);
         }
 
+        [Fact]
+        public void CreateSentryStackFrame_NamespaceIncludedAndExcluded_IncludesTakesPrecedence()
+        {
+            _fixture.SentryOptions.AddInAppExclude(GetType().Namespace);
+            _fixture.SentryOptions.AddInAppInclude(GetType().Namespace);
+            var sut = _fixture.GetSut();
+            var frame = new StackFrame();
+
+            var actual = sut.CreateFrame(frame);
+
+            Assert.True(actual.InApp);
+        }
+
         // https://github.com/getsentry/sentry-dotnet/issues/64
         [Fact]
         public void DemangleAnonymousFunction_NullFunction_ContinuesNull()

test/Sentry.Tests/SentryOptionsExtensionsTests.cs

@@ -43,6 +43,14 @@ public void AddInAppExclude_StoredInOptions()
             Assert.Contains(Sut.InAppExclude, actual => actual == expected);
         }
 
+        [Fact]
+        public void AddInAppInclude_StoredInOptions()
+        {
+            const string expected = "test";
+            Sut.AddInAppInclude(expected);
+            Assert.Contains(Sut.InAppInclude, actual => actual == expected);
+        }
+
         [Fact]
         public void AddExceptionProcessor_StoredInOptions()
         {