Merge branch 'main' into corewcf

Kielek · web-flow · commit 50de3819c903 · 2026-01-14T06:33:15.000+01:00
diff --git a/.github/workflows/format-native.yml b/.github/workflows/format-native.yml
@@ -47,7 +47,7 @@ jobs:
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag: v6.0.1
 
       - name: Setup Go
-        uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # tag: v6.1.0
+        uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # tag: v6.2.0
         with:
           go-version: '1.23.5'
           cache: false # Suppress a warning given that there are no go.sum files in the repo
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 - Support for file-based configuration of the IL rewrite for
   SqlClient instrumentation setting
 - Add support for `StackExchange.Redis` for applications targeting .NET Framework.
+- Automatically set the `service.instance.id` resource attribute if not provided.
 - Support for [CoreWCF.Primitives](https://www.nuget.org/packages/CoreWCF.Primitives/)
   traces instrumentation for versions `1.8.0`+.
 
diff --git a/docker/debian-arm64.dockerfile b/docker/debian-arm64.dockerfile
@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:51060ced0e5dc1282a587a092783132ba8b0ec25150d3bc61e99bf0ef2d62593
+FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:ddc0e6d46a459d1c740dd9e3d2668bc50f24d420274fb751e39cbf75154b9485
 # There is no official base image for .NET SDK 10+ on Debian, so install .NET10 via dotnet-install
 
 RUN apt-get update && \
diff --git a/docker/debian.dockerfile b/docker/debian.dockerfile
@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:51060ced0e5dc1282a587a092783132ba8b0ec25150d3bc61e99bf0ef2d62593
+FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:ddc0e6d46a459d1c740dd9e3d2668bc50f24d420274fb751e39cbf75154b9485
 # There is no official base image for .NET SDK 10+ on Debian, so install .NET10 via apt-get
 
 RUN wget https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb -O packages-microsoft-prod.deb && \
diff --git a/src/OpenTelemetry.AutoInstrumentation/Configurations/ResourceConfigurator.cs b/src/OpenTelemetry.AutoInstrumentation/Configurations/ResourceConfigurator.cs
@@ -48,6 +48,12 @@ public static ResourceBuilder CreateResourceBuilder(ResourceSettings resourceSet
             resourceBuilder.AddAttributes([new(Constants.ResourceAttributes.AttributeServiceName, ServiceNameConfigurator.GetFallbackServiceName())]);
         }
 
+        if (resource.Attributes.All(kvp => kvp.Key != Constants.ResourceAttributes.AttributeServiceInstanceId))
+        {
+            // service.instance.id was not configured yet use the fallback.
+            resourceBuilder.AddAttributes([new(Constants.ResourceAttributes.AttributeServiceInstanceId, Guid.NewGuid().ToString())]);
+        }
+
         var pluginManager = Instrumentation.PluginManager;
         if (pluginManager != null)
         {
diff --git a/src/OpenTelemetry.AutoInstrumentation/Constants.cs b/src/OpenTelemetry.AutoInstrumentation/Constants.cs
@@ -27,6 +27,7 @@ public static class HttpSpanAttributes
     public static class ResourceAttributes
     {
         public const string AttributeServiceName = "service.name";
+        public const string AttributeServiceInstanceId = "service.instance.id";
     }
 
     public static class ConfigurationValues
diff --git a/test/IntegrationTests/AspNetTests.cs b/test/IntegrationTests/AspNetTests.cs
@@ -8,7 +8,7 @@
 
 namespace IntegrationTests;
 
-public class AspNetTests
+public class AspNetTests(ITestOutputHelper output)
 {
     private const string ServiceName = "TestApplication.AspNet.NetFramework";
 
@@ -22,11 +22,6 @@ public class AspNetTests
         }
     };
 
-    public AspNetTests(ITestOutputHelper output)
-    {
-        Output = output;
-    }
-
     public enum Gac
     {
         /// <summary>
@@ -53,7 +48,7 @@ public enum AppPoolMode
         Integrated
     }
 
-    private ITestOutputHelper Output { get; }
+    private ITestOutputHelper Output { get; } = output;
 
     [Theory]
     [Trait("Category", "EndToEnd")]
@@ -179,8 +174,9 @@ public async Task TracesResource()
         // on the firewall.
         using var collector = new MockSpansCollector(Output, host: "*");
         using var fwPort = FirewallHelper.OpenWinPort(collector.Port, Output);
-        collector.ResourceExpector.Expect("service.name", ServiceName); // this is set via env var in Dockerfile and Wep.config, but env var has precedence
-        collector.ResourceExpector.Expect("deployment.environment.name", "test"); // this is set via Wep.config
+        collector.ResourceExpector.Expect("service.name", ServiceName); // this is set via env var in Dockerfile and Web.config, but env var has precedence
+        collector.ResourceExpector.Expect("deployment.environment.name", "test"); // this is set via Web.config
+        collector.ResourceExpector.Matches("service.instance.id", "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"); // automatically generated
 
         var collectorUrl = $"http://{DockerNetworkHelper.IntegrationTestsGateway}:{collector.Port}";
 
diff --git a/test/IntegrationTests/Helpers/OtlpResourceExpector.cs b/test/IntegrationTests/Helpers/OtlpResourceExpector.cs
@@ -11,8 +11,8 @@ namespace IntegrationTests.Helpers;
 
 internal sealed class OtlpResourceExpector : IDisposable
 {
-    private readonly List<ResourceExpectation> _resourceExpectations = new();
-    private readonly List<string> _existenceChecks = new();
+    private readonly List<ResourceExpectation> _resourceExpectations = [];
+    private readonly List<string> _existenceChecks = [];
 
     private readonly ManualResetEvent _resourceAttributesEvent = new(false); // synchronizes access to _resourceAttributes
     private RepeatedField<KeyValue>? _resourceAttributes; // protobuf type
@@ -47,6 +47,11 @@ public void Expect(string key, long value)
         _resourceExpectations.Add(new ResourceExpectation(key, value));
     }
 
+    public void Matches(string key, string regex)
+    {
+        _resourceExpectations.Add(new ResourceExpectation(key, regex, isRegex: true));
+    }
+
     public void AssertExpectations(TimeSpan? timeout = null)
     {
         if (_resourceExpectations.Count == 0 && _existenceChecks.Count == 0)
@@ -108,12 +113,16 @@ private static void AssertResource(List<ResourceExpectation> resourceExpectation
                         continue;
                     }
 
-                    if (missingExpectations[i].StringValue != null && resourceAttribute.Value.StringValue != missingExpectations[i].StringValue)
+                    var expectation = missingExpectations[i];
+
+                    if (expectation.StringValue != null &&
+                        ((!expectation.IsRegex && resourceAttribute.Value.StringValue != expectation.StringValue) ||
+                         (expectation.IsRegex && !System.Text.RegularExpressions.Regex.IsMatch(resourceAttribute.Value.StringValue, expectation.StringValue))))
                     {
                         continue;
                     }
 
-                    if (missingExpectations[i].IntValue != null && resourceAttribute.Value.IntValue != missingExpectations[i].IntValue)
+                    if (expectation.IntValue != null && resourceAttribute.Value.IntValue != expectation.IntValue)
                     {
                         continue;
                     }
@@ -132,15 +141,17 @@ private static void AssertResource(List<ResourceExpectation> resourceExpectation
 
     private static void FailResource(List<ResourceExpectation> missingExpectations, RepeatedField<KeyValue>? attributes)
     {
-        attributes ??= new();
+        attributes ??= [];
 
         var message = new StringBuilder();
         message.AppendLine();
 
         message.AppendLine("Missing resource expectations:");
         foreach (var expectation in missingExpectations)
         {
-            var value = !string.IsNullOrEmpty(expectation.StringValue) ? expectation.StringValue : expectation.IntValue!.Value.ToString(CultureInfo.InvariantCulture);
+            var value = string.IsNullOrEmpty(expectation.StringValue)
+                ? expectation.IntValue!.Value.ToString(CultureInfo.InvariantCulture)
+                : expectation.IsRegex ? $"/{expectation.StringValue}/" : expectation.StringValue;
             message.AppendLine(CultureInfo.InvariantCulture, $"  - \"{expectation.Key}={value}\"");
         }
 
@@ -156,10 +167,11 @@ private static void FailResource(List<ResourceExpectation> missingExpectations,
 
     private sealed class ResourceExpectation
     {
-        public ResourceExpectation(string key, string stringValue)
+        public ResourceExpectation(string key, string stringValue, bool isRegex = false)
         {
             Key = key;
             StringValue = stringValue;
+            IsRegex = isRegex;
         }
 
         public ResourceExpectation(string key, long intValue)
@@ -173,5 +185,7 @@ public ResourceExpectation(string key, long intValue)
         public string? StringValue { get; }
 
         public long? IntValue { get; }
+
+        public bool IsRegex { get; }
     }
 }
diff --git a/test/IntegrationTests/Helpers/OtlpResourceExpectorExtensions.cs b/test/IntegrationTests/Helpers/OtlpResourceExpectorExtensions.cs
@@ -10,6 +10,7 @@ internal static class OtlpResourceExpectorExtensions
     public static void ExpectStandardResources(this OtlpResourceExpector resourceExpector, int processId, string serviceName)
     {
         resourceExpector.Expect("service.name", serviceName); // this is set via env var and App.config, but env var has precedence
+        resourceExpector.Matches("service.instance.id", "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$");
 #if NETFRAMEWORK
         resourceExpector.Expect("deployment.environment.name", "test"); // this is set via App.config
 #endif
diff --git a/test/IntegrationTests/docker/postgres.Dockerfile b/test/IntegrationTests/docker/postgres.Dockerfile
@@ -1 +1 @@
-FROM postgres:18.1@sha256:bfe50b2b0ddd9b55eadedd066fe24c7c6fe06626185b73358c480ea37868024d
+FROM postgres:18.1@sha256:fdd16e63f6c8ab50d422e4896b0d43d45fb72aa08bd33e4f5bda89bc4fbce98d
diff --git a/test/IntegrationTests/docker/redis.Dockerfile b/test/IntegrationTests/docker/redis.Dockerfile
@@ -1 +1 @@
-FROM redis:8.4.0@sha256:47200b04138293fae39737e50878a238b13ec0781083126b1b0c63cf5d992e8d
+FROM redis:8.4.0@sha256:350e485f00477588a01de022e00a83735f9a81a30129ace85f73808a57b4a655
diff --git a/test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/FileBased/Parser/ParserResourceTests.cs b/test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/FileBased/Parser/ParserResourceTests.cs
@@ -90,14 +90,14 @@ public void Parse_FullConfigYaml_ShouldPopulateModelCorrectly()
     public void Parse_EnvVarYaml_ShouldPopulateModelCompletely()
     {
         Environment.SetEnvironmentVariable("OTEL_SDK_DISABLED", "true");
-        Environment.SetEnvironmentVariable("OTEL_SERVICE_NAME", "my‑service");
+        Environment.SetEnvironmentVariable("OTEL_SERVICE_NAME", "my-service");
         Environment.SetEnvironmentVariable("OTEL_RESOURCE_ATTRIBUTES", "key=value");
 
         var config = YamlParser.ParseYaml<YamlConfiguration>("Configurations/FileBased/Files/TestResourceFileEnvVars.yaml");
 
         Assert.Equal("1.0-rc.1", config.FileFormat);
         var serviceAttr = config.Resource?.Attributes?.First(a => a.Name == "service.name");
         Assert.NotNull(serviceAttr);
-        Assert.Equal("my‑service", serviceAttr.Value);
+        Assert.Equal("my-service", serviceAttr.Value);
     }
 }
diff --git a/test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/ServiceNameConfiguratorTests.cs b/test/OpenTelemetry.AutoInstrumentation.Tests/Configurations/ServiceNameConfiguratorTests.cs
@@ -9,8 +9,10 @@ namespace OpenTelemetry.AutoInstrumentation.Tests.Configurations;
 [Collection("Non-Parallel Collection")]
 public class ServiceNameConfiguratorTests
 {
+    private const string ServiceInstanceId = "service.instance.id";
     private const string ServiceName = "service.name";
     private const string OtelServiceVariable = "OTEL_SERVICE_NAME";
+    private const string OtelResourceAttributeVariable = "OTEL_RESOURCE_ATTRIBUTES";
 
     [Fact]
     public void GetFallbackServiceName()
@@ -22,24 +24,30 @@ public void GetFallbackServiceName()
         Assert.Matches("testhost|ReSharperTestRunner", serviceName);
     }
 
-    [Fact]
-    public void ServiceName_Retained_EnvVarSet()
+    [Theory]
+    [InlineData(ServiceName, OtelServiceVariable, "TestApplication", "TestApplication")]
+    [InlineData(ServiceName, OtelResourceAttributeVariable, $"{ServiceName}=TestApplication", "TestApplication")]
+    [InlineData(ServiceInstanceId, OtelResourceAttributeVariable, $"{ServiceInstanceId}=c8de43ab-0121-4a4a-84ff-2177e1613304", "c8de43ab-0121-4a4a-84ff-2177e1613304")]
+    public void Environment_Variable_Not_Overwritten(
+        string attributeName,
+        string variableName,
+        string variableValue,
+        string expectedValue)
     {
-        const string setServiceName = "TestApplication";
         try
         {
-            Environment.SetEnvironmentVariable(OtelServiceVariable, setServiceName);
+            Environment.SetEnvironmentVariable(variableName, variableValue);
 
             var resourceBuilder = ResourceConfigurator.CreateResourceBuilder(new ResourceSettings());
             var resource = resourceBuilder.Build();
 
-            var serviceName = resource.Attributes.FirstOrDefault(a => a.Key == ServiceName).Value as string;
+            var actualValue = resource.Attributes.FirstOrDefault(a => a.Key == attributeName).Value as string;
 
-            Assert.Equal(setServiceName, serviceName);
+            Assert.Equal(expectedValue, actualValue);
         }
         finally
         {
-            Environment.SetEnvironmentVariable(OtelServiceVariable, null);
+            Environment.SetEnvironmentVariable(variableName, null);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:51060ced0e5dc1282a587a092783132ba8b0ec25150d3bc61e99bf0ef2d62593`
	`1`	`+FROM mcr.microsoft.com/dotnet/sdk:9.0.308-bookworm-slim@sha256:ddc0e6d46a459d1c740dd9e3d2668bc50f24d420274fb751e39cbf75154b9485`
`2`	`2`	`# There is no official base image for .NET SDK 10+ on Debian, so install .NET10 via dotnet-install`
`3`	`3`
`4`	`4`	`RUN apt-get update && \`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,12 @@ public static ResourceBuilder CreateResourceBuilder(ResourceSettings resourceSet`
`48`	`48`	`resourceBuilder.AddAttributes([new(Constants.ResourceAttributes.AttributeServiceName, ServiceNameConfigurator.GetFallbackServiceName())]);`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ if (resource.Attributes.All(kvp => kvp.Key != Constants.ResourceAttributes.AttributeServiceInstanceId))`
	`52`	`+ {`
	`53`	`+ // service.instance.id was not configured yet use the fallback.`
	`54`	`+ resourceBuilder.AddAttributes([new(Constants.ResourceAttributes.AttributeServiceInstanceId, Guid.NewGuid().ToString())]);`
	`55`	`+ }`
	`56`	`+`
`51`	`57`	`var pluginManager = Instrumentation.PluginManager;`
`52`	`58`	`if (pluginManager != null)`
`53`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ public static class HttpSpanAttributes`
`27`	`27`	`public static class ResourceAttributes`
`28`	`28`	`{`
`29`	`29`	`public const string AttributeServiceName = "service.name";`
	`30`	`+ public const string AttributeServiceInstanceId = "service.instance.id";`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`public static class ConfigurationValues`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ namespace IntegrationTests.Helpers;`
`11`	`11`
`12`	`12`	`internal sealed class OtlpResourceExpector : IDisposable`
`13`	`13`	`{`
`14`		`- private readonly List<ResourceExpectation> _resourceExpectations = new();`
`15`		`- private readonly List<string> _existenceChecks = new();`
	`14`	`+ private readonly List<ResourceExpectation> _resourceExpectations = [];`
	`15`	`+ private readonly List<string> _existenceChecks = [];`
`16`	`16`
`17`	`17`	`private readonly ManualResetEvent _resourceAttributesEvent = new(false); // synchronizes access to _resourceAttributes`
`18`	`18`	`private RepeatedField<KeyValue>? _resourceAttributes; // protobuf type`
`@@ -47,6 +47,11 @@ public void Expect(string key, long value)`
`47`	`47`	`_resourceExpectations.Add(new ResourceExpectation(key, value));`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ public void Matches(string key, string regex)`
	`51`	`+ {`
	`52`	`+ _resourceExpectations.Add(new ResourceExpectation(key, regex, isRegex: true));`
	`53`	`+ }`
	`54`	`+`
`50`	`55`	`public void AssertExpectations(TimeSpan? timeout = null)`
`51`	`56`	`{`
`52`	`57`	`if (_resourceExpectations.Count == 0 && _existenceChecks.Count == 0)`
`@@ -108,12 +113,16 @@ private static void AssertResource(List<ResourceExpectation> resourceExpectation`
`108`	`113`	`continue;`
`109`	`114`	`}`
`110`	`115`
`111`		`- if (missingExpectations[i].StringValue != null && resourceAttribute.Value.StringValue != missingExpectations[i].StringValue)`
	`116`	`+ var expectation = missingExpectations[i];`
	`117`	`+`
	`118`	`+ if (expectation.StringValue != null &&`
	`119`	`+ ((!expectation.IsRegex && resourceAttribute.Value.StringValue != expectation.StringValue) \|\|`
	`120`	`+ (expectation.IsRegex && !System.Text.RegularExpressions.Regex.IsMatch(resourceAttribute.Value.StringValue, expectation.StringValue))))`
`112`	`121`	`{`
`113`	`122`	`continue;`
`114`	`123`	`}`
`115`	`124`
`116`		`- if (missingExpectations[i].IntValue != null && resourceAttribute.Value.IntValue != missingExpectations[i].IntValue)`
	`125`	`+ if (expectation.IntValue != null && resourceAttribute.Value.IntValue != expectation.IntValue)`
`117`	`126`	`{`
`118`	`127`	`continue;`
`119`	`128`	`}`
`@@ -132,15 +141,17 @@ private static void AssertResource(List<ResourceExpectation> resourceExpectation`
`132`	`141`
`133`	`142`	`private static void FailResource(List<ResourceExpectation> missingExpectations, RepeatedField<KeyValue>? attributes)`
`134`	`143`	`{`
`135`		`- attributes ??= new();`
	`144`	`+ attributes ??= [];`
`136`	`145`
`137`	`146`	`var message = new StringBuilder();`
`138`	`147`	`message.AppendLine();`
`139`	`148`
`140`	`149`	`message.AppendLine("Missing resource expectations:");`
`141`	`150`	`foreach (var expectation in missingExpectations)`
`142`	`151`	`{`
`143`		`- var value = !string.IsNullOrEmpty(expectation.StringValue) ? expectation.StringValue : expectation.IntValue!.Value.ToString(CultureInfo.InvariantCulture);`
	`152`	`+ var value = string.IsNullOrEmpty(expectation.StringValue)`
	`153`	`+ ? expectation.IntValue!.Value.ToString(CultureInfo.InvariantCulture)`
	`154`	`+ : expectation.IsRegex ? $"/{expectation.StringValue}/" : expectation.StringValue;`
`144`	`155`	`message.AppendLine(CultureInfo.InvariantCulture, $" - \"{expectation.Key}={value}\"");`
`145`	`156`	`}`
`146`	`157`
`@@ -156,10 +167,11 @@ private static void FailResource(List<ResourceExpectation> missingExpectations,`
`156`	`167`
`157`	`168`	`private sealed class ResourceExpectation`
`158`	`169`	`{`
`159`		`- public ResourceExpectation(string key, string stringValue)`
	`170`	`+ public ResourceExpectation(string key, string stringValue, bool isRegex = false)`
`160`	`171`	`{`
`161`	`172`	`Key = key;`
`162`	`173`	`StringValue = stringValue;`
	`174`	`+ IsRegex = isRegex;`
`163`	`175`	`}`
`164`	`176`
`165`	`177`	`public ResourceExpectation(string key, long intValue)`
`@@ -173,5 +185,7 @@ public ResourceExpectation(string key, long intValue)`
`173`	`185`	`public string? StringValue { get; }`
`174`	`186`
`175`	`187`	`public long? IntValue { get; }`
	`188`	`+`
	`189`	`+ public bool IsRegex { get; }`
`176`	`190`	`}`
`177`	`191`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ internal static class OtlpResourceExpectorExtensions`
`10`	`10`	`public static void ExpectStandardResources(this OtlpResourceExpector resourceExpector, int processId, string serviceName)`
`11`	`11`	`{`
`12`	`12`	`resourceExpector.Expect("service.name", serviceName); // this is set via env var and App.config, but env var has precedence`
	`13`	`+ resourceExpector.Matches("service.instance.id", "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$");`
`13`	`14`	`#if NETFRAMEWORK`
`14`	`15`	`resourceExpector.Expect("deployment.environment.name", "test"); // this is set via App.config`
`15`	`16`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-FROM postgres:18.1@sha256:bfe50b2b0ddd9b55eadedd066fe24c7c6fe06626185b73358c480ea37868024d`
	`1`	`+FROM postgres:18.1@sha256:fdd16e63f6c8ab50d422e4896b0d43d45fb72aa08bd33e4f5bda89bc4fbce98d`