Fixes and refactoring for autoinstrumentation (#232)

Moves common code into `Elastic.OpenTelemetry.Core`. This project is not
packaged, but the code is "compile included" into
`Elastic.OpenTelemetry` and `Elastic.OpenTelemetry.AutoInstrumentation`.
This allows `Elastic.OpenTelemetry.AutoInstrumentation` to contain the
plugin and, with reduced dependencies, avoid any GAC issues.

Also, refactors the `FileLogger` to remove the dependency on
`System.Threading.Channels`, which presented issues when used for auto
instrumentation.

Author: stevejgordon

Elastic.OpenTelemetry.sln

@@ -1,4 +1,3 @@
-
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.9.34321.82
@@ -62,6 +61,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApi", "test-applications
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApiDotNet8", "test-applications\WebApiDotNet8\WebApiDotNet8\WebApiDotNet8.csproj", "{C8C543F8-5C7A-4748-A3E8-658D79E3FDC1}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.OpenTelemetry.Core", "src\Elastic.OpenTelemetry.Core\Elastic.OpenTelemetry.Core.csproj", "{C5E2CD91-3BD4-4CB8-9F82-52D600003537}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -140,6 +141,10 @@ Global
 		{C8C543F8-5C7A-4748-A3E8-658D79E3FDC1}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C8C543F8-5C7A-4748-A3E8-658D79E3FDC1}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C8C543F8-5C7A-4748-A3E8-658D79E3FDC1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C5E2CD91-3BD4-4CB8-9F82-52D600003537}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C5E2CD91-3BD4-4CB8-9F82-52D600003537}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C5E2CD91-3BD4-4CB8-9F82-52D600003537}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C5E2CD91-3BD4-4CB8-9F82-52D600003537}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -162,6 +167,7 @@ Global
 		{02EA681E-C7D8-13C7-8484-4AC65E1B71E8} = {AAD39891-0B70-47FA-A212-43E1AAE5DF56}
 		{2A1F61D6-EE54-4ECE-9814-A2BF34957415} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
 		{C8C543F8-5C7A-4748-A3E8-658D79E3FDC1} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
