Add caller sdk id and version to telemetry server side and client side

src/client/Microsoft.Identity.Client/AppConfig/ApplicationConfiguration.cs

@@ -37,24 +37,21 @@ public ApplicationConfiguration(MsalClientType applicationType)
                     break;
             }
         }
-
-        public const string DefaultClientName = "UnknownClient";
-        public const string DefaultClientVersion = "0.0.0.0";
 
         // For telemetry, the ClientName of the application.
-        private string _clientName = DefaultClientName;
+        private string _clientName;
         public string ClientName
         {
             get => _clientName;
-            internal set { _clientName = string.IsNullOrWhiteSpace(value) ? DefaultClientName : value; }
+            internal set { _clientName = string.IsNullOrWhiteSpace(value) ? "" : value; }
         }
 
         // For telemetry, the ClientVersion of the application.
-        private string _clientVersion = DefaultClientVersion;
+        private string _clientVersion;
         public string ClientVersion
         {
             get => _clientVersion;
-            internal set { _clientVersion = string.IsNullOrWhiteSpace(value) ? DefaultClientVersion : value; }
+            internal set { _clientVersion = string.IsNullOrWhiteSpace(value) ? "" : value; }
         }
 
         public Func<object> ParentActivityOrWindowFunc { get; internal set; }

src/client/Microsoft.Identity.Client/Internal/Logger/LoggerHelper.cs

@@ -23,7 +23,7 @@ internal class LoggerHelper
 
         public static string GetClientInfo(string clientName, string clientVersion)
         {
-            if (!string.IsNullOrEmpty(clientName) && !ApplicationConfiguration.DefaultClientName.Equals(clientName))
+            if (!string.IsNullOrEmpty(clientName))
             {
                 // space is intentional for formatting of the message
                 if (string.IsNullOrEmpty(clientVersion))

src/client/Microsoft.Identity.Client/Internal/Requests/ClientCredentialRequest.cs

@@ -79,7 +79,9 @@ 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.ApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId, 
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }
                 }
                 catch (MsalServiceException e)

src/client/Microsoft.Identity.Client/Internal/Requests/ManagedIdentityAuthRequest.cs

@@ -72,7 +72,9 @@ 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.ApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }
                 }
                 catch (MsalServiceException e)

src/client/Microsoft.Identity.Client/Internal/Requests/OnBehalfOfRequest.cs

@@ -135,7 +135,9 @@ 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.ApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }
                 }
 

src/client/Microsoft.Identity.Client/Internal/Requests/RequestBase.cs

@@ -22,6 +22,7 @@
 using Microsoft.Identity.Client.TelemetryCore.TelemetryClient;
 using Microsoft.Identity.Client.TelemetryCore.OpenTelemetry;
 using Microsoft.Identity.Client.Internal.Broker;
+using System.Runtime.ConstrainedExecution;
 
 namespace Microsoft.Identity.Client.Internal.Requests
 {
@@ -91,7 +92,7 @@ public async Task<AuthenticationResult> RunAsync(CancellationToken cancellationT
 
                 UpdateTelemetry(measureDurationResult.Milliseconds + measureTelemetryDurationResult.Milliseconds, apiEvent, authenticationResult);
                 LogMetricsFromAuthResult(authenticationResult, AuthenticationRequestParameters.RequestContext.Logger);
-                LogSuccessTelemetryToOtel(authenticationResult, apiEvent.ApiId, measureDurationResult.Microseconds);
+                LogSuccessTelemetryToOtel(authenticationResult, apiEvent, measureDurationResult.Microseconds);
 
                 return authenticationResult;
             }
@@ -117,12 +118,14 @@ public async Task<AuthenticationResult> RunAsync(CancellationToken cancellationT
             }           
         }
 
