Use uniform convention for naming and annotating DCP objects with regards to OTEL (dotnet#4661)

Co-authored-by: James Newton-King <[email protected]>

Author: karolz-ms

src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs

@@ -191,7 +191,9 @@ private void UpdateResourcesList()
             }
         }
 
-        _resources = builder.ToImmutable();
+        builder.Sort((r1, r2) => StringComparers.ResourceName.Compare(r1.Name, r2.Name));
+
+        _resources = builder.ToImmutableList();
 
         SelectViewModel<ResourceTypeDetails> ToOption(ResourceViewModel resource, bool isReplica, string applicationName)
         {

src/Aspire.Dashboard/Model/Otlp/ApplicationsSelectHelpers.cs

@@ -27,9 +27,13 @@ public static SelectViewModel<ResourceTypeDetails> GetApplication(this List<Sele
         {
             // There are multiple matches. Log as much information as possible about applications.
             logger.LogWarning(
-                $"Multiple matches found when getting application '{name}'. " +
-                $"Available applications: {string.Join(Environment.NewLine, applications)} " +
-                $"Matched applications: {string.Join(Environment.NewLine, matches)}");
+                """
+                Multiple matches found when getting application '{Name}'.
+                Available applications:
+                {AvailableApplications}
+                Matched applications:
+                {MatchedApplications}
+                """, name, string.Join(Environment.NewLine, applications), string.Join(Environment.NewLine, matches));
 
             // Return first match to not break app. Make the UI resilient to unexpectedly bad data.
             return matches[0];
@@ -69,10 +73,11 @@ public static List<SelectViewModel<ResourceTypeDetails>> CreateApplications(List
                 new SelectViewModel<ResourceTypeDetails>
                 {
                     Id = ResourceTypeDetails.CreateReplicaInstance(replica.InstanceId, applicationName),
-                    Name = replica.InstanceId
+                    Name = OtlpApplication.GetResourceName(replica, applications)
                 }));
         }
 
-        return selectViewModels;
+        var sortedVMs = selectViewModels.OrderBy(vm => vm.Name, StringComparers.ResourceName).ToList();
+        return sortedVMs;
     }
 }

src/Aspire.Dashboard/Model/ResourceViewModel.cs

@@ -47,6 +47,8 @@ public static string GetResourceName(ResourceViewModel resource, ConcurrentDicti
                 count++;
                 if (count >= 2)
                 {
+                    // There are multiple resources with the same display name so they're part of a replica set.
+                    // Need to use the name which has a unique ID to tell them apart.
                     return resource.Name;
                 }
             }

src/Aspire.Dashboard/Otlp/Model/OtlpApplication.cs