+		{C5E2CD91-3BD4-4CB8-9F82-52D600003537} = {E622CFF2-C6C4-40FB-BE42-7C4F2B38B75A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {573B2B5F-8CBB-4D52-A55A-4E65E282AAFB}

build/scripts/Packaging.fs

@@ -13,6 +13,7 @@ open Argu
 open BuildInformation
 open CommandLine
 open Octokit
+open Proc.Fs
 
 ///
 /// This module is hard to read, with so many file manipulations it's kinda hard to avoid.
@@ -49,26 +50,26 @@ let private distroAsset (asset: ReleaseAsset) = fileInfo distroFolder (asset.Nam
 
 let pluginFiles tfm =
     ["dll"; "pdb"; "xml"]
-    |> List.map(fun e -> $"Elastic.OpenTelemetry.%s{e}")
-    |> List.map(fun f -> Path.Combine(".artifacts", "bin", "Elastic.OpenTelemetry", $"release_%s{tfm}", "", f))
+    |> List.map(fun e -> $"Elastic.OpenTelemetry.AutoInstrumentation.%s{e}")
+    |> List.map(fun f -> Path.Combine(".artifacts", "bin", "Elastic.OpenTelemetry.AutoInstrumentation", $"release_%s{tfm}", "", f))
     |> List.map(fun f -> FileInfo(f))
-    
 
 /// downloads the artifacts if they don't already exist locally
 let downloadArtifacts (_:ParseResults<Build>) =
-    let client = GitHubClient(ProductHeaderValue("Elastic.OpenTelemetry"))
-    let token = Environment.GetEnvironmentVariable("GITHUB_TOKEN")
+    let client = GitHubClient(ProductHeaderValue "Elastic.OpenTelemetry")
+    let token = Environment.GetEnvironmentVariable "GITHUB_TOKEN"
     if not(String.IsNullOrWhiteSpace(token)) then 
         printfn "using GITHUB_TOKEN";
         let tokenAuth = Credentials(token); 
         client.Credentials <- tokenAuth
 
     let assets =
         async {
-            let! release = client.Repository.Release.Get("open-telemetry", "opentelemetry-dotnet-instrumentation", $"v{otelAutoVersion.AsString}") |> Async.AwaitTask;
-            Console.WriteLine($"Release %s{release.Name} has %i{release.Assets.Count} assets");
+            let! release = client.Repository.Release.Get("open-telemetry", 
+                "opentelemetry-dotnet-instrumentation", $"v{otelAutoVersion.AsString}") |> Async.AwaitTask;
+            Console.WriteLine $"Release %s{release.Name} has %i{release.Assets.Count} assets";
             return release.Assets
-                |> Seq.map (fun asset -> (asset, downloadAsset asset))
+                |> Seq.map (fun asset -> asset, downloadAsset asset)
                 |> Seq.toList
         } |> Async.RunSynchronously
 
@@ -78,9 +79,9 @@ let downloadArtifacts (_:ParseResults<Build>) =
         |> Seq.filter (fun (_, f) -> not f.Exists)
         |> Seq.iter (fun (asset, f) ->
             async {
-                Console.WriteLine($"Retrieving {asset.Name}");
-                let! fileData = httpClient.GetByteArrayAsync(asset.BrowserDownloadUrl) |> Async.AwaitTask
-                Console.WriteLine($"Saving %i{fileData.Length} bytes to {f.FullName}")
+                Console.WriteLine $"Retrieving {asset.Name}";
+                let! fileData = httpClient.GetByteArrayAsync asset.BrowserDownloadUrl |> Async.AwaitTask
+                Console.WriteLine $"Saving %i{fileData.Length} bytes to {f.FullName}"
                 File.WriteAllBytes(f.FullName, fileData)
                 f.Refresh()
             } |> Async.RunSynchronously
@@ -94,7 +95,7 @@ let injectPluginFiles (asset: ReleaseAsset) (stagedZip: FileInfo) tfm target  =
         printfn $"Staging zip: %s{stagedZip.Name}, Adding: %s{f.Name} (%s{tfm}) to %s{target}"
         zipArchive.CreateEntryFromFile(f.FullName, Path.Combine(target, f.Name)) |> ignore
     )
-    
+
 let injectPluginScripts (stagedZip: FileInfo) (otelScript: FileInfo) (script: FileInfo) = 
     use zipArchive = ZipFile.Open(stagedZip.FullName, ZipArchiveMode.Update)
 
@@ -106,7 +107,7 @@ let injectPluginScripts (stagedZip: FileInfo) (otelScript: FileInfo) (script: Fi
     entry.Delete()
 
     zipArchive.CreateEntryFromFile(script.FullName, script.Name) |> ignore
-    
+
 let stageInstrumentationScript (stagedZips:List<ReleaseAsset * FileInfo>) =
     let openTelemetryVersion = downloadFileInfo "opentelemetry-instrument.sh"
     let stageVersion = downloadFileInfo "_instrument.sh"
@@ -117,7 +118,7 @@ let stageInstrumentationScript (stagedZips:List<ReleaseAsset * FileInfo>) =
             let instrumentShZip =
                 stagedZips
                 |> List.map(fun (_, p) -> p)
-                |> List.find (fun p -> not <| p.Name.EndsWith("-windows.zip"))
+                |> List.find (fun p -> not <| p.Name.EndsWith "-windows.zip")
             use zipArchive = ZipFile.Open(instrumentShZip.FullName, ZipArchiveMode.Read)
             let shArchive = zipArchive.Entries |> Seq.find(fun e -> e.Name = "instrument.sh")
             shArchive.ExtractToFile openTelemetryVersion.FullName
@@ -142,12 +143,14 @@ let stageInstallationBashScript () =
 
     let elasticInstall = distroFile installScript
     File.WriteAllText(elasticInstall.FullName, contents)
-    let permissions =
-        UnixFileMode.UserRead ||| UnixFileMode.UserWrite ||| UnixFileMode.UserExecute
-        ||| UnixFileMode.GroupRead ||| UnixFileMode.GroupWrite ||| UnixFileMode.GroupExecute
-        ||| UnixFileMode.OtherRead ||| UnixFileMode.OtherWrite ||| UnixFileMode.OtherExecute
-    File.SetUnixFileMode(elasticInstall.FullName, permissions);
- 
+
+    if not (OperatingSystem.IsWindows()) then
+        let permissions =
+            UnixFileMode.UserRead ||| UnixFileMode.UserWrite ||| UnixFileMode.UserExecute
+            ||| UnixFileMode.GroupRead ||| UnixFileMode.GroupWrite ||| UnixFileMode.GroupExecute
+            ||| UnixFileMode.OtherRead ||| UnixFileMode.OtherWrite ||| UnixFileMode.OtherExecute
+        File.SetUnixFileMode(elasticInstall.FullName, permissions);
+
 let stageInstallationPsScript () =
     let installScript = downloadFileInfo "OpenTelemetry.DotNet.Auto.psm1"
     let staged = installScript.CopyTo ((stageFile installScript).FullName, true)
@@ -163,35 +166,34 @@ let stageInstallationPsScript () =
                      [
                         envMarker
                         "#Elastic Distribution"
-                        "\"OTEL_DOTNET_AUTO_PLUGINS\"            = \"Elastic.OpenTelemetry.AutoInstrumentationPlugin, Elastic.OpenTelemetry\""
+                        "\"OTEL_DOTNET_AUTO_PLUGINS\"            = \"Elastic.OpenTelemetry.AutoInstrumentationPlugin, Elastic.OpenTelemetry.AutoInstrumentation\""
                      ]
                      |> String.concat "\r\n        "
             )
             .Replace("v" + Software.OpenTelemetryAutoInstrumentationVersion.AsString, Software.Version.NormalizeToShorter())
     let elasticInstall = distroFile installScript
     //ensure we write our new module name
     File.WriteAllText(elasticInstall.FullName.Replace("elastic.DotNet.Auto", "Elastic.OpenTelemetry.DotNet"), contents);
-    
-    
+
 /// moves artifacts from open-distribution to elastic-distribution and renames them to `staged-dotnet-instrumentation*`.
 /// staged meaning we haven't injected our opentelemetry dll into the zip yet,
 let stageArtifacts (assets:List<ReleaseAsset * FileInfo>) =
     let stagedZips =
         assets
-        |> List.filter(fun (a, _) -> a.Name.EndsWith(".zip"))
-        |> List.filter(fun (a, _) -> not <| a.Name.EndsWith("nuget-packages.zip"))
+        |> List.filter(fun (a, _) -> a.Name.EndsWith ".zip")
+        |> List.filter(fun (a, _) -> not <| a.Name.EndsWith "nuget-packages.zip")
         |> List.map(fun (z, f) ->
             let stage = stageAsset z
             z, f.CopyTo(stage.FullName, true)
         )
 
-    let (otelScript, wrapperScript) = stageInstrumentationScript stagedZips
+    let otelScript, wrapperScript = stageInstrumentationScript stagedZips
     printfn $"Staged (%s{wrapperScript.Name}) calling into (%s{otelScript.Name} for repackaging)"
 
     stagedZips |> List.iter (fun (asset, path) ->
 
         injectPluginFiles asset path "netstandard2.1" "net"
-        if asset.Name.EndsWith("-windows.zip") then
+        if asset.Name.EndsWith "-windows.zip" then
             injectPluginFiles asset path "net462" "netfx"
 
         injectPluginScripts path otelScript wrapperScript
@@ -203,20 +205,16 @@ let stageArtifacts (assets:List<ReleaseAsset * FileInfo>) =
         printfn $"Moved staging to: %s{distro.FullName}"
     )
     stagedZips
-    
-    
-  
+
 let redistribute (arguments:ParseResults<Build>) =
+    exec { run "dotnet" "build" "src/Elastic.OpenTelemetry.AutoInstrumentation/Elastic.OpenTelemetry.AutoInstrumentation.csproj" "-f" "netstandard2.1" "-c" "release" }
+    exec { run "dotnet" "build" "src/Elastic.OpenTelemetry.AutoInstrumentation/Elastic.OpenTelemetry.AutoInstrumentation.csproj" "-f" "net462" "-c" "release" }
     let assets = downloadArtifacts arguments
     printfn ""
     assets |> List.iter (fun (asset, path) ->
         printfn "Asset: %s" asset.Name
     )
-    
     stageInstallationBashScript()
     stageInstallationPsScript()
     let staged = stageArtifacts assets
     ignore()
-        
-    
-    

build/scripts/Targets.fs

@@ -130,13 +130,12 @@ let private generateApiChanges _ =
     nugetPackages
     |> Seq.iter(fun p ->
         let outputFile = Path.Combine(output, $"breaking-changes-%s{p}.md")
-        let tfm = "net8.0"
+        let tfm = "net8.0" // We use net8.0 as AutoInstrumentation doesn't have a net9.0 target
         let args =
             [
                 "assembly-differ"
                 $"previous-nuget|%s{p}|%s{currentVersion}|%s{tfm}";
-                //$"directory|.artifacts/bin/%s{p}/release/%s{tfm}";
-                $"directory|.artifacts/bin/%s{p}/release_net9.0";
+                $"directory|.artifacts/bin/%s{p}/release_%s{tfm}";
                 "-a"; "true"; "--target"; p; "-f"; "github-comment"; "--output"; outputFile
             ]
         exec { run "dotnet" args }
@@ -177,7 +176,7 @@ let Setup (parsed:ParseResults<Build>) =
         | Unit_Test -> Build.Cmd [] [Build] <| runTests Unit
         | Test -> Build.Cmd [] [Build] test
 
-        | Redistribute -> Build.Cmd [Compile;] [] Packaging.redistribute
+        | Redistribute -> Build.Cmd [] [] Packaging.redistribute
 
         | Release -> 
             Build.Cmd 

examples/Example.AutoInstrumentation/Dockerfile

@@ -54,7 +54,7 @@ COPY --from=build_distro /work/.artifacts/bin/Elastic.OpenTelemetry/release_nets
 ENV CORECLR_ENABLE_PROFILING="1"
 ENV CORECLR_PROFILER="{918728DD-259F-4A6A-AC2B-B85E1B658318}"
 ENV CORECLR_PROFILER_PATH="/app/otel/linux-${TARGETARCH}/OpenTelemetry.AutoInstrumentation.Native.so"
-ENV OTEL_DOTNET_AUTO_PLUGINS="Elastic.OpenTelemetry.AutoInstrumentationPlugin, Elastic.OpenTelemetry, Version=1.0.0.0, Culture=neutral, PublicKeyToken=069ca2728db333c1"
+ENV OTEL_DOTNET_AUTO_PLUGINS="Elastic.OpenTelemetry.AutoInstrumentationPlugin, Elastic.OpenTelemetry.AutoInstrumentation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=069ca2728db333c1"
 
 ENV OTEL_TRACES_EXPORTER=none
 ENV OTEL_METRICS_EXPORTER=none

examples/ServiceDefaults/ServiceDefaults.csproj

@@ -12,8 +12,8 @@
 
     <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="9.1.0" />
     <PackageReference Include="Microsoft.Extensions.ServiceDiscovery" Version="9.0.0" />
-    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.1" />
-    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.11.1" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.2" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.11.2" />
     <PackageReference Include="OpenTelemetry.Instrumentation.GrpcNetClient" Version="1.11.0-beta.1" />
     <PackageReference Include="OpenTelemetry.Instrumentation.Process" Version="1.11.0-beta.1" />
   </ItemGroup>

src/Elastic.OpenTelemetry/Core/AutoInstrumentationPlugin.cs renamed to src/Elastic.OpenTelemetry.AutoInstrumentation/AutoInstrumentationPlugin.cs

@@ -4,6 +4,8 @@
 
 using Elastic.OpenTelemetry.Configuration;
 using Elastic.OpenTelemetry.Core;
+using Elastic.OpenTelemetry.Diagnostics;
+using Microsoft.Extensions.Logging;
 using OpenTelemetry;
 using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
@@ -28,14 +30,53 @@ public class AutoInstrumentationPlugin
 	/// <summary>
 	/// To configure tracing SDK before Auto Instrumentation configured SDK.
 	/// </summary>
-	public TracerProviderBuilder BeforeConfigureTracerProvider(TracerProviderBuilder builder) =>
-		builder.UseAutoInstrumentationElasticDefaults(_components);
+	public TracerProviderBuilder BeforeConfigureTracerProvider(TracerProviderBuilder builder)
+	{
+		var logger = _components.Logger;
+
+		try
+		{
+			builder.ConfigureResource(r => r.WithElasticDefaults(_components, null));
+
+			CoreTracerProvderBuilderExtensions.AddActivitySourceWithLogging(builder, logger, "Elastic.Transport", "<n/a>");
+			CoreTracerProvderBuilderExtensions.AddElasticProcessorsCore(builder, null, _components, null);
+
+			logger.LogConfiguredSignalProvider("Traces", nameof(TracerProviderBuilder), "<n/a>");
+
+			return builder;
+		}
+		catch (Exception ex)
+		{
+			logger.LogError(new EventId(520, "AutoInstrumentationTracerFailure"), ex,
+				"Failed to register EDOT defaults for tracing auto-instrumentation to the TracerProviderBuilder.");
+		}
+
+		return builder;
+	}
 
 	/// <summary>
 	/// To configure metrics SDK before Auto Instrumentation configured SDK.
 	/// /// </summary>
-	public MeterProviderBuilder BeforeConfigureMeterProvider(MeterProviderBuilder builder) =>
-		builder.UseAutoInstrumentationElasticDefaults(_components);
+	public MeterProviderBuilder BeforeConfigureMeterProvider(MeterProviderBuilder builder)
+	{
+		var logger = _components.Logger;
+
+		try
+		{
+			builder.ConfigureResource(r => r.WithElasticDefaults(_components, null));
+
+			logger.LogConfiguredSignalProvider(nameof(Signals.Metrics), nameof(MeterProviderBuilder), "<n/a>");
+
+			return builder;
+		}
+		catch (Exception ex)
+		{
+			logger.LogError(new EventId(521, "AutoInstrumentationTracerFailure"), ex,
+				"Failed to register EDOT defaults for metrics auto-instrumentation to the MeterProviderBuilder.");
+		}
+
+		return builder;
+	}
 
 	/// <summary>
 	/// To configure logs SDK (the method name is the same as for other logs options).