-        private void LogSuccessTelemetryToOtel(AuthenticationResult authenticationResult, ApiEvent.ApiIds apiId, long durationInUs)
+        private void LogSuccessTelemetryToOtel(AuthenticationResult authenticationResult, ApiEvent apiEvent, long durationInUs)
         {
             // Log metrics
             ServiceBundle.PlatformProxy.OtelInstrumentation.LogSuccessMetrics(
                         ServiceBundle.PlatformProxy.GetProductName(),
-                        apiId,
+                        apiEvent.ApiId,
+                        apiEvent.CallerSdkApiId,
+                        apiEvent.CallerSdkVersion,
                         GetCacheLevel(authenticationResult),
                         durationInUs,
                         authenticationResult.AuthenticationResultMetadata,
@@ -242,12 +245,43 @@ private ApiEvent InitializeApiEvent(string accountId)
             apiEvent.TokenType = AuthenticationRequestParameters.AuthenticationScheme.TelemetryTokenType;
             apiEvent.AssertionType = GetAssertionType();
 
+            UpdateCallerSdkDetails(apiEvent);
+
             // Give derived classes the ability to add or modify fields in the telemetry as needed.
             EnrichTelemetryApiEvent(apiEvent);
 
             return apiEvent;
         }
 
+        private void UpdateCallerSdkDetails(ApiEvent apiEvent)
+        {
+            string callerSdkId;
+            string callerSdkVer;
+
+            // Check if ExtraQueryParameters contains caller-sdk-id and caller-sdk-ver
+            if (AuthenticationRequestParameters.ExtraQueryParameters.TryGetValue("caller-sdk-id", out callerSdkId))
+            {
+
+                AuthenticationRequestParameters.ExtraQueryParameters.Remove("caller-sdk-id");
+            } 
+            else
+            {
+                callerSdkId = AuthenticationRequestParameters.RequestContext.ServiceBundle.Config.ClientName;
+            }
+
+            if (AuthenticationRequestParameters.ExtraQueryParameters.TryGetValue("caller-sdk-ver", out callerSdkVer))
+            {
+                AuthenticationRequestParameters.ExtraQueryParameters.Remove("caller-sdk-ver");
+            }
+            else
+            {
+                callerSdkVer = AuthenticationRequestParameters.RequestContext.ServiceBundle.Config.ClientVersion;
+            }
+
+            apiEvent.CallerSdkApiId = callerSdkId == null ? null : callerSdkId.Substring(0, Math.Min(callerSdkId.Length, 10));
+            apiEvent.CallerSdkVersion = callerSdkVer == null ? null : callerSdkVer.Substring(0, Math.Min(callerSdkVer.Length, 20));
+        }
+
         private AssertionType GetAssertionType()
         {
             if (ServiceBundle.Config.IsManagedIdentity ||

src/client/Microsoft.Identity.Client/Internal/Requests/Silent/CacheSilentStrategy.cs

@@ -98,7 +98,9 @@ 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.ApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkApiId,
+                        AuthenticationRequestParameters.RequestContext.ApiEvent.CallerSdkVersion);
                     }
                 }
 

src/client/Microsoft.Identity.Client/Internal/Requests/SilentRequestHelper.cs

