Add scope property to UserDetails (#2706)

DataDog · Apr 21, 2022 · f74af6a · f74af6a
1 parent 5df80e1
commit f74af6a
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/tracer/src/Datadog.Trace/SpanExtensions.cs b/tracer/src/Datadog.Trace/SpanExtensions.cs
@@ -56,6 +56,11 @@ public static void SetUser(this ISpan span, UserDetails userDetails)
             {
                 localRootSpan.SetTag(Tags.User.Role, userDetails.Role);
             }
+
+            if (userDetails.Scope is not null)
+            {
+                localRootSpan.SetTag(Tags.User.Scope, userDetails.Scope);
+            }
         }
     }
 }
diff --git a/tracer/src/Datadog.Trace/Tags.cs b/tracer/src/Datadog.Trace/Tags.cs
@@ -486,6 +486,7 @@ internal static class User
             internal const string Id = "usr.id";
             internal const string SessionId = "usr.session_id";
             internal const string Role = "usr.role";
+            internal const string Scope = "usr.scope";
         }
     }
 }
diff --git a/tracer/src/Datadog.Trace/UserDetails.cs b/tracer/src/Datadog.Trace/UserDetails.cs
@@ -29,6 +29,7 @@ public UserDetails(string id)
             Name = null;
             SessionId = null;
             Role = null;
+            Scope = null;
         }
 
         /// <summary>
@@ -55,5 +56,10 @@ public UserDetails(string id)
         /// Gets or sets the role associated with the user
         /// </summary>
         public string? Role { get; set; }
+
+        /// <summary>
+        /// Gets or sets the scopes or granted authorities the client currently possesses extracted from token or application security context
+        /// </summary>
+        public string? Scope { get; set; }
     }
 }
diff --git a/...og.Trace.Tests/Snapshots/PublicApiTests.Datadog.Trace.PublicApiHasNotChanged.verified.txt b/...og.Trace.Tests/Snapshots/PublicApiTests.Datadog.Trace.PublicApiHasNotChanged.verified.txt
@@ -326,6 +326,7 @@ namespace Datadog.Trace
         public string Id { get; set; }
         public string? Name { get; set; }
         public string? Role { get; set; }
+        public string? Scope { get; set; }
         public string? SessionId { get; set; }
     }
 }

diff --git a/tracer/test/Datadog.Trace.Tests/TracerTests.cs b/tracer/test/Datadog.Trace.Tests/TracerTests.cs
@@ -546,6 +546,7 @@ public void SetUserOnRootSpanDirectly()
             var id = Guid.NewGuid().ToString();
             var sessionId = Guid.NewGuid().ToString();
             var role = "admin";
+            var scope = "read:message, write:files";
 
             var userDetails = new UserDetails()
             {
@@ -554,6 +555,7 @@ public void SetUserOnRootSpanDirectly()
                 Id = id,
                 SessionId = sessionId,
                 Role = role,
+                Scope = scope,
             };
             tracer.ActiveScope?.Span.SetUser(userDetails);
 
@@ -562,6 +564,7 @@ public void SetUserOnRootSpanDirectly()
             Assert.Equal(id, rootTestScope.Span.GetTag(Tags.User.Id));
             Assert.Equal(sessionId, rootTestScope.Span.GetTag(Tags.User.SessionId));
             Assert.Equal(role, rootTestScope.Span.GetTag(Tags.User.Role));
+            Assert.Equal(scope, rootTestScope.Span.GetTag(Tags.User.Scope));
         }
 
         [Fact]
@@ -583,6 +586,7 @@ public void SetUserOnChildChildSpan_ShouldAttachToRoot()
             var id = Guid.NewGuid().ToString();
             var sessionId = Guid.NewGuid().ToString();
             var role = "admin";
+            var scope = "read:message, write:files";
 
             var userDetails = new UserDetails()
             {
@@ -591,6 +595,7 @@ public void SetUserOnChildChildSpan_ShouldAttachToRoot()
                 Id = id,
                 SessionId = sessionId,
                 Role = role,
+                Scope = scope,
             };
             tracer.ActiveScope?.Span.SetUser(userDetails);
 
@@ -601,6 +606,7 @@ public void SetUserOnChildChildSpan_ShouldAttachToRoot()
             Assert.Equal(id, rootTestScope.Span.GetTag(Tags.User.Id));
             Assert.Equal(sessionId, rootTestScope.Span.GetTag(Tags.User.SessionId));
             Assert.Equal(role, rootTestScope.Span.GetTag(Tags.User.Role));
+            Assert.Equal(scope, rootTestScope.Span.GetTag(Tags.User.Scope));
         }
 
         [Fact]
@@ -613,6 +619,7 @@ public void SetUser_ShouldWorkOnAnythingImplementingISpan()
             var id = Guid.NewGuid().ToString();
             var sessionId = Guid.NewGuid().ToString();
             var role = "admin";
+            var scope = "read:message, write:files";
 
             var userDetails = new UserDetails()
             {
@@ -621,6 +628,7 @@ public void SetUser_ShouldWorkOnAnythingImplementingISpan()
                 Id = id,
                 SessionId = sessionId,
                 Role = role,
+                Scope = scope,
             };
             testSpan.SetUser(userDetails);
 
@@ -629,6 +637,7 @@ public void SetUser_ShouldWorkOnAnythingImplementingISpan()
             Assert.Equal(id, testSpan.GetTag(Tags.User.Id));
             Assert.Equal(sessionId, testSpan.GetTag(Tags.User.SessionId));
             Assert.Equal(role, testSpan.GetTag(Tags.User.Role));
+            Assert.Equal(scope, testSpan.GetTag(Tags.User.Scope));
         }
 
         [Fact]