@@ -193,12 +193,12 @@ public static string GetResourceName(OtlpApplication app, List<OtlpApplication>
         var count = 0;
         foreach (var item in allApplications)
         {
-            if (item.ApplicationName == app.ApplicationName)
+            if (string.Equals(item.ApplicationName, app.ApplicationName, StringComparisons.ResourceName))
             {
                 count++;
                 if (count >= 2)
                 {
-                    return app.InstanceId;
+                    return $"{item.ApplicationName}-{app.InstanceId}";
                 }
             }
         }

src/Aspire.Dashboard/ResourceService/DashboardClient.cs

@@ -229,9 +229,17 @@ private void EnsureInitialized()
 
         async Task ConnectAndWatchResourcesAsync(CancellationToken cancellationToken)
         {
-            await ConnectAsync().ConfigureAwait(false);
+            try
+            {
+                await ConnectAsync().ConfigureAwait(false);
 
-            await WatchResourcesWithRecoveryAsync().ConfigureAwait(false);
+                await WatchResourcesWithRecoveryAsync().ConfigureAwait(false);
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, "Error loading data from the resource service.");
+                throw;
+            }
 
             async Task ConnectAsync()
             {

src/Aspire.Hosting/Dcp/ApplicationExecutor.cs

@@ -73,6 +73,12 @@ internal sealed class ApplicationExecutor(ILogger<ApplicationExecutor> logger,
 {
     private const string DebugSessionPortVar = "DEBUG_SESSION_PORT";
 
+    // A random suffix added to every DCP object name ensures that those names (and derived object names, for example container names)
+    // are unique machine-wide with a high level of probability.
+    // The length of 8 achieves that while keeping the names relatively short and readable.
+    // The second purpose of the suffix is to play a role of a unique OpenTelemetry service instance ID.
+    private const int RandomNameSuffixLength = 8;
+
     private readonly ILogger<ApplicationExecutor> _logger = logger;
     private readonly DistributedApplicationModel _model = model;
     private readonly Dictionary<string, IResource> _applicationModel = model.Resources.ToDictionary(r => r.Name);
@@ -448,8 +454,8 @@ private void StartLogStream<T>(T resource) where T : CustomResource
     {
         IAsyncEnumerable<IReadOnlyList<(string, bool)>>? enumerable = resource switch
         {
-            Container c when c.LogsAvailable => new ResourceLogSource<T>(_logger, kubernetesService, resource),
-            Executable e when e.LogsAvailable => new ResourceLogSource<T>(_logger, kubernetesService, resource),
+            Container c when c.LogsAvailable => new ResourceLogSource<T>(_logger, kubernetesService, _dcpInfo?.Version, resource),
+            Executable e when e.LogsAvailable => new ResourceLogSource<T>(_logger, kubernetesService, _dcpInfo?.Version, resource),
             _ => null
         };
 
@@ -971,14 +977,16 @@ private void PreparePlainExecutables()
 
         foreach (var executable in modelExecutableResources)
         {
-            var exeName = GetObjectNameForResource(executable);
+            var nameSuffix = GetRandomNameSuffix();
+            var exeName = GetObjectNameForResource(executable, nameSuffix);
             var exePath = executable.Command;
             var exe = Executable.Create(exeName, exePath);
 
             // The working directory is always relative to the app host project directory (if it exists).
             exe.Spec.WorkingDirectory = executable.WorkingDirectory;
             exe.Spec.ExecutionType = ExecutionType.Process;
-            exe.Annotate(CustomResource.OtelServiceNameAnnotation, exe.Metadata.Name);
+            exe.Annotate(CustomResource.OtelServiceNameAnnotation, executable.Name);
+            exe.Annotate(CustomResource.OtelServiceInstanceIdAnnotation, nameSuffix);
             exe.Annotate(CustomResource.ResourceNameAnnotation, executable.Name);
             SetInitialResourceState(executable, exe);
 
@@ -1007,6 +1015,7 @@ private void PrepareProjectExecutables()
 
             IAnnotationHolder annotationHolder = ers.Spec.Template;
             annotationHolder.Annotate(CustomResource.OtelServiceNameAnnotation, ers.Metadata.Name);
+            // The OTEL service instance ID annotation will be generated and applied automatically by DCP.
             annotationHolder.Annotate(CustomResource.ResourceNameAnnotation, project.Name);
 
             SetInitialResourceState(project, annotationHolder);
@@ -1018,29 +1027,10 @@ private void PrepareProjectExecutables()
             {
                 exeSpec.ExecutionType = ExecutionType.IDE;
 
-                if (_dcpInfo?.Version?.CompareTo(DcpVersion.MinimumVersionIdeProtocolV1) >= 0)
+                projectLaunchConfiguration.DisableLaunchProfile = project.TryGetLastAnnotation<ExcludeLaunchProfileAnnotation>(out _);
+                if (!projectLaunchConfiguration.DisableLaunchProfile && project.TryGetLastAnnotation<LaunchProfileAnnotation>(out var lpa))
                 {
-                    projectLaunchConfiguration.DisableLaunchProfile = project.TryGetLastAnnotation<ExcludeLaunchProfileAnnotation>(out _);
-                    if (!projectLaunchConfiguration.DisableLaunchProfile && project.TryGetLastAnnotation<LaunchProfileAnnotation>(out var lpa))
-                    {
-                        projectLaunchConfiguration.LaunchProfile = lpa.LaunchProfileName;
-                    }
-                }
-                else
-                {
-#pragma warning disable CS0612 // These annotations are obsolete; remove after Aspire GA
-                    annotationHolder.Annotate(Executable.CSharpProjectPathAnnotation, projectMetadata.ProjectPath);
-
-                    // ExcludeLaunchProfileAnnotation takes precedence over LaunchProfileAnnotation.
-                    if (project.TryGetLastAnnotation<ExcludeLaunchProfileAnnotation>(out _))
-                    {
-                        annotationHolder.Annotate(Executable.CSharpDisableLaunchProfileAnnotation, "true");
-                    }
-                    else if (project.TryGetLastAnnotation<LaunchProfileAnnotation>(out var lpa))
-                    {
-                        annotationHolder.Annotate(Executable.CSharpLaunchProfileAnnotation, lpa.LaunchProfileName);
-                    }
-#pragma warning restore CS0612
+                    projectLaunchConfiguration.LaunchProfile = lpa.LaunchProfileName;
                 }
             }
             else
@@ -1327,10 +1317,14 @@ private void PrepareContainers()
                 throw new InvalidOperationException();
             }
 
-            var ctr = Container.Create(GetObjectNameForResource(container), containerImageName);
+            var nameSuffix = GetRandomNameSuffix();
+            var containerObjectName = GetObjectNameForResource(container, nameSuffix);
+            var ctr = Container.Create(containerObjectName, containerImageName);
 
+            ctr.Spec.ContainerName = containerObjectName; // Use the same name for container orchestrator (Docker, Podman) resource and DCP object name.
             ctr.Annotate(CustomResource.ResourceNameAnnotation, container.Name);
             ctr.Annotate(CustomResource.OtelServiceNameAnnotation, container.Name);
+            ctr.Annotate(CustomResource.OtelServiceInstanceIdAnnotation, nameSuffix);
             SetInitialResourceState(container, ctr);
 
             if (container.TryGetContainerMounts(out var containerMounts))
@@ -1739,9 +1733,9 @@ static string maybeWithSuffix(string s, string localSuffix, string? globalSuffix
             => (string.IsNullOrWhiteSpace(localSuffix), string.IsNullOrWhiteSpace(globalSuffix)) switch
             {
                 (true, true) => s,
-                (false, true) => $"{s}_{localSuffix}",
-                (true, false) => $"{s}_{globalSuffix}",
-                (false, false) => $"{s}_{localSuffix}_{globalSuffix}"
+                (false, true) => $"{s}-{localSuffix}",
+                (true, false) => $"{s}-{globalSuffix}",
+                (false, false) => $"{s}-{localSuffix}-{globalSuffix}"
             };
         return maybeWithSuffix(resource.Name, suffix, _options.Value.ResourceNameSuffix);
     }
@@ -1753,7 +1747,7 @@ private static string GenerateUniqueServiceName(HashSet<string> serviceNames, st
 
         while (!serviceNames.Add(uniqueName))
         {
-            uniqueName = $"{candidateName}_{suffix}";
+            uniqueName = $"{candidateName}-{suffix}";
             suffix++;
             if (suffix == 100)
             {
@@ -1765,6 +1759,13 @@ private static string GenerateUniqueServiceName(HashSet<string> serviceNames, st
         return uniqueName;
     }
 
+    private static string GetRandomNameSuffix()
+    {
+        // RandomNameSuffixLength of lowercase characters
+        var suffix = PasswordGenerator.Generate(RandomNameSuffixLength, true, false, false, false, RandomNameSuffixLength, 0, 0, 0);
+        return suffix;
+    }
+
     public async Task DeleteResourcesAsync(CancellationToken cancellationToken = default)
     {
         try

src/Aspire.Hosting/Dcp/DcpVersion.cs

@@ -5,8 +5,8 @@ namespace Aspire.Hosting.Dcp;
 
 internal static class DcpVersion
 {
-    public static Version MinimumVersionInclusive = new Version(0, 1, 55);
-    public static Version MinimumVersionIdeProtocolV1 = new Version(0, 1, 61);
+    public static Version MinimumVersionInclusive = new Version(0, 2, 3); // Aspire GA (8.0) release
+    public static Version MinimumVersionAspire_8_1 = new Version(0, 5, 6);
 
     /// <summary>
     /// Development build version proxy, considered always "current" and supporting latest features. 

src/Aspire.Hosting/Dcp/Model/ModelCommon.cs

@@ -23,6 +23,7 @@ internal abstract class CustomResource : KubernetesObject, IMetadata<V1ObjectMet
     public const string EndpointNameAnnotation = "endpoint-name";
     public const string ResourceNameAnnotation = "resource-name";
     public const string OtelServiceNameAnnotation = "otel-service-name";
+    public const string OtelServiceInstanceIdAnnotation = "otel-service-instance-id";
     public const string ResourceStateAnnotation = "resource-state";
 
     public string? AppModelResourceName => Metadata.Annotations?.TryGetValue(ResourceNameAnnotation, out var value) is true ? value : null;

src/Aspire.Hosting/Dcp/ResourceLogSource.cs

@@ -13,6 +13,7 @@ namespace Aspire.Hosting.Dcp;
 internal sealed class ResourceLogSource<TResource>(
     ILogger logger,
     IKubernetesService kubernetesService,
+    Version? dcpVersion,
     TResource resource) :
     IAsyncEnumerable<LogEntryList>
     where TResource : CustomResource
@@ -35,7 +36,7 @@ public async IAsyncEnumerator<LogEntryList> GetAsyncEnumerator(CancellationToken
 
         var timestamps = resource is Container; // Timestamps are available only for Containers as of Aspire P5.
 
-        if (resource is Container)
+        if (resource is Container && dcpVersion?.CompareTo(DcpVersion.MinimumVersionAspire_8_1) >= 0)
         {
             var startupStderrStream = await kubernetesService.GetLogStreamAsync(resource, Logs.StreamTypeStartupStdErr, follow: true, timestamps: timestamps, cancellationToken).ConfigureAwait(false);
             var startupStdoutStream = await kubernetesService.GetLogStreamAsync(resource, Logs.StreamTypeStartupStdOut, follow: true, timestamps: timestamps, cancellationToken).ConfigureAwait(false);

src/Aspire.Hosting/OtlpConfigurationExtensions.cs

@@ -2,7 +2,10 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Aspire.Hosting.ApplicationModel;
+using Aspire.Hosting.Dcp;
+using Aspire.Hosting.Dcp.Model;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
 namespace Aspire.Hosting;
@@ -27,7 +30,7 @@ public static void AddOtlpEnvironment(IResource resource, IConfiguration configu
         // Configure OpenTelemetry in projects using environment variables.
         // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md
 
-        resource.Annotations.Add(new EnvironmentCallbackAnnotation(context =>
+        resource.Annotations.Add(new EnvironmentCallbackAnnotation(async context =>
         {
             if (context.ExecutionContext.IsPublishMode)
             {
@@ -56,8 +59,18 @@ public static void AddOtlpEnvironment(IResource resource, IConfiguration configu
             }
 
             // Set the service name and instance id to the resource name and UID. Values are injected by DCP.
-            context.EnvironmentVariables["OTEL_RESOURCE_ATTRIBUTES"] = "service.instance.id={{- .Name -}}";
-            context.EnvironmentVariables["OTEL_SERVICE_NAME"] = "{{- index .Annotations \"otel-service-name\" -}}";
+            var dcpDependencyCheckService = context.ExecutionContext.ServiceProvider.GetRequiredService<IDcpDependencyCheckService>();
+            var dcpInfo = await dcpDependencyCheckService.GetDcpInfoAsync(context.CancellationToken).ConfigureAwait(false);
+            if (dcpInfo?.Version?.CompareTo(DcpVersion.MinimumVersionAspire_8_1) >= 0)
+            {
+                context.EnvironmentVariables["OTEL_RESOURCE_ATTRIBUTES"] = "service.instance.id={{- index .Annotations \"" + CustomResource.OtelServiceInstanceIdAnnotation + "\" -}}";
+            }
+            else
+            {
+                // Versions prior to Aspire 8.1 do not OTEL service instance ID annotation for replicated Executables.
+                context.EnvironmentVariables["OTEL_RESOURCE_ATTRIBUTES"] = "service.instance.id={{- .Name -}}";
+            }
+            context.EnvironmentVariables["OTEL_SERVICE_NAME"] = "{{- index .Annotations \"" + CustomResource.OtelServiceNameAnnotation + "\" -}}";
 
             if (configuration["AppHost:OtlpApiKey"] is { } otlpApiKey)
             {