@@ -85,7 +85,9 @@ internal static void ProcessFetchInBackground(
             Func<Task<AuthenticationResult>> fetchAction,
             ILoggerAdapter logger, 
             IServiceBundle serviceBundle, 
-            ApiEvent.ApiIds apiId)
+            ApiEvent.ApiIds apiId, 
+            string callerSdkId, 
+            string callerSdkVersion)
         {
             _ = Task.Run(async () =>
             {
@@ -95,6 +97,8 @@ internal static void ProcessFetchInBackground(
                     serviceBundle.PlatformProxy.OtelInstrumentation.IncrementSuccessCounter(
                         serviceBundle.PlatformProxy.GetProductName(),
                         apiId,
+                        callerSdkId,
+                        callerSdkVersion,
                         TokenSource.IdentityProvider, 
                         CacheRefreshReason.ProactivelyRefreshed, 
                         Cache.CacheLevel.None,

src/client/Microsoft.Identity.Client/OAuth2/TokenClient.cs

@@ -216,6 +216,7 @@ private void AddClaims()
             // no-op if resolvedClaims is null
             _oAuth2Client.AddBodyParameter(OAuth2Parameter.Claims, resolvedClaims);
         }
+
         private void AddExtraHttpHeaders()
         {
             if (_requestParams.ExtraHttpHeaders != null)

src/client/Microsoft.Identity.Client/Platforms/Features/OpenTelemetry/OtelInstrumentation.cs

@@ -92,6 +92,8 @@ public OtelInstrumentation()
         public void LogSuccessMetrics(
             string platform,
             ApiEvent.ApiIds apiId,
+            string callerSdkId,
+            string callerSdkVersion,
             CacheLevel cacheLevel,
             long totalDurationInUs,
             AuthenticationResultMetadata authResultMetadata,
@@ -100,6 +102,8 @@ public void LogSuccessMetrics(
             IncrementSuccessCounter(
                 platform,
                 apiId,
+                callerSdkId,
+                callerSdkVersion,
                 authResultMetadata.TokenSource,
                 authResultMetadata.CacheRefreshReason,
                 cacheLevel,
@@ -151,6 +155,8 @@ public void LogSuccessMetrics(
 
         public void IncrementSuccessCounter(string platform, 
             ApiEvent.ApiIds apiId, 
+            string callerSdkId,
+            string callerSdkVersion,
             TokenSource tokenSource,
             CacheRefreshReason cacheRefreshReason, 
             CacheLevel cacheLevel,
@@ -162,6 +168,8 @@ public void IncrementSuccessCounter(string platform,
                         new(TelemetryConstants.MsalVersion, MsalIdHelper.GetMsalVersion()),
                         new(TelemetryConstants.Platform, platform),
                         new(TelemetryConstants.ApiId, apiId),
+                        new(TelemetryConstants.CallerSdkId, callerSdkId ?? ""),
+                        new(TelemetryConstants.CallerSdkVersion, callerSdkVersion ?? ""),
                         new(TelemetryConstants.TokenSource, tokenSource),
                         new(TelemetryConstants.CacheRefreshReason, cacheRefreshReason),
                         new(TelemetryConstants.CacheLevel, cacheLevel));

src/client/Microsoft.Identity.Client/TelemetryCore/Http/HttpTelemetryManager.cs

@@ -20,7 +20,7 @@ internal class HttpTelemetryManager : IHttpTelemetryManager
     {
         /// <summary>
         /// Expected format: 5|api_id,cache_info,region_used,region_autodetection,region_outcome|platform_config
-        /// platform_config: is_token_cache_serialized,is_legacy_cache_enabled, token_type
+        /// platform_config: is_token_cache_serialized,is_legacy_cache_enabled, token_type, caller_sdk_id, caller_sdk_version
         /// </summary>
         public string GetCurrentRequestHeader(ApiEvent eventInProgress)
         {
@@ -51,6 +51,10 @@ public string GetCurrentRequestHeader(ApiEvent eventInProgress)
             sb.Append(TelemetryConstants.CommaDelimiter);
             // Token type is to indicate 1 - bearer, 2 - pop, 3 - ssh-cert, 4 - external.
             sb.Append(eventInProgress.TokenTypeString);
+            sb.Append(TelemetryConstants.CommaDelimiter);
+            sb.Append(eventInProgress.CallerSdkApiId);
+            sb.Append(TelemetryConstants.CommaDelimiter);
+            sb.Append(eventInProgress.CallerSdkVersion);
 
             return sb.ToString();
         }

src/client/Microsoft.Identity.Client/TelemetryCore/Internal/Events/ApiEvent.cs

@@ -135,7 +135,11 @@ public string TokenTypeString
         public CacheLevel CacheLevel { get; set; }
 
         public string MsalRuntimeTelemetry { get; set; }
-
+
+        public string CallerSdkApiId { get; set; }
+
+        public string CallerSdkVersion { get; set; }
+
         public static bool IsLongRunningObo(ApiIds apiId) => apiId == ApiIds.InitiateLongRunningObo || apiId == ApiIds.AcquireTokenInLongRunningObo;
 
         public static bool IsOnBehalfOfRequest(ApiIds apiId) => apiId == ApiIds.AcquireTokenOnBehalfOf || IsLongRunningObo(apiId);

src/client/Microsoft.Identity.Client/TelemetryCore/OpenTelemetry/IOtelInstrumentation.cs

@@ -14,13 +14,17 @@ internal interface IOtelInstrumentation
         internal void LogSuccessMetrics(
             string platform,
             ApiEvent.ApiIds apiId,
+            string callerSdkId,
+            string callerSdkVersion,
             CacheLevel cacheLevel,
             long totalDurationInUs,
             AuthenticationResultMetadata authResultMetadata,
             ILoggerAdapter logger);
 
         internal void IncrementSuccessCounter(string platform,
             ApiEvent.ApiIds apiId,
+            string callerSdkId,
+            string callerSdkVersion,
             TokenSource tokenSource,
             CacheRefreshReason cacheRefreshReason,
             CacheLevel cacheLevel,

src/client/Microsoft.Identity.Client/TelemetryCore/OpenTelemetry/NullOtelInstrumentation.cs

@@ -17,6 +17,8 @@ internal class NullOtelInstrumentation : IOtelInstrumentation
         public void LogSuccessMetrics(
             string platform,
             ApiEvent.ApiIds apiId,
+            string callerSdkId,
+            string callerSdkVersion,
             CacheLevel cacheLevel,
             long totalDurationInUs,
             AuthenticationResultMetadata authResultMetadata,
@@ -34,7 +36,9 @@ public void LogFailureMetrics(string platform,
         }
 
         void IOtelInstrumentation.IncrementSuccessCounter(string platform, 
-            ApiEvent.ApiIds apiId, 
+            ApiEvent.ApiIds apiId,
+            string callerSdkId,
+            string callerSdkVersion,
             TokenSource tokenSource, 
             CacheRefreshReason cacheRefreshReason, 
             CacheLevel cacheLevel, 

src/client/Microsoft.Identity.Client/TelemetryCore/TelemetryConstants.cs

@@ -44,6 +44,8 @@ internal static class TelemetryConstants
         public const string Platform = "Platform";
         public const string ApiId = "ApiId";
         public const string IsProactiveRefresh = "IsProactiveRefresh";
+        public const string CallerSdkId = "CallerSdkId";
+        public const string CallerSdkVersion = "CallerSdkVersion";
 
 #endregion
     }

tests/Microsoft.Identity.Test.Unit/AppConfigTests/ConfidentialClientApplicationBuilderTests.cs

@@ -41,8 +41,6 @@ public void TestConstructor()
             // Validate Defaults
             Assert.AreEqual(LogLevel.Info, cca.AppConfig.LogLevel);
             Assert.AreEqual(TestConstants.ClientId, cca.AppConfig.ClientId);
-            Assert.IsNotNull(cca.AppConfig.ClientName);
-            Assert.IsNotNull(cca.AppConfig.ClientVersion);
             Assert.AreEqual(false, cca.AppConfig.EnablePiiLogging);
             Assert.IsNull(cca.AppConfig.HttpClientFactory);
             Assert.AreEqual(false, cca.AppConfig.IsDefaultPlatformLoggingEnabled);

tests/Microsoft.Identity.Test.Unit/AppConfigTests/ManagedIdentityApplicationBuilderTests.cs

@@ -38,9 +38,6 @@ public void TestConstructor()
             Assert.AreEqual(Constants.DefaultConfidentialClientRedirectUri, mi.ServiceBundle.Config.RedirectUri);
             Assert.AreEqual(Constants.ManagedIdentityDefaultTenant, mi.ServiceBundle.Config.TenantId);
 
-            Assert.IsNotNull(mi.ServiceBundle.Config.ClientName);
-            Assert.IsNotNull(mi.ServiceBundle.Config.ClientVersion);
-
             Assert.IsNull(mi.ServiceBundle.Config.HttpClientFactory);
             Assert.IsNull(mi.ServiceBundle.Config.LoggingCallback);
 
@@ -64,9 +61,6 @@ public void TestConstructor_WithCreateUserAssignedId()
             Assert.AreEqual(Constants.DefaultConfidentialClientRedirectUri, mi.ServiceBundle.Config.RedirectUri);
             Assert.AreEqual(Constants.ManagedIdentityDefaultTenant, mi.ServiceBundle.Config.TenantId);
 
-            Assert.IsNotNull(mi.ServiceBundle.Config.ClientName);
-            Assert.IsNotNull(mi.ServiceBundle.Config.ClientVersion);
-
             Assert.IsNotNull(mi.ServiceBundle.Config.ManagedIdentityId);
             Assert.AreEqual(ManagedIdentityIdType.ClientId, mi.ServiceBundle.Config.ManagedIdentityId.IdType);
             Assert.AreEqual(TestConstants.ClientId, mi.ServiceBundle.Config.ManagedIdentityId.UserAssignedId);

tests/Microsoft.Identity.Test.Unit/AppConfigTests/PublicClientApplicationBuilderTests.cs

@@ -30,8 +30,6 @@ public void TestConstructor()
             // Validate Defaults
             Assert.AreEqual(LogLevel.Info, pca.AppConfig.LogLevel);
             Assert.AreEqual(TestConstants.ClientId, pca.AppConfig.ClientId);
-            Assert.IsNotNull(pca.AppConfig.ClientName);
-            Assert.IsNotNull(pca.AppConfig.ClientVersion);
             Assert.IsFalse(pca.AppConfig.EnablePiiLogging);
             Assert.IsNull(pca.AppConfig.HttpClientFactory);
             Assert.IsFalse(pca.AppConfig.IsDefaultPlatformLoggingEnabled);