Bump OTel .NET Auto to 1.12.0 (#643)

* Bump OTel .NET Auto to 1.12.0

* Document OTEL_DOTNET_EXPERIMENTAL_SQLCLIENT_ENABLE_TRACE_CONTEXT_PROPAGATION

* adjust logging to upstream logging changes

---------

Co-authored-by: Mateusz Lach <mateusza@splunk.com>

Author: Kielek

CHANGELOG.md

@@ -11,6 +11,9 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 ### Changed
 
+- Updated [OpenTelemetry .NET Auto Instrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation):
+  [`1.12.0`](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.12.0).
+
 ### Deprecated
 
 ### Removed

README.md

@@ -1,7 +1,7 @@
 # Splunk Distribution of OpenTelemetry .NET
 
-[![OpenTelemetry .NET](https://img.shields.io/badge/OTel-1.11.2-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.11.2)
-[![OpenTelemetry .NET Auto Instrumentation](https://img.shields.io/badge/OTelAuto-v1.11.0-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.11.0)
+[![OpenTelemetry .NET](https://img.shields.io/badge/OTel-1.12.0-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.12.0)
+[![OpenTelemetry .NET Auto Instrumentation](https://img.shields.io/badge/OTelAuto-v1.12.0-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.12.0)
 [![Splunk GDI Specification](https://img.shields.io/badge/GDI-1.7.0-blueviolet)](https://github.com/signalfx/gdi-specification/releases/tag/v1.7.0)
 [![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md)
 [![LICENSE](https://img.shields.io/github/license/signalfx/splunk-otel-dotnet)](LICENSE)

build/Build.cs

@@ -16,7 +16,7 @@ partial class Build : NukeBuild
     [Parameter("Configuration to build - Default is 'Release'")]
     readonly Configuration Configuration = Configuration.Release;
 
-    const string OpenTelemetryAutoInstrumentationDefaultVersion = "v1.11.0";
+    const string OpenTelemetryAutoInstrumentationDefaultVersion = "v1.12.0";
 
     [Parameter($"OpenTelemetry AutoInstrumentation dependency version - Default is '{OpenTelemetryAutoInstrumentationDefaultVersion}'")]
     readonly string OpenTelemetryAutoInstrumentationVersion = OpenTelemetryAutoInstrumentationDefaultVersion;

docs/advanced-config.md

@@ -7,7 +7,7 @@
 
 ## OpenTelemetry configuration
 
-See [Open Telemetry Auto Instrumentation documentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.11.0/docs/config.md)
+See [Open Telemetry Auto Instrumentation documentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.12.0/docs/config.md)
 for configuration details.
 
 ## Splunk distribution configuration
@@ -23,7 +23,7 @@ Download and install the latest binaries from
 
 When running your application, make sure to:
 
-1. Set the [resources](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.11.0/docs/config.md#resources).
+1. Set the [resources](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.12.0/docs/config.md#resources).
 1. Set the environment variables from the table below.
 
 | Environment variable                 | .NET version        | Value                                                                                       |
@@ -45,7 +45,7 @@ When running your application, make sure to:
 | `OTEL_DOTNET_AUTO_HOME`              | All versions        | `$INSTALL_DIR`                                                                              |
 | `OTEL_DOTNET_AUTO_PLUGINS`           | All versions        | `Splunk.OpenTelemetry.AutoInstrumentation.Plugin, Splunk.OpenTelemetry.AutoInstrumentation` |
 
-> Some settings can be omitted on .NET. For more information, see the [documentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.11.0/docs/config.md#net-clr-profiler).
+> Some settings can be omitted on .NET. For more information, see the [documentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.12.0/docs/config.md#net-clr-profiler).
 
 ### Splunk plugin settings
 

script-templates/Splunk.OTel.DotNet.psm1.template

@@ -324,6 +324,36 @@ function Is-Greater-Version($v1, $v2) {
     return $false;
 }
 
+<#
+    .SYNOPSIS
+    Installs OpenTelemetry .NET Assemblies in GAC.
+    .PARAMETER InstallDir
+    Default: <auto> - the default path is Program Files dir.
+    Install path of the OpenTelemetry .NET Automatic Instrumentation
+    Possible values: <auto>, (Custom path)
+#>
+function Register-AssembliesInGAC() {
+    $installDir = Get-Current-InstallDir
+
+    # Register .NET Framework dlls in GAC
+    [System.Reflection.Assembly]::Load("System.EnterpriseServices, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a") | Out-Null
+    $publish = New-Object System.EnterpriseServices.Internal.Publish 
+    $dlls = Get-ChildItem -Path $installDir\netfx\ -Filter *.dll -File
+    for ($i = 0; $i -lt $dlls.Count; $i++) {
+        $percentageComplete = $i / $dlls.Count * 100
+        Write-Progress -Activity "Registering .NET Framework dlls in GAC" `
+            -Status "Module $($i+1) out of $($dlls.Count). Installing $($dlls[$i].Name):" `
+            -PercentComplete $percentageComplete
+
+        if (Test-AssemblyNotForGAC $dlls[$i].Name) {
+            continue
+        }
+
+        $publish.GacInstall($dlls[$i].FullName)
+    }
+    Write-Progress -Activity "Registering .NET Framework dlls in GAC" -Status "Ready" -Completed
+}
+
 <#
     .SYNOPSIS
     Installs Splunk Distribution of OpenTelemetry .NET.
@@ -337,7 +367,9 @@ function Install-OpenTelemetryCore() {
         [Parameter(Mandatory = $false)]
         [string]$InstallDir = "<auto>",
         [Parameter(Mandatory = $false)]
-        [string]$LocalPath
+        [string]$LocalPath,
+        [Parameter(Mandatory = $false)]
+        [bool]$RegisterAssembliesInGAC = $true
     )
 
     $version = "v{{VERSION}}"
@@ -361,23 +393,9 @@ function Install-OpenTelemetryCore() {
         # OpenTelemetry service locator
         [System.Environment]::SetEnvironmentVariable($ServiceLocatorVariable, $installDir, [System.EnvironmentVariableTarget]::Machine)
 
-        # Register .NET Framework dlls in GAC
-        [System.Reflection.Assembly]::Load("System.EnterpriseServices, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a") | Out-Null
-        $publish = New-Object System.EnterpriseServices.Internal.Publish 
-        $dlls = Get-ChildItem -Path $installDir\netfx\ -Filter *.dll -File
-        for ($i = 0; $i -lt $dlls.Count; $i++) {
-            $percentageComplete = $i / $dlls.Count * 100
-            Write-Progress -Activity "Registering .NET Framework dlls in GAC" `
-                -Status "Module $($i+1) out of $($dlls.Count). Installing $($dlls[$i].Name):" `
-                -PercentComplete $percentageComplete
-
-            if (Test-AssemblyNotForGAC $dlls[$i].Name) {
-                continue
-            }
-
-            $publish.GacInstall($dlls[$i].FullName)
+        if ($RegisterAssembliesInGAC){
+            Register-AssembliesInGAC $installDir
         }
-        Write-Progress -Activity "Registering .NET Framework dlls in GAC" -Status "Ready" -Completed
     } 
     catch {
         $message = $_
@@ -435,7 +453,9 @@ function Uninstall-OpenTelemetryCore() {
 function Update-OpenTelemetryCore() {
     param(
         [Parameter(Mandatory = $false)]
-        [bool]$RegisterIIS = $false
+        [bool]$RegisterIIS = $false,
+        [Parameter(Mandatory = $false)]
+        [bool]$RegisterAssembliesInGAC = $true
     )
 
     $currentInstallVersion = Get-OpenTelemetryInstallVersion
@@ -465,7 +485,7 @@ function Update-OpenTelemetryCore() {
     Remove-Module Splunk.OTel.DotNet
     Import-Module $modulePath
 
-    Install-OpenTelemetryCore -InstallDir $installDir
+    Install-OpenTelemetryCore -InstallDir $installDir -RegisterAssembliesInGAC $$RegisterAssembliesInGAC
     if ($RegisterIIS) {
         Register-OpenTelemetryForIIS
     }
@@ -695,3 +715,4 @@ Export-ModuleMember -Function Get-OpenTelemetryInstallVersion
 Export-ModuleMember -Function Get-SplunkOpenTelemetryForDotNetVersion
 Export-ModuleMember -Function Enable-OpenTelemetryForIISAppPool
 Export-ModuleMember -Function Disable-OpenTelemetryForIISAppPool
+Export-ModuleMember -Function Register-AssembliesInGAC

script-templates/splunk-otel-dotnet-install.sh.template

@@ -46,6 +46,15 @@ case "$ARCHITECTURE" in
     ;;
 esac
 
+if command -v curl > /dev/null 2>&1; then
+  DOWNLOADER="curl -sSfLo"
+elif command -v wget > /dev/null 2>&1; then
+  DOWNLOADER="wget -qO"
+else
+  echo "Error: Neither curl nor wget is available." >&2
+  exit 1
+fi
+
 test -z "$OTEL_DOTNET_AUTO_HOME" && OTEL_DOTNET_AUTO_HOME="$HOME/.splunk-otel-dotnet"
 test -z "$VERSION" && VERSION="v{{VERSION}}"
 
@@ -64,7 +73,7 @@ if [ ! -f "${LOCAL_PATH}" ]; then
   (
     cd "$DOWNLOAD_DIR"
     echo "Downloading $VERSION for $OS_TYPE ($LOCAL_PATH)..."
-    curl -sSfLo "$LOCAL_PATH" "$RELEASES_URL/download/$VERSION/$ARCHIVE"
+    ${DOWNLOADER} "$LOCAL_PATH" "$RELEASES_URL/download/$VERSION/$ARCHIVE"
   )
 else
   echo "Using local installation archive: $LOCAL_PATH"

src/Splunk.OpenTelemetry.AutoInstrumentation/Logging/Logger.cs

@@ -20,6 +20,7 @@ namespace Splunk.OpenTelemetry.AutoInstrumentation.Logging;
 
 internal class Logger : ILogger
 {
+    private const string SplunkLoggerSuffix = "Splunk";
     private static readonly bool IsDebugEnabledField;
     private static readonly object? Log;
     private static readonly MethodInfo? DebugMethod;
@@ -36,8 +37,9 @@ static Logger()
             System.Runtime.CompilerServices.RuntimeHelpers.RunClassConstructor(oTelLoggingType.TypeHandle);
 
             var method = oTelLoggingType.GetMethod("GetLogger", [typeof(string)])!;
+            var closeLoggerMethod = oTelLoggingType.GetMethod("CloseLogger", [typeof(string), Type.GetType("OpenTelemetry.AutoInstrumentation.Logging.IOtelLogger, OpenTelemetry.AutoInstrumentation")!])!;
 
-            Log = method.Invoke(null, ["Splunk"])!;
+            Log = method.Invoke(null, [SplunkLoggerSuffix])!;
 
             DebugMethod = GetMethod("Debug");
             WarningMethod = GetMethod("Warning");
@@ -49,6 +51,8 @@ static Logger()
             var isLogLevelEnabled = Log?.GetType().GetMethod("IsEnabled");
             var isDebugEnabledResult = isLogLevelEnabled?.Invoke(Log, [debugLevel]);
             IsDebugEnabledField = isDebugEnabledResult is true;
+
+            AppDomain.CurrentDomain.ProcessExit += (_, _) => closeLoggerMethod.Invoke(null, [SplunkLoggerSuffix, Log]);
         }
         catch (Exception ex)
         {

src/Splunk.OpenTelemetry.AutoInstrumentation/Splunk.OpenTelemetry.AutoInstrumentation.csproj

@@ -20,18 +20,18 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OpenTelemetry.Api" Version="1.11.2" />
-    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.2" />
+    <PackageReference Include="OpenTelemetry.Api" Version="1.12.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.12.0" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net462' ">
     <Reference Include="System.Configuration" />
     <Reference Include="System.Web" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNet" Version="1.11.0-beta.2" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNet" Version="1.12.0-beta.1" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net8.0' ">
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.1" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.12.0" />
   </ItemGroup>
 
   <PropertyGroup>
@@ -62,7 +62,7 @@
     <Content Include="splunk-launch.*">
       <PackageCopyToOutput>true</PackageCopyToOutput>
     </Content>
-    <PackageReference Include="OpenTelemetry.AutoInstrumentation" Version="1.11.0">
+    <PackageReference Include="OpenTelemetry.AutoInstrumentation" Version="1.12.0">
       <PrivateAssets>none</PrivateAssets> <!-- Ensures that content and build transitive dependencies are properly delivered -->
     </PackageReference>
     <None Include="splunk-logo-256x256.png" Pack="true" PackagePath="images" />

test/Splunk.OpenTelemetry.AutoInstrumentation.IntegrationTests/BuildTests.DistributionStructure_windows.verified.txt

@@ -44,8 +44,6 @@
   \net\System.ServiceModel.Primitives.dll,
   \net\System.ServiceModel.dll,
   \net\ruleEngine.json,
-  \netfx\Grpc.Core.Api.dll,
-  \netfx\Grpc.Core.dll,
   \netfx\Microsoft.Bcl.AsyncInterfaces.dll,
   \netfx\Microsoft.Extensions.Configuration.Abstractions.dll,
   \netfx\Microsoft.Extensions.Configuration.Binder.dll,
@@ -190,10 +188,6 @@
   \netfx\System.Xml.XPath.dll,
   \netfx\System.Xml.XmlDocument.dll,
   \netfx\System.Xml.XmlSerializer.dll,
-  \netfx\grpc_csharp_ext.x64.dll,
-  \netfx\grpc_csharp_ext.x86.dll,
-  \netfx\libgrpc_csharp_ext.x64.dylib,
-  \netfx\libgrpc_csharp_ext.x64.so,
   \netfx\netstandard.dll,
   \store\x64\net8.0\microsoft.extensions.configuration.abstractions\9.0.0\lib\net9.0\Microsoft.Extensions.Configuration.Abstractions.dll,
   \store\x64\net8.0\microsoft.extensions.configuration.binder\9.0.0\lib\net9.0\Microsoft.Extensions.Configuration.Binder.dll,
@@ -243,4 +237,4 @@
   \store\x86\net9.0\microsoft.extensions.primitives\9.0.0\lib\net9.0\Microsoft.Extensions.Primitives.dll,
   \win-x64\OpenTelemetry.AutoInstrumentation.Native.dll,
   \win-x86\OpenTelemetry.AutoInstrumentation.Native.dll
-]
+]