[Observability] Use custom domain for A365 service #114

Copilot · 2025-12-05T19:49:15Z

Potential null reference exception: this.Configuration can be null (as indicated by the nullable type on line 30), but EnvironmentUtils.Initialize() throws ArgumentNullException if configuration is null (line 68-71 in EnvironmentUtils.cs).

Either:

Add a null check before calling Initialize, or

Pass a default empty configuration if Configuration is null, or

Make Configuration non-nullable if it's always required

Suggested change

EnvironmentUtils.Initialize(configuration: this.Configuration);

EnvironmentUtils.Initialize(configuration: this.Configuration ?? new ConfigurationBuilder().Build());

Copilot · 2025-12-05T19:49:13Z

The field name clusterCategory should follow C# naming conventions and use PascalCase with an underscore prefix for private fields (e.g., _clusterCategory), consistent with the naming pattern used elsewhere in the codebase.

juliomenendez · 2025-12-05T17:53:57Z

Instead forcing this to be static and use this Initialize method, do you think it would make sense to convert this class to instantiable? Meaning we make the methods non-static and do this IConfiguration in the constructor?

We can but it would be a breaking change for consumers. We will register and they will have to resolve EnvironmentUtils from their service collection. Or they create an instance of EnvironmentUtils and supply IConfiguration. All this temporarily (because eventually we just want to use the custom domain, no need of the configuration at all, right?)

Whereas today they simply invoke EnvironmentUtils.GetAuthenticationScope()

Copilot · 2025-12-03T22:48:31Z

The XML documentation should include the parameter description. Add:

/// <param name="configuration">The configuration instance to check for custom domain settings. If null, returns false.</param> /// <returns>True if custom domain is enabled; otherwise, false.</returns>

Suggested change

/// </summary>

/// </summary>

/// <param name="configuration">The configuration instance to check for custom domain settings. If null, returns false.</param>

/// <returns>True if custom domain is enabled; otherwise, false.</returns>

Copilot · 2025-12-05T19:49:14Z

The configuration variable is retrieved from the service provider but never used. If this was intended to initialize EnvironmentUtils, it should be done here. Otherwise, this variable should be removed to avoid confusion.

Suggested change

var configuration = serviceProvider.GetService<Microsoft.Extensions.Configuration.IConfiguration>();

Copilot · 2025-12-03T22:48:30Z

The class name should be Agent365EndpointDiscoveryTests (plural) to match the naming convention used elsewhere in the test suite (e.g., Agent365ExporterTests, EnvironmentUtilsTests).

-Original file line number
+Diff line change
@@ -0,0 +1,41 @@
+    // ------------------------------------------------------------------------------
+    // Copyright (c) Microsoft Corporation. All rights reserved.
+    // ------------------------------------------------------------------------------
+    using System;
+    namespace Microsoft.Agents.A365.Observability.Runtime.Common
+    {
+        /// <summary>
+        /// Provides discovery for Agent365 endpoints.
+        /// </summary>
+        public sealed class Agent365EndpointDiscovery
+        {
+            private readonly string clusterCategory;
+            /// <summary>
+            /// Initializes a new instance of the <see cref="Agent365EndpointDiscovery"/> class.
+            /// </summary>
+            /// <param name="clusterCategory">The cluster category.</param>
+            public Agent365EndpointDiscovery(string clusterCategory)
+            {
+                this.clusterCategory = clusterCategory ?? "production";
+            }
+            /// <summary>
+            /// Gets the base host for the specified cluster category.
+            /// </summary>
+            public string GetHost()
+            {
+                switch (this.clusterCategory?.ToLowerInvariant())
+                {
+                    case "firstrelease":
+                    case "production":
+                    case "prod":
+                        return "agent365.svc.cloud.microsoft";
+                    default:
+                        throw new ArgumentException($"Invalid ClusterCategory value: {clusterCategory}");
+                }
+            }
+        }
+    }

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
     using Microsoft.Agents.A365.Observability.Runtime.Common;
     using Microsoft.Agents.A365.Observability.Runtime.Tracing.Scopes;
+    using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.Logging;
     using Microsoft.Extensions.Logging.Abstractions;
     using OpenTelemetry;
