[Api] support for adding default tags to tracer

src/OpenTelemetry.Api/.publicApi/Stable/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+OpenTelemetry.Trace.TracerProvider.GetTracer(string! name, string? version = null, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string!, object?>>? tags = null) -> OpenTelemetry.Trace.Tracer!
+OpenTelemetry.Trace.TracerProvider.GetTracer(string! name, string? version) -> OpenTelemetry.Trace.Tracer!
+*REMOVED*OpenTelemetry.Trace.TracerProvider.GetTracer(string! name, string? version = null) -> OpenTelemetry.Trace.Tracer!
+

src/OpenTelemetry.Api/Trace/TracerProvider.cs

@@ -33,12 +33,29 @@ protected TracerProvider()
     /// <param name="name">Name identifying the instrumentation library.</param>
     /// <param name="version">Version of the instrumentation library.</param>
     /// <returns>Tracer instance.</returns>
+    // 1.11.1 BACKCOMPAT OVERLOAD -- DO NOT TOUCH
     public Tracer GetTracer(
 #if NET
         [AllowNull]
 #endif
         string name,
-        string? version = null)
+        string? version) =>
+        this.GetTracer(name, version, null);
+
+    /// <summary>
+    /// Gets a tracer with given name, version and tags.
+    /// </summary>
+    /// <param name="name">Name identifying the instrumentation library.</param>
+    /// <param name="version">Version of the instrumentation library.</param>
+    /// <param name="tags">Tags associated with the tracer.</param>
+    /// <returns>Tracer instance.</returns>
+    public Tracer GetTracer(
+#if NET
+        [AllowNull]
+#endif
+        string name,
+        string? version = null,
+        IEnumerable<KeyValuePair<string, object?>>? tags = null)
     {
         var tracers = this.Tracers;
         if (tracers == null)
@@ -47,7 +64,7 @@ public Tracer GetTracer(
             return new(activitySource: null);
         }
 
-        var key = new TracerKey(name, version);
+        var key = new TracerKey(name, version, tags);
 
         if (!tracers.TryGetValue(key, out var tracer))
         {
@@ -60,12 +77,10 @@ public Tracer GetTracer(
                     return new(activitySource: null);
                 }
 
-                tracer = new(new(key.Name, key.Version));
-#if DEBUG
+                tracer = new(new(key.Name, key.Version, key.Tags));
                 bool result = tracers.TryAdd(key, tracer);
+#if DEBUG
                 System.Diagnostics.Debug.Assert(result, "Write into tracers cache failed");
-#else
-                tracers.TryAdd(key, tracer);
 #endif
             }
         }
@@ -103,11 +118,94 @@ internal readonly record struct TracerKey
     {
         public readonly string Name;
         public readonly string? Version;
+        public readonly KeyValuePair<string, object?>[]? Tags;
 
-        public TracerKey(string? name, string? version)
+        public TracerKey(string? name, string? version, IEnumerable<KeyValuePair<string, object?>>? tags)
         {
             this.Name = name ?? string.Empty;
             this.Version = version;
+            this.Tags = this.GetOrderedTags(tags);
+        }
+
+        public bool Equals(TracerKey other)
+        {
+            if (!string.Equals(this.Name, other.Name, StringComparison.Ordinal))
+            {
+                return false;
+            }
+
+            if (!string.Equals(this.Version, other.Version, StringComparison.Ordinal))
+            {
+                return false;
+            }
+
+            return AreTagsEqual(this.Tags, other.Tags);
+        }
+
+        public override int GetHashCode()
+        {
+            unchecked
+            {
+                var hash = 17;
+                hash = (hash * 31) + (this.Name?.GetHashCode() ?? 0);
+                hash = (hash * 31) + (this.Version?.GetHashCode() ?? 0);
+                hash = (hash * 31) + GetTagsHashCode(this.Tags);
+                return hash;
+            }
+        }
+
+        private static bool AreTagsEqual(
+            IEnumerable<KeyValuePair<string, object?>>? tags1,
+            IEnumerable<KeyValuePair<string, object?>>? tags2)
+        {
+            if (tags1 is null && tags2 is null)
+            {
+                return true;
+            }
+
+            if (tags1 is null || tags2 is null)
+            {
+                return false;
+            }
+
+            return tags1.SequenceEqual(tags2);
+        }
+
+        private static int GetTagsHashCode(
+            IEnumerable<KeyValuePair<string, object?>>? tags)
+        {
+            if (tags is null)
+            {
+                return 0;
+            }
+
+            var hash = 0;
+            unchecked
+            {
+                foreach (var kvp in tags)
+                {
+                    hash = (hash * 31) + kvp.Key.GetHashCode();
+                    if (kvp.Value != null)
+                    {
+                        hash = (hash * 31) + kvp.Value.GetHashCode()!;
+                    }
+                }
+            }
+
+            return hash;
+        }
+
+        private KeyValuePair<string, object?>[]? GetOrderedTags(
+            IEnumerable<KeyValuePair<string, object?>>? tags)
+        {
+            if (tags is null)
+            {
+                return null;
+            }
+
+            var orderedTagList = new List<KeyValuePair<string, object?>>(tags);
+            orderedTagList.Sort((left, right) => string.Compare(left.Key, right.Key, StringComparison.Ordinal));
+            return orderedTagList.ToArray();
         }
     }
 }

