Updating extension telemetry (#4996)

* Updating extension telemetry * Refactroing Removing TokenType and replacing the values with string * Updating PR to revert new histogram logic. * TODO * Refactoring. Addressing Feedback * Apply suggestions from code review Co-authored-by: Gladwin Johnson <[email protected]> * Addressing PR Feedback * Update * Resolving test issues * Removing External * update * Updating WAM header * Resolving WAM test issues * Fixing test --------- Co-authored-by: trwalke <[email protected]> Co-authored-by: Gladwin Johnson <[email protected]>
AzureAD · Dec 24, 2024 · 2ad7d8d · 2ad7d8d
1 parent b54af18
commit 2ad7d8d
Show file tree

Hide file tree

Showing 30 changed files with 138 additions and 108 deletions.
diff --git a/src/client/Microsoft.Identity.Client.Broker/WamAdapters.cs b/src/client/Microsoft.Identity.Client.Broker/WamAdapters.cs
@@ -362,7 +362,11 @@ private static MsalTokenResponse ParseRuntimeResponse(
                     Scope = authResult.GrantedScopes,
                     ExpiresIn = (long)(DateTime.SpecifyKind(authResult.ExpiresOn, DateTimeKind.Utc) - DateTimeOffset.UtcNow).TotalSeconds,
                     ClientInfo = authResult.Account.ClientInfo,
-                    TokenType = authResult.IsPopAuthorization ? Constants.PoPAuthHeaderPrefix: authenticationRequestParameters.RequestContext.ApiEvent.TokenType.ToString(),
+                    TokenType = authResult.IsPopAuthorization ? 
+                                                                Constants.PoPAuthHeaderPrefix :
+                                                                (authenticationRequestParameters.AuthenticationScheme.AccessTokenType == "ssh-cert" ?
+                                                                    Constants.SshCertAuthHeaderPrefix :
+                                                                    authenticationRequestParameters.AuthenticationScheme.AuthorizationHeaderPrefix),
                     WamAccountId = authResult.Account.AccountId,
                     TokenSource = TokenSource.Broker
                 };

diff --git a/src/client/Microsoft.Identity.Client/AuthScheme/Bearer/BearerAuthenticationOperation.cs b/src/client/Microsoft.Identity.Client/AuthScheme/Bearer/BearerAuthenticationOperation.cs
@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.Utils;
 
 namespace Microsoft.Identity.Client.AuthScheme.Bearer
@@ -11,7 +12,7 @@ internal class BearerAuthenticationOperation : IAuthenticationOperation
     {
         internal const string BearerTokenType = "bearer";
 
-        public int TelemetryTokenType => (int)TokenType.Bearer;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Bearer;
 
         public string AuthorizationHeaderPrefix => "Bearer";
 

diff --git a/src/client/Microsoft.Identity.Client/AuthScheme/IAuthenticationOperation.cs b/src/client/Microsoft.Identity.Client/AuthScheme/IAuthenticationOperation.cs
@@ -38,7 +38,7 @@ public interface IAuthenticationOperation
         string AuthorizationHeaderPrefix { get; }
 
         /// <summary>
-        /// Extra parameters that are added to the request to the /token endpoint. 
+        /// Extra parameters that are added to the request to the /token endpoint.
         /// </summary>
         /// <returns>Name and values of params</returns>
         IReadOnlyDictionary<string, string> GetTokenRequestParams();

diff --git a/src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopAuthenticationOperation.cs b/src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopAuthenticationOperation.cs
@@ -48,7 +48,7 @@ public PopAuthenticationOperation(PoPAuthenticationConfiguration popAuthenticati
             KeyId = Base64UrlHelpers.Encode(keyThumbprint);
         }
 
-        public int TelemetryTokenType => (int)TokenType.Pop;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Pop;
 
         public string AuthorizationHeaderPrefix => Constants.PoPAuthHeaderPrefix;
 

diff --git a/src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopBrokerAuthenticationOperation.cs b/src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopBrokerAuthenticationOperation.cs
@@ -17,7 +17,7 @@ namespace Microsoft.Identity.Client.AuthScheme.PoP
     //This is because tokens are cached in the broker instead so MSAL will rely on the broker's cache for silent requests.
     internal class PopBrokerAuthenticationOperation : IAuthenticationOperation
     {
-        public int TelemetryTokenType => (int)TokenType.Pop;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Pop;
 
         public string AuthorizationHeaderPrefix => Constants.PoPAuthHeaderPrefix;
 

diff --git a/...nt/Microsoft.Identity.Client/AuthScheme/SSHCertificates/SSHCertAuthenticationOperation.cs b/...nt/Microsoft.Identity.Client/AuthScheme/SSHCertificates/SSHCertAuthenticationOperation.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.OAuth2;
 
 namespace Microsoft.Identity.Client.AuthScheme.SSHCertificates
@@ -29,7 +30,7 @@ public SSHCertAuthenticationOperation(string keyId, string jwk)
             _jwk = jwk;
         }
 
-        public int TelemetryTokenType => (int)TokenType.SshCert;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.SshCert;
 
         public string AuthorizationHeaderPrefix =>
             throw new MsalClientException(

diff --git a/src/client/Microsoft.Identity.Client/AuthScheme/TokenType.cs b/src/client/Microsoft.Identity.Client/AuthScheme/TokenType.cs
diff --git a/src/client/Microsoft.Identity.Client/AuthenticationResult.cs b/src/client/Microsoft.Identity.Client/AuthenticationResult.cs
@@ -196,10 +196,8 @@ internal AuthenticationResult(
                 authenticationScheme.FormatResult(this);
             });
 
-            if (authenticationScheme.TelemetryTokenType == 5)
-            {
-                AuthenticationResultMetadata.DurationCreatingExtendedTokenInUs = measuredResultDuration.Microseconds;
-            }
+            AuthenticationResultMetadata.DurationCreatingExtendedTokenInUs = measuredResultDuration.Microseconds;
+            AuthenticationResultMetadata.TelemetryTokenType = authenticationScheme.TelemetryTokenType;
         }
 
         //Default constructor for testing

diff --git a/src/client/Microsoft.Identity.Client/AuthenticationResultMetadata.cs b/src/client/Microsoft.Identity.Client/AuthenticationResultMetadata.cs
@@ -77,6 +77,12 @@ public AuthenticationResultMetadata(TokenSource tokenSource)
         /// </summary>
         public RegionDetails RegionDetails { get; set; }
 
+        /// <summary>
+        /// Represents the token type used for client telemetry only.
+        /// It is separate from the other token types as it is set locally rather than coming from the server.
+        /// </summary>
+        public int TelemetryTokenType { get; set; }
+
         /// <summary>
         /// Time, in microseconds, spent in the token creation of the extended token.
         /// </summary>

diff --git a/src/client/Microsoft.Identity.Client/Extensibility/ExternalBoundTokenScheme.cs b/src/client/Microsoft.Identity.Client/Extensibility/ExternalBoundTokenScheme.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using Microsoft.Identity.Client.AuthScheme;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.Utils;
 
 namespace Microsoft.Identity.Client.Extensibility
@@ -19,7 +20,7 @@ public ExternalBoundTokenScheme(string keyId, string expectedTokenTypeFromEsts =
             _tokenType = expectedTokenTypeFromEsts;
         }
 
-        public int TelemetryTokenType => (int)TokenType.External;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.AtPop;
 
         public string AuthorizationHeaderPrefix => _tokenType;
 

diff --git a/src/client/Microsoft.Identity.Client/Internal/Constants.cs b/src/client/Microsoft.Identity.Client/Internal/Constants.cs
@@ -37,6 +37,7 @@ internal static class Constants
         public const string PoPAuthHeaderPrefix = "PoP"; 
         public const string RequestConfirmation = "req_cnf";
         public const string BearerAuthHeaderPrefix = "Bearer";
+        public const string SshCertAuthHeaderPrefix = "SshCert";
 
         public const string ManagedIdentityClientId = "client_id";
         public const string ManagedIdentityObjectId = "object_id";

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/ClientCredentialRequest.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/ClientCredentialRequest.cs
@@ -79,7 +79,7 @@ protected override async Task<AuthenticationResult> ExecuteAsync(CancellationTok
                             // Use a linked token source, in case the original cancellation token source is disposed before this background task completes.
                             using var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
                             return GetAccessTokenAsync(tokenSource.Token, logger);
-                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent.ApiId,
+                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId, 
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/ManagedIdentityAuthRequest.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/ManagedIdentityAuthRequest.cs
@@ -72,7 +72,7 @@ protected override async Task<AuthenticationResult> ExecuteAsync(CancellationTok
                             // Use a linked token source, in case the original cancellation token source is disposed before this background task completes.
                             using var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
                             return GetAccessTokenAsync(tokenSource.Token, logger);
-                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent.ApiId,
+                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/OnBehalfOfRequest.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/OnBehalfOfRequest.cs
@@ -135,7 +135,7 @@ protected override async Task<AuthenticationResult> ExecuteAsync(CancellationTok
                             // Use a linked token source, in case the original cancellation token source is disposed before this background task completes.
                             using var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
                             return RefreshRtOrFetchNewAccessTokenAsync(tokenSource.Token);
-                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent.ApiId,
+                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/RequestBase.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/RequestBase.cs
@@ -142,7 +142,8 @@ private void LogFailureTelemetryToOtel(string errorCodeToLog, ApiEvent apiEvent,
                         apiEvent.ApiId,
                         apiEvent.CallerSdkApiId, 
                         apiEvent.CallerSdkVersion,
-                        cacheRefreshReason);
+                        cacheRefreshReason,
+                        apiEvent.TokenType);
         }
 
         private Tuple<string, string> ParseScopesForTelemetry()
@@ -245,7 +246,7 @@ private ApiEvent InitializeApiEvent(string accountId)
                 AuthenticationRequestParameters.RequestContext.ServiceBundle.Config.LegacyCacheCompatibilityEnabled;
 
             apiEvent.CacheInfo = CacheRefreshReason.NotApplicable;
-            apiEvent.TokenType = (TokenType)AuthenticationRequestParameters.AuthenticationScheme.TelemetryTokenType;
+            apiEvent.TokenType = AuthenticationRequestParameters.AuthenticationScheme.TelemetryTokenType;
             apiEvent.AssertionType = GetAssertionType();
 
             UpdateCallerSdkDetails(apiEvent);

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/Silent/CacheSilentStrategy.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/Silent/CacheSilentStrategy.cs
@@ -98,7 +98,7 @@ public async Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellat
                             // Use a linked token source, in case the original cancellation token source is disposed before this background task completes.
                             using var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
                             return RefreshRtOrFailAsync(tokenSource.Token);
-                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent.ApiId,
+                        }, logger, ServiceBundle, AuthenticationRequestParameters.RequestContext.ApiEvent,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
                         AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }

