[Instrumentation.GrpNetClient, Instrumentation.SqlCliet] set ActivitySource.Version to NuGet package version (#5498)

Co-authored-by: Vishwesh Bankwar <[email protected]>

Author: Kielek

OpenTelemetry.sln

@@ -262,6 +262,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Shared", "Shared", "{A49299
 	ProjectSection(SolutionItems) = preProject
 		src\Shared\ActivityHelperExtensions.cs = src\Shared\ActivityHelperExtensions.cs
 		src\Shared\ActivityInstrumentationHelper.cs = src\Shared\ActivityInstrumentationHelper.cs
+		src\Shared\AssemblyVersionExtensions.cs = src\Shared\AssemblyVersionExtensions.cs
 		src\Shared\DiagnosticDefinitions.cs = src\Shared\DiagnosticDefinitions.cs
 		src\Shared\ExceptionExtensions.cs = src\Shared\ExceptionExtensions.cs
 		src\Shared\Guard.cs = src\Shared\Guard.cs
@@ -305,7 +306,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Shims", "Shims", "{A0CB9A10
 	ProjectSection(SolutionItems) = preProject
 		src\Shared\Shims\IsExternalInit.cs = src\Shared\Shims\IsExternalInit.cs
 		src\Shared\Shims\NullableAttributes.cs = src\Shared\Shims\NullableAttributes.cs
-		src\Shared\Shims\UnconditionalSuppressMessageAttribute.cs = src\Shared\Shims\UnconditionalSuppressMessageAttribute.cs
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Api.Tests", "test\OpenTelemetry.Api.Tests\OpenTelemetry.Api.Tests.csproj", "{777C04B8-1BD5-43D7-B3CD-D2189DFABCF3}"

src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* `ActivitySource.Version` is set to NuGet package version.
+  ([#5498](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5498))
+
 ## 1.8.0-beta.1
 
 Released 2024-Apr-04

src/OpenTelemetry.Instrumentation.GrpcNetClient/Implementation/GrpcClientDiagnosticListener.cs

@@ -14,10 +14,11 @@ namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
 
 internal sealed class GrpcClientDiagnosticListener : ListenerHandler
 {
-    internal static readonly AssemblyName AssemblyName = typeof(GrpcClientDiagnosticListener).Assembly.GetName();
+    internal static readonly Assembly Assembly = typeof(GrpcClientDiagnosticListener).Assembly;
+    internal static readonly AssemblyName AssemblyName = Assembly.GetName();
     internal static readonly string ActivitySourceName = AssemblyName.Name;
-    internal static readonly Version Version = AssemblyName.Version;
-    internal static readonly ActivitySource ActivitySource = new(ActivitySourceName, Version.ToString());
+    internal static readonly string Version = Assembly.GetPackageVersion();
+    internal static readonly ActivitySource ActivitySource = new(ActivitySourceName, Version);
 
     private const string OnStartEvent = "Grpc.Net.Client.GrpcOut.Start";
     private const string OnStopEvent = "Grpc.Net.Client.GrpcOut.Stop";

src/OpenTelemetry.Instrumentation.GrpcNetClient/OpenTelemetry.Instrumentation.GrpcNetClient.csproj

@@ -14,6 +14,7 @@
   <ItemGroup>
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.Http\HttpRequestMessageContextPropagation.cs" Link="Includes\HttpRequestMessageContextPropagation.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" />
+    <Compile Include="$(RepoRoot)\src\Shared\AssemblyVersionExtensions.cs" Link="Includes\AssemblyVersionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Options\*.cs" Link="Includes\Options\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Shims\NullableAttributes.cs" Link="Includes\Shims\NullableAttributes.cs" />
   </ItemGroup>

src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* `ActivitySource.Version` is set to NuGet package version.
+  ([#5498](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5498))
+
 ## 1.8.0-beta.1
 
 Released 2024-Apr-04

src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlActivitySourceHelper.cs

@@ -15,10 +15,10 @@ internal sealed class SqlActivitySourceHelper
 {
     public const string MicrosoftSqlServerDatabaseSystemName = "mssql";
 
-    public static readonly AssemblyName AssemblyName = typeof(SqlActivitySourceHelper).Assembly.GetName();
+    public static readonly Assembly Assembly = typeof(SqlActivitySourceHelper).Assembly;
+    public static readonly AssemblyName AssemblyName = Assembly.GetName();
     public static readonly string ActivitySourceName = AssemblyName.Name;
-    public static readonly Version Version = AssemblyName.Version;
-    public static readonly ActivitySource ActivitySource = new(ActivitySourceName, Version.ToString());
+    public static readonly ActivitySource ActivitySource = new(ActivitySourceName, Assembly.GetPackageVersion());
     public static readonly string ActivityName = ActivitySourceName + ".Execute";
 
     public static readonly IEnumerable<KeyValuePair<string, object>> CreationTags = new[]

src/OpenTelemetry.Instrumentation.SqlClient/OpenTelemetry.Instrumentation.SqlClient.csproj

@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" />
+    <Compile Include="$(RepoRoot)\src\Shared\AssemblyVersionExtensions.cs" Link="Includes\AssemblyVersionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Shims\NullableAttributes.cs" Link="Includes\Shims\NullableAttributes.cs" />
   </ItemGroup>
 

src/OpenTelemetry/OpenTelemetry.csproj

@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <Compile Include="$(RepoRoot)\src\Shared\AssemblyVersionExtensions.cs" Link="Includes\AssemblyVersionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Configuration\*.cs" Link="Includes\Configuration\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\EnvironmentVariables\*.cs" Link="Includes\EnvironmentVariables\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\MathHelper.cs" Link="Includes\MathHelper.cs" />

src/OpenTelemetry/Sdk.cs

@@ -5,8 +5,8 @@
 #if EXPOSE_EXPERIMENTAL_FEATURES && NET8_0_OR_GREATER
 using System.Diagnostics.CodeAnalysis;
 #endif
-using System.Reflection;
 using OpenTelemetry.Context.Propagation;
+using OpenTelemetry.Instrumentation;
 using OpenTelemetry.Internal;
 using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
@@ -31,8 +31,8 @@ static Sdk()
         Activity.ForceDefaultIdFormat = true;
         SelfDiagnostics.EnsureInitialized();
 
-        var assemblyInformationalVersion = typeof(Sdk).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
-        InformationalVersion = ParseAssemblyInformationalVersion(assemblyInformationalVersion);
+        var sdkAssembly = typeof(Sdk).Assembly;
+        InformationalVersion = sdkAssembly.GetPackageVersion();
     }
 
     /// <summary>
@@ -110,24 +110,4 @@ static LoggerProviderBuilder CreateLoggerProviderBuilder()
     {
         return new LoggerProviderBuilderBase();
     }
-
-    internal static string ParseAssemblyInformationalVersion(string? informationalVersion)
-    {
-        if (string.IsNullOrWhiteSpace(informationalVersion))
-        {
-            informationalVersion = "1.0.0";
-        }
-
-        /*
-         * InformationalVersion will be in the following format:
-         *   {majorVersion}.{minorVersion}.{patchVersion}.{pre-release label}.{pre-release version}.{gitHeight}+{Git SHA of current commit}
-         * Ex: 1.5.0-alpha.1.40+807f703e1b4d9874a92bd86d9f2d4ebe5b5d52e4
-         * The following parts are optional: pre-release label, pre-release version, git height, Git SHA of current commit
-         */
-
-        var indexOfPlusSign = informationalVersion!.IndexOf('+');
-        return indexOfPlusSign > 0
-            ? informationalVersion.Substring(0, indexOfPlusSign)
-            : informationalVersion;
-    }
 }

src/Shared/AssemblyVersionExtensions.cs

@@ -0,0 +1,28 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#nullable enable
+
+using System.Reflection;
+
+namespace OpenTelemetry.Instrumentation;
+
+internal static class AssemblyVersionExtensions
+{
+    public static string GetPackageVersion(this Assembly assembly)
+    {
+        // MinVer https://github.com/adamralph/minver?tab=readme-ov-file#version-numbers
+        // together with Microsoft.SourceLink.GitHub https://github.com/dotnet/sourcelink
+        // fills AssemblyInformationalVersionAttribute by
+        // {majorVersion}.{minorVersion}.{patchVersion}.{pre-release label}.{pre-release version}.{gitHeight}+{Git SHA of current commit}
+        // Ex: 1.5.0-alpha.1.40+807f703e1b4d9874a92bd86d9f2d4ebe5b5d52e4
+        // The following parts are optional: pre-release label, pre-release version, git height, Git SHA of current commit
+        // For package version, value of AssemblyInformationalVersionAttribute without commit hash is returned.
+
+        var informationalVersion = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()!.InformationalVersion;
+        var indexOfPlusSign = informationalVersion!.IndexOf('+');
+        return indexOfPlusSign > 0
+            ? informationalVersion.Substring(0, indexOfPlusSign)
+            : informationalVersion;
+    }
+}

test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs

@@ -435,7 +435,7 @@ public void Grpc_BadArgs()
     private static void ValidateGrpcActivity(Activity activityToValidate)
     {
         Assert.Equal(GrpcClientDiagnosticListener.ActivitySourceName, activityToValidate.Source.Name);
-        Assert.Equal(GrpcClientDiagnosticListener.Version.ToString(), activityToValidate.Source.Version);
+        Assert.Equal(GrpcClientDiagnosticListener.Version, activityToValidate.Source.Version);
         Assert.Equal(ActivityKind.Client, activityToValidate.Kind);
     }
 }

test/OpenTelemetry.Tests/SdkTests.cs renamed to test/OpenTelemetry.Tests/Shared/AssemblyVersionExtensionsTests.cs

@@ -3,14 +3,15 @@
 
 #nullable enable
 
+using System.Reflection;
+using OpenTelemetry.Instrumentation;
 using Xunit;
 
 namespace OpenTelemetry.Tests;
 
-public class SdkTests
+public class AssemblyVersionExtensionsTests
 {
     [Theory]
-    [InlineData(null, "1.0.0")]
     [InlineData("1.5.0", "1.5.0")]
     [InlineData("1.0.0.0", "1.0.0.0")]
     [InlineData("1.0-beta.1", "1.0-beta.1")]
@@ -19,10 +20,19 @@ public class SdkTests
     [InlineData("8.0", "8.0")]
     [InlineData("8", "8")]
     [InlineData("8.0.1.18-alpha1", "8.0.1.18-alpha1")]
-    public void ParseAssemblyInformationalVersionTests(string? informationalVersion, string expectedVersion)
+    public void ParseAssemblyInformationalVersionTests(string informationalVersion, string expectedVersion)
     {
-        var actualVersion = Sdk.ParseAssemblyInformationalVersion(informationalVersion);
+        var assembly = new TestAssembly(informationalVersion);
+        var actualVersion = assembly.GetPackageVersion();
 
         Assert.Equal(expectedVersion, actualVersion);
     }
+
+    private class TestAssembly(string informationalVersion) : Assembly
+    {
+        public override object[] GetCustomAttributes(Type attributeType, bool inherit)
+        {
+            return new Attribute[] { new AssemblyInformationalVersionAttribute(informationalVersion) };
+        }
+    }
 }