test/OpenTelemetry.Api.Tests/Trace/TracerTest.cs

@@ -303,8 +303,8 @@ public void TracerBecomesNoopWhenParentProviderIsDisposedTest()
         Tracer? tracer1;
 
         using (var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddSource("mytracer")
-            .Build())
+                   .AddSource("mytracer")
+                   .Build())
         {
             provider = tracerProvider;
             tracer1 = tracerProvider.GetTracer("mytracer");
@@ -408,6 +408,81 @@ static void InnerTest()
         }
     }
 
+    [Fact]
+    public void GetTracer_WithTags_ReturnsSameInstanceForSameTags()
+    {
+        var tags1 = new List<KeyValuePair<string, object?>> { new("tag1", "value1"), new("tag2", "value2") };
+        var tags2 = new List<KeyValuePair<string, object?>> { new("tag1", "value1"), new("tag2", "value2") };
+
+        using var tracerProvider = new TestTracerProvider();
+        var tracer1 = tracerProvider.GetTracer("test", "1.0.0", tags1);
+        var tracer2 = tracerProvider.GetTracer("test", "1.0.0", tags2);
+
+        Assert.Same(tracer1, tracer2);
+    }
+
+    [Fact]
+    public void GetTracer_WithTags_ReturnsDifferentInstancesForDifferentTags()
+    {
+        var tags1 = new List<KeyValuePair<string, object?>> { new("tag1", "value1") };
+        var tags2 = new List<KeyValuePair<string, object?>> { new("tag2", "value2") };
+
+        using var tracerProvider = new TestTracerProvider();
+        var tracer1 = tracerProvider.GetTracer("test", "1.0.0", tags1);
+        var tracer2 = tracerProvider.GetTracer("test", "1.0.0", tags2);
+
+        Assert.NotSame(tracer1, tracer2);
+    }
+
+    [Fact]
+    public void GetTracer_WithTags_OrdersTagsByKey()
+    {
+        var tags1 = new List<KeyValuePair<string, object?>> { new("tag2", "value2"), new("tag1", "value1"), };
+        var tags2 = new List<KeyValuePair<string, object?>> { new("tag1", "value1"), new("tag2", "value2"), };
+
+        using var tracerProvider = new TestTracerProvider();
+        var tracer1 = tracerProvider.GetTracer("test", "1.0.0", tags1);
+        var tracer2 = tracerProvider.GetTracer("test", "1.0.0", tags2);
+
+        Assert.Same(tracer1, tracer2);
+    }
+
+    [Fact]
+    public void GetTracer_WithTagsAndWithoutTags_ReturnsDifferentInstances()
+    {
+        var tags = new List<KeyValuePair<string, object?>> { new("tag1", "value1") };
+
+        using var tracerProvider = new TestTracerProvider();
+        var tracerWithTags = tracerProvider.GetTracer("test", "1.0.0", tags);
+        var tracerWithoutTags = tracerProvider.GetTracer("test", "1.0.0");
+
+        Assert.NotEqual(tracerWithTags, tracerWithoutTags);
+    }
+
+    [Fact]
+    public void GetTracer_WithTags_AppliesTagsToActivities()
+    {
+        var exportedItems = new List<Activity>();
+        var tags = new List<KeyValuePair<string, object?>> { new("tracerTag", "tracerValue") };
+
+        using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+            .AddSource("test")
+            .AddInMemoryExporter(exportedItems)
+            .SetSampler(new AlwaysOnSampler())
+            .Build();
+
+        var tracer = tracerProvider.GetTracer("test", "1.0.0", tags);
+
+        using (var span = tracer.StartActiveSpan("TestSpan"))
+        {
+            // Activity started by the tracer with tags
+        }
+
+        var activity = Assert.Single(exportedItems);
+
+        Assert.Contains(activity.Source.Tags!, kvp => kvp.Key == "tracerTag" && (string)kvp.Value! == "tracerValue");
+    }
+
     public void Dispose()
     {
         Activity.Current = null;