@@ Expand All @@
         public class Agent365ExporterCore
         {
             private const string CorrelationIdHeaderKey = "x-ms-correlation-id";
+            private const string TenantIdHeaderKey = "x-ms-tenant-id";
             private readonly ExportFormatter _formatter;
             private readonly ILogger<Agent365ExporterCore> _logger;
@@ Expand Down Expand Up @@
             /// <returns>The endpoint path string.</returns>
             public string BuildEndpointPath(string agentId, bool useS2SEndpoint)
             {
-                return useS2SEndpoint
-                    ? $"/maven/agent365/service/agents/{agentId}/traces"
-                    : $"/maven/agent365/agents/{agentId}/traces";
+                return EnvironmentUtils.IsCustomDomainEnabled()
+                    ? $"/agents/{agentId}/traces"
+                    : useS2SEndpoint
+                        ? $"/maven/agent365/service/agents/{agentId}/traces"
+                        : $"/maven/agent365/agents/{agentId}/traces";
             }
             /// <summary>
@@ Expand All @@
             /// <param name="endpoint">The base endpoint.</param>
             /// <param name="endpointPath">The endpoint path.</param>
             /// <returns>The full request URI string.</returns>
-            public string BuildRequestUri(string endpoint, string endpointPath)
+            public static string BuildRequestUri(string endpoint, string endpointPath)
             {
                 return $"https://{endpoint}{endpointPath}?api-version=1";
             }
@@ Expand All / @@ -124,11 +128,11 @@ public async Task<ExportResult> ExportBatchCoreAsync( @@
                     var json = _formatter.FormatMany(activities, resource);
                     using var content = new StringContent(json, Encoding.UTF8, "application/json");
-                    var ppapiDiscovery = new PowerPlatformApiDiscovery(options.ClusterCategory);
-                    var ppapiEndpoint = ppapiDiscovery.GetTenantIslandClusterEndpoint(tenantId);
-                    var endpointPath = BuildEndpointPath(agentId, options.UseS2SEndpoint);
-                    var requestUri = BuildRequestUri(ppapiEndpoint, endpointPath);
+                    string endpointPath = this.BuildEndpointPath(agentId: agentId, useS2SEndpoint: options.UseS2SEndpoint);
+                    var endpoint = EnvironmentUtils.IsCustomDomainEnabled()
+                        ? new Agent365EndpointDiscovery(options.ClusterCategory).GetHost()
+                        : new PowerPlatformApiDiscovery(options.ClusterCategory).GetTenantIslandClusterEndpoint(tenantId);
+                    var requestUri = Agent365ExporterCore.BuildRequestUri(endpoint, endpointPath);
                     using var request = new HttpRequestMessage(HttpMethod.Post, requestUri)
                     {
@@ Expand All / @@ -149,6 +153,11 @@ public async Task<ExportResult> ExportBatchCoreAsync( @@
                     if (!string.IsNullOrEmpty(token))
                         request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
+                    if (EnvironmentUtils.IsCustomDomainEnabled() && !string.IsNullOrEmpty(tenantId))
+                    {
+                        request.Headers.TryAddWithoutValidation(Agent365ExporterCore.TenantIdHeaderKey, tenantId);
+                    }
                     HttpResponseMessage? resp = null;
                     try
                     {
@@ Expand Down @@

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    // ------------------------------------------------------------------------------
+    // Copyright (c) Microsoft Corporation. All rights reserved.
+    // ------------------------------------------------------------------------------
+    using Microsoft.Agents.A365.Observability.Runtime.Common;
+    namespace Microsoft.Agents.A365.Observability.Runtime.Tests.Common;
+    [TestClass]
+    public class Agent365EndpointDiscoveryTests
+    {
+        [TestMethod]
+        public void GetHost_Mapping_IsCorrect()
+        {
+            var expected = new Dictionary<string, string>
+            {
+                ["firstrelease"] = "agent365.svc.cloud.microsoft",
+                ["production"] = "agent365.svc.cloud.microsoft",
+                ["prod"] = "agent365.svc.cloud.microsoft",
+            };
+            foreach (var kv in expected)
+            {
+                var disc = new Agent365EndpointDiscovery(kv.Key);
+                Assert.AreEqual(kv.Value, disc.GetHost());
+            }
+        }
+        [TestMethod]
+        public void GetHost_IsCaseInsensitive()
+        {
+            var disc1 = new Agent365EndpointDiscovery("PRODUCTION");
+            Assert.AreEqual("agent365.svc.cloud.microsoft", disc1.GetHost());
+            var disc2 = new Agent365EndpointDiscovery("PROD");
+            Assert.AreEqual("agent365.svc.cloud.microsoft", disc2.GetHost());
+        }
+        [TestMethod]
+        public void GetHost_ThrowsForUnknown()
+        {
+            var disc = new Agent365EndpointDiscovery("unknown-category");
+            Assert.ThrowsException<System.ArgumentException>(() => disc.GetHost());
+        }
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,126 @@
+    // ------------------------------------------------------------------------------
+    // Copyright (c) Microsoft Corporation. All rights reserved.
+    // ------------------------------------------------------------------------------
+    using FluentAssertions;
+    using Microsoft.Extensions.Configuration;
+    using Microsoft.Agents.A365.Observability.Runtime.Common;
+    namespace Microsoft.Agents.A365.Observability.Runtime.Tests.Common
+    {
+        [TestClass]
+        public class EnvironmentUtilsTests
+        {
+            private static IConfiguration BuildConfig(IDictionary<string, string?>? values = null)
+            {
+                var builder = new ConfigurationBuilder();
+                if (values != null)
+                {
+                    builder.AddInMemoryCollection(values);
+                }
+                return builder.Build();
+            }
+            [TestMethod]
+            public void GetObservabilityAuthenticationScope_UsesAgent365Scope_WhenCustomDomainEnabled()
+            {
+                // Arrange
+                var configEnabled = BuildConfig(new Dictionary<string, string?>
+                {
+                    { "EnableAgent365CustomDomain", "true" }
+                });
+                EnvironmentUtils.Initialize(configuration: configEnabled, force: true);
+                // Act
+                var scope = EnvironmentUtils.GetObservabilityAuthenticationScope();
+                // Assert
+                scope.Should().ContainSingle().Which.Should().Be("api://9b975845-388f-4429-889e-eab1ef63949c/.default");
+            }
+            [TestMethod]
+            public void GetObservabilityAuthenticationScope_UsesProdScope_WhenCustomDomainDisabled()
+            {
+                // Arrange
+                var configDisabled = BuildConfig(new Dictionary<string, string?>
+                {
+                    { "EnableAgent365CustomDomain", "false" }
+                });
+                EnvironmentUtils.Initialize(configuration: configDisabled, force: true);
+                // Act
+                var scope = EnvironmentUtils.GetObservabilityAuthenticationScope();
+                // Assert
+                scope.Should().ContainSingle().Which.Should().Be("https://api.powerplatform.com/.default");
+            }
+            [TestMethod]
+            public void GetObservabilityAuthenticationScope_UsesProdScope_WhenCustomDomainSettingMissing()
+            {
+                // Arrange
+                var configMissing = BuildConfig();
+                EnvironmentUtils.Initialize(configuration: configMissing, force: true);
+                // Act
+                var scope = EnvironmentUtils.GetObservabilityAuthenticationScope();
+                // Assert
+                scope.Should().ContainSingle().Which.Should().Be("https://api.powerplatform.com/.default");
+            }
+            [TestMethod]
+            public void IsCustomDomainEnabled_ReturnsTrue_WhenConfigValueTrue()
+            {
+                // Arrange
+                var config = BuildConfig(new Dictionary<string, string?>
+                {
+                    { "EnableAgent365CustomDomain", "true" }
+                });
+                EnvironmentUtils.Initialize(configuration: config, force: true);
+                // Act
+                var result = EnvironmentUtils.IsCustomDomainEnabled();
+                // Assert
+                result.Should().BeTrue();
+            }
+            [TestMethod]
+            public void IsCustomDomainEnabled_ReturnsFalse_WhenConfigValueFalse()
+            {
+                // Arrange
+                var config = BuildConfig(new Dictionary<string, string?>
+                {
+                    { "EnableAgent365CustomDomain", "false" }
+                });
+                EnvironmentUtils.Initialize(configuration: config, force: true);
+                // Act
+                var result = EnvironmentUtils.IsCustomDomainEnabled();
+                // Assert
+                result.Should().BeFalse();
+            }
+            [TestMethod]
+            public void IsCustomDomainEnabled_ReturnsFalse_WhenConfigValueMissing()
+            {
+                // Arrange
+                var config = BuildConfig();
+                EnvironmentUtils.Initialize(configuration: config, force: true);
+                // Act
+                var result = EnvironmentUtils.IsCustomDomainEnabled();
+                // Assert
+                result.Should().BeFalse();
+            }
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Observability] Use custom domain for A365 service #114

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Copilot AI Dec 5, 2025

Uh oh!

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juliomenendez Dec 5, 2025

Uh oh!

threddy Dec 5, 2025

Uh oh!

Uh oh!

Copilot AI Dec 3, 2025

Uh oh!

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Uh oh!

Copilot AI Dec 3, 2025

Uh oh!

Uh oh!

[Observability] Use custom domain for A365 service #114

Are you sure you want to change the base?

Uh oh!

[Observability] Use custom domain for A365 service #114

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juliomenendez Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

threddy Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!