diff --git a/src/client/Microsoft.Identity.Client/Internal/Requests/SilentRequestHelper.cs b/src/client/Microsoft.Identity.Client/Internal/Requests/SilentRequestHelper.cs
@@ -85,7 +85,7 @@ internal static void ProcessFetchInBackground(
             Func<Task<AuthenticationResult>> fetchAction,
             ILoggerAdapter logger, 
             IServiceBundle serviceBundle, 
-            ApiEvent.ApiIds apiId, 
+            ApiEvent apiEvent, 
             string callerSdkId, 
             string callerSdkVersion)
         {
@@ -96,13 +96,14 @@ internal static void ProcessFetchInBackground(
                     var authResult = await fetchAction().ConfigureAwait(false);
                     serviceBundle.PlatformProxy.OtelInstrumentation.IncrementSuccessCounter(
                         serviceBundle.PlatformProxy.GetProductName(),
-                        apiId,
+                        apiEvent.ApiId,
                         callerSdkId,
                         callerSdkVersion,
                         TokenSource.IdentityProvider, 
                         CacheRefreshReason.ProactivelyRefreshed, 
                         Cache.CacheLevel.None,
-                        logger);
+                        logger,
+                        apiEvent.TokenType);
                 }
                 catch (MsalServiceException ex)
                 {
@@ -119,32 +120,35 @@ internal static void ProcessFetchInBackground(
                     serviceBundle.PlatformProxy.OtelInstrumentation.LogFailureMetrics(
                         serviceBundle.PlatformProxy.GetProductName(),
                         ex.ErrorCode,
-                        apiId,
+                        apiEvent.ApiId,
                         callerSdkId,
                         callerSdkVersion,
-                        CacheRefreshReason.ProactivelyRefreshed);
+                        CacheRefreshReason.ProactivelyRefreshed,
+                        apiEvent.TokenType);
                 }
                 catch (OperationCanceledException ex)
                 {
                     logger.WarningPiiWithPrefix(ex, ProactiveRefreshCancellationError);
                     serviceBundle.PlatformProxy.OtelInstrumentation.LogFailureMetrics(
                         serviceBundle.PlatformProxy.GetProductName(),
                         ex.GetType().Name,
-                        apiId,
+                        apiEvent.ApiId,
                         callerSdkId, 
                         callerSdkVersion, 
-                        CacheRefreshReason.ProactivelyRefreshed);
+                        CacheRefreshReason.ProactivelyRefreshed,
+                        apiEvent.TokenType);
                 }
                 catch (Exception ex)
                 {
                     logger.ErrorPiiWithPrefix(ex, ProactiveRefreshGeneralError);
                     serviceBundle.PlatformProxy.OtelInstrumentation.LogFailureMetrics(
                         serviceBundle.PlatformProxy.GetProductName(),
                         ex.GetType().Name,
-                        apiId,
+                        apiEvent.ApiId,
                         callerSdkId, 
                         callerSdkVersion, 
-                        CacheRefreshReason.ProactivelyRefreshed);
+                        CacheRefreshReason.ProactivelyRefreshed,
+                        apiEvent.TokenType);
                 }
             });
         }

diff --git a/src/client/Microsoft.Identity.Client/Internal/TelemetryTokenTypeConstants.cs b/src/client/Microsoft.Identity.Client/Internal/TelemetryTokenTypeConstants.cs
@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Identity.Client.Internal
+{
+    internal static class TelemetryTokenTypeConstants
+    {
+        /// Bearer token type for telemetry.
+        public const int Bearer = 1;
+
+        /// Pop token type for telemetry.
+        public const int Pop = 2;
+
+        /// Ssh-cert token type for telemetry.
+        public const int SshCert = 3;
+
+        /// Token type for legacy AT POP
+        public const int AtPop = 4;
+
+        /// Extension token type for telemetry. This is used for custom token types added to MSAL as extensions through IAuthenticationOperation.
+        public const int Extension = 5;
+    }
+}