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

src/client/Microsoft.Identity.Client/ApiConfig/Parameters/AcquireTokenCommonParameters.cs

@@ -25,7 +25,7 @@ internal class AcquireTokenCommonParameters
         public string Claims { get; set; }
         public AuthorityInfo AuthorityOverride { get; set; }
         public IAuthenticationScheme AuthenticationScheme { get; set; } = new BearerAuthenticationScheme();
-        public IDictionary<string, string> ExtraHttpHeaders { get; set; }
+        public IDictionary<string, string> ExtraHttpHeaders { get; } = new Dictionary<string, string>();
         public PoPAuthenticationConfiguration PopAuthenticationConfiguration { get; set; }
         public Func<OnBeforeTokenRequestData, Task> OnBeforeTokenRequestHandler { get; internal set; }
         public X509Certificate2 MtlsCertificate { get; internal set; }

src/client/Microsoft.Identity.Client/Extensibility/AcquireTokenParameterBuilderExtensions.cs

@@ -21,7 +21,10 @@ public static T WithExtraHttpHeaders<T>(
             IDictionary<string, string> extraHttpHeaders)
             where T : AbstractAcquireTokenParameterBuilder<T>
         {
-            builder.CommonParameters.ExtraHttpHeaders = extraHttpHeaders;
+            foreach (var kvp in extraHttpHeaders)
+            {
+                builder.CommonParameters.ExtraHttpHeaders.Add(kvp.Key, kvp.Value);
+            }
             return (T)builder;
         }
     }

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

@@ -69,7 +69,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

@@ -91,7 +91,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 +117,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,6 +244,18 @@ private ApiEvent InitializeApiEvent(string accountId)
             apiEvent.TokenType = AuthenticationRequestParameters.AuthenticationScheme.TelemetryTokenType;
             apiEvent.AssertionType = GetAssertionType();
 
+            if (AuthenticationRequestParameters.ExtraQueryParameters.ContainsKey("caller-sdk-id"))
+            {
+                apiEvent.CallerSdkApiId = AuthenticationRequestParameters.ExtraQueryParameters["caller-sdk-id"];
+                AuthenticationRequestParameters.ExtraQueryParameters.Remove("caller-sdk-id");
+            }
+
+            if (AuthenticationRequestParameters.ExtraQueryParameters.ContainsKey("caller-sdk-ver"))
+            {
+                apiEvent.CallerSdkVersion = AuthenticationRequestParameters.ExtraQueryParameters["caller-sdk-ver"];
+                AuthenticationRequestParameters.ExtraQueryParameters.Remove("caller-sdk-ver");
+            }
+
             // Give derived classes the ability to add or modify fields in the telemetry as needed.
             EnrichTelemetryApiEvent(apiEvent);
 

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/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/TelemetryTests/HttpTelemetryTests.cs

@@ -625,7 +625,7 @@ private void AssertCurrentTelemetry(
             Assert.AreEqual(3, telemetryCategories.Length);
             Assert.AreEqual(1, telemetryCategories[0].Split(',').Length); // version
             Assert.AreEqual(5, telemetryCategories[1].Split(',').Length); // api_id, cache_info, region_used, region_source, region_outcome
-            Assert.AreEqual(3, telemetryCategories[2].Split(',').Length); // platform_fields
+            Assert.AreEqual(5, telemetryCategories[2].Split(',').Length); // platform_fields
 
             Assert.AreEqual(TelemetryConstants.HttpTelemetrySchemaVersion.ToString(), telemetryCategories[0]); // version
 

tests/Microsoft.Identity.Test.Unit/TelemetryTests/OTelInstrumentationTests.cs

@@ -366,6 +366,8 @@ private void VerifyMetrics(int expectedMetricCount, List<Metric> exportedMetrics
                         expectedTags.Add(TelemetryConstants.MsalVersion);
                         expectedTags.Add(TelemetryConstants.Platform);
                         expectedTags.Add(TelemetryConstants.ApiId);
+                        expectedTags.Add(TelemetryConstants.CallerSdkId);
+                        expectedTags.Add(TelemetryConstants.CallerSdkVersion);
                         expectedTags.Add(TelemetryConstants.TokenSource);
                         expectedTags.Add(TelemetryConstants.CacheRefreshReason);
                         expectedTags.Add(TelemetryConstants.CacheLevel);
@@ -472,8 +474,6 @@ private void VerifyMetrics(int expectedMetricCount, List<Metric> exportedMetrics
                         Assert.Fail("Unexpected metrics logged.");
                         break;
                 }
-
-
             }
         }
 

tests/Microsoft.Identity.Test.Unit/TelemetryTests/RegionalTelemetryTests.cs

@@ -346,7 +346,7 @@ private static void AssertCurrentTelemetry(
             Assert.AreEqual(3, telemetryCategories.Length);
             Assert.AreEqual(1, telemetryCategories[0].Split(',').Length); // version
             Assert.AreEqual(5, telemetryCategories[1].Split(',').Length); // api_id, cache_info, region_used, region_source, region_outcome
-            Assert.AreEqual(3, telemetryCategories[2].Split(',').Length); // platform_fields
+            Assert.AreEqual(5, telemetryCategories[2].Split(',').Length); // platform_fields
 
             Assert.AreEqual(TelemetryConstants.HttpTelemetrySchemaVersion.ToString(), telemetryCategories[0]); // version