Instrumentation generator

.github/workflows/dotnet-format.yml

@@ -28,7 +28,7 @@ jobs:
         dotnet-version: 7.0.302
 
     - name: Install format tool
-      run: dotnet tool install -g dotnet-format
+      run: dotnet tool install -g dotnet-format --version "7.*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet7/nuget/v3/index.json
 
     - name: dotnet format
-      run: dotnet-format --folder --check
+      run: dotnet-format .\OpenTelemetry.AutoInstrumentation.sln --no-restore --verify-no-changes

OpenTelemetry.AutoInstrumentation.sln

@@ -195,6 +195,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApplication.Wcf.Server.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.AutoInstrumentation.BuildTasks.Tests", "test\OpenTelemetry.AutoInstrumentation.BuildTasks.Tests\OpenTelemetry.AutoInstrumentation.BuildTasks.Tests.csproj", "{11BD3D9A-D413-4D8C-A815-7D4ABB38A0BA}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SourceGenerators", "src\SourceGenerators\SourceGenerators.csproj", "{28FCC3BC-A609-4400-9831-03741A24A89C}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -907,6 +909,18 @@ Global
 		{11BD3D9A-D413-4D8C-A815-7D4ABB38A0BA}.Release|x64.Build.0 = Release|Any CPU
 		{11BD3D9A-D413-4D8C-A815-7D4ABB38A0BA}.Release|x86.ActiveCfg = Release|Any CPU
 		{11BD3D9A-D413-4D8C-A815-7D4ABB38A0BA}.Release|x86.Build.0 = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|x64.Build.0 = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Debug|x86.Build.0 = Debug|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|x64.ActiveCfg = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|x64.Build.0 = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|x86.ActiveCfg = Release|Any CPU
+		{28FCC3BC-A609-4400-9831-03741A24A89C}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -976,6 +990,7 @@ Global
 		{66FB648E-7FAF-418B-B2F6-B7CB9EE579CA} = {E409ADD3-9574-465C-AB09-4324D205CC7C}
 		{65619BD1-4517-400C-8071-C1409A7D255E} = {E409ADD3-9574-465C-AB09-4324D205CC7C}
 		{11BD3D9A-D413-4D8C-A815-7D4ABB38A0BA} = {5C915382-C886-457D-8641-9E766D8E5A17}
+		{28FCC3BC-A609-4400-9831-03741A24A89C} = {9E5F0022-0A50-40BF-AC6A-C3078585ECAB}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {160A1D00-1F5B-40F8-A155-621B4459D78F}

examples/playground/AspNetCoreMvc/GlobalSuppressions.cs

@@ -0,0 +1,24 @@
+// <copyright file="GlobalSuppressions.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed.")]

src/Directory.Packages.props

@@ -34,6 +34,12 @@
     <PackageVersion Include="OpenTelemetry.ResourceDetectors.Container" Version="1.0.0-beta.4" />
   </ItemGroup>
 
+  <!-- Versions from SourceGenerators.csproj -->
+  <ItemGroup>
+    <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.6.0" />
+  </ItemGroup>
+
   <!-- Versions from CommonExcludedAssets.props -->
   <ItemGroup>
     <!-- Microsoft.Bcl.AsyncInterfaces is also referenced by the .NET Framework4.6.2. In this case is not excluded -->

src/OpenTelemetry.AutoInstrumentation/Generated/net462/SourceGenerators/SourceGenerators.InstrumentationDefinitionsGenerator/InstrumentationDefinitions.g.cs

@@ -0,0 +1,83 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the InstrumentationDefinitionsGenerator tool. To safely
+//     modify this file, edit InstrumentMethodAttribute on the classes and
+//     compile project.
+
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated. 
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+using OpenTelemetry.AutoInstrumentation.Configurations;
+
+namespace OpenTelemetry.AutoInstrumentation;
+
+internal static partial class InstrumentationDefinitions
+{
+    private static readonly string AssemblyFullName = typeof(InstrumentationDefinitions).Assembly.FullName!;
+
+    private static NativeCallTargetDefinition[] GetDefinitionsArray()
+    {
+        var nativeCallTargetDefinitions = new List<NativeCallTargetDefinition>(11);
+        // Traces
+        var tracerSettings = Instrumentation.TracerSettings.Value;
+        if (tracerSettings.TracesEnabled)
+{
+            // AspNet
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.AspNet))
+            {
+                nativeCallTargetDefinitions.Add(new("System.Web", "System.Web.Compilation.BuildManager", "InvokePreStartInitMethodsCore", new[] {"System.Void", "System.Collections.Generic.ICollection`1[System.Reflection.MethodInfo]", "System.Func`1[System.IDisposable]"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.AspNet.HttpModuleIntegration"));
+            }
+
+            // GraphQL
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.GraphQL))
+            {
+                nativeCallTargetDefinitions.Add(new("GraphQL", "GraphQL.Execution.ExecutionStrategy", "ExecuteAsync", new[] {"System.Threading.Tasks.Task`1[GraphQL.ExecutionResult]", "GraphQL.Execution.ExecutionContext"}, 2, 3, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.GraphQL.ExecuteAsyncIntegration"));
+                nativeCallTargetDefinitions.Add(new("GraphQL", "GraphQL.Execution.SubscriptionExecutionStrategy", "ExecuteAsync", new[] {"System.Threading.Tasks.Task`1[GraphQL.ExecutionResult]", "GraphQL.Execution.ExecutionContext"}, 2, 3, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.GraphQL.ExecuteAsyncIntegration"));
+            }
+
+            // MongoDB
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.MongoDB))
+            {
+                nativeCallTargetDefinitions.Add(new("MongoDB.Driver", "MongoDB.Driver.MongoClient", ".ctor", new[] {"System.Void", "MongoDB.Driver.MongoClientSettings"}, 2, 13, 3, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.MongoDB.MongoClientIntegration"));
+            }
+
+            // NServiceBus
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.NServiceBus))
+            {
+                nativeCallTargetDefinitions.Add(new("NServiceBus.Core", "NServiceBus.EndpointConfiguration", ".ctor", new[] {"System.Void", "System.String"}, 8, 0, 0, 8, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.NServiceBus.EndpointConfigurationIntegration"));
+            }
+
+            // WcfService
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.WcfService))
+            {
+                nativeCallTargetDefinitions.Add(new("System.ServiceModel", "System.ServiceModel.ServiceHostBase", "InitializeDescription", new[] {"System.Void", "System.ServiceModel.UriSchemeKeyedCollection"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Wcf.ServiceHostIntegration"));
+            }
+
+            // WcfClient
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.WcfClient))
+            {
+                nativeCallTargetDefinitions.Add(new("System.ServiceModel", "System.ServiceModel.ChannelFactory", "InitializeEndpoint", new[] {"System.Void", "System.String", "System.ServiceModel.EndpointAddress"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Wcf.WcfClientIntegration"));
+                nativeCallTargetDefinitions.Add(new("System.ServiceModel", "System.ServiceModel.ChannelFactory", "InitializeEndpoint", new[] {"System.Void", "System.String", "System.ServiceModel.EndpointAddress", "System.Configuration.Configuration"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Wcf.WcfClientIntegration"));
+                nativeCallTargetDefinitions.Add(new("System.ServiceModel", "System.ServiceModel.ChannelFactory", "InitializeEndpoint", new[] {"System.Void", "System.ServiceModel.Description.ServiceEndpoint"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Wcf.WcfClientIntegration"));
+                nativeCallTargetDefinitions.Add(new("System.ServiceModel", "System.ServiceModel.ChannelFactory", "InitializeEndpoint", new[] {"System.Void", "System.ServiceModel.Channels.Binding", "System.ServiceModel.EndpointAddress"}, 4, 0, 0, 4, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Wcf.WcfClientIntegration"));
+            }
+
+        }
+
+        // Metrics
+        var metricSettings = Instrumentation.MetricSettings.Value;
+        if (metricSettings.MetricsEnabled)
+{
+            // NServiceBus
+            if (metricSettings.EnabledInstrumentations.Contains(MetricInstrumentation.NServiceBus))
+            {
+                nativeCallTargetDefinitions.Add(new("NServiceBus.Core", "NServiceBus.EndpointConfiguration", ".ctor", new[] {"System.Void", "System.String"}, 8, 0, 0, 8, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.NServiceBus.EndpointConfigurationIntegration"));
+            }
+
+        }
+
+        return nativeCallTargetDefinitions.ToArray();
+    }
+}

src/OpenTelemetry.AutoInstrumentation/Generated/net6.0/SourceGenerators/SourceGenerators.InstrumentationDefinitionsGenerator/InstrumentationDefinitions.g.cs

@@ -0,0 +1,92 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the InstrumentationDefinitionsGenerator tool. To safely
+//     modify this file, edit InstrumentMethodAttribute on the classes and
+//     compile project.
+
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated. 
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+using OpenTelemetry.AutoInstrumentation.Configurations;
+
+namespace OpenTelemetry.AutoInstrumentation;
+
+internal static partial class InstrumentationDefinitions
+{
+    private static readonly string AssemblyFullName = typeof(InstrumentationDefinitions).Assembly.FullName!;
+
+    private static NativeCallTargetDefinition[] GetDefinitionsArray()
+    {
+        var nativeCallTargetDefinitions = new List<NativeCallTargetDefinition>(14);
+        // Traces
+        var tracerSettings = Instrumentation.TracerSettings.Value;
+        if (tracerSettings.TracesEnabled)
+{
+            // GraphQL
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.GraphQL))
+            {
+                nativeCallTargetDefinitions.Add(new("GraphQL", "GraphQL.Execution.ExecutionStrategy", "ExecuteAsync", new[] {"System.Threading.Tasks.Task`1[GraphQL.ExecutionResult]", "GraphQL.Execution.ExecutionContext"}, 2, 3, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.GraphQL.ExecuteAsyncIntegration"));
+                nativeCallTargetDefinitions.Add(new("GraphQL", "GraphQL.Execution.SubscriptionExecutionStrategy", "ExecuteAsync", new[] {"System.Threading.Tasks.Task`1[GraphQL.ExecutionResult]", "GraphQL.Execution.ExecutionContext"}, 2, 3, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.GraphQL.ExecuteAsyncIntegration"));
+            }
+
+            // MongoDB
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.MongoDB))
+            {
+                nativeCallTargetDefinitions.Add(new("MongoDB.Driver", "MongoDB.Driver.MongoClient", ".ctor", new[] {"System.Void", "MongoDB.Driver.MongoClientSettings"}, 2, 13, 3, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.MongoDB.MongoClientIntegration"));
+            }
+
+            // MySqlData
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.MySqlData))
+            {
+                nativeCallTargetDefinitions.Add(new("MySql.Data", "MySql.Data.MySqlClient.MySqlConnectionStringBuilder", "get_Logging", new[] {"System.Boolean"}, 8, 0, 31, 8, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.MySqlData.MySqlConnectionStringBuilderIntegration"));
+            }
+
+            // NServiceBus
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.NServiceBus))
+            {
+                nativeCallTargetDefinitions.Add(new("NServiceBus.Core", "NServiceBus.EndpointConfiguration", ".ctor", new[] {"System.Void", "System.String"}, 8, 0, 0, 8, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.NServiceBus.EndpointConfigurationIntegration"));
+            }
+
+            // StackExchangeRedis
+            if (tracerSettings.EnabledInstrumentations.Contains(TracerInstrumentation.StackExchangeRedis))
+            {
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImpl", new[] {"StackExchange.Redis.ConnectionMultiplexer", "System.Object", "System.IO.TextWriter"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegration"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImpl", new[] {"StackExchange.Redis.ConnectionMultiplexer", "StackExchange.Redis.ConfigurationOptions", "System.IO.TextWriter"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegration"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImpl", new[] {"StackExchange.Redis.ConnectionMultiplexer", "StackExchange.Redis.ConfigurationOptions", "System.IO.TextWriter", "System.Nullable`1[StackExchange.Redis.ServerType]"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegration"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImpl", new[] {"StackExchange.Redis.ConnectionMultiplexer", "StackExchange.Redis.ConfigurationOptions", "System.IO.TextWriter", "System.Nullable`1[StackExchange.Redis.ServerType]", "StackExchange.Redis.EndPointCollection"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegration"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImplAsync", new[] {"System.Threading.Tasks.Task`1[StackExchange.Redis.ConnectionMultiplexer]", "System.Object", "System.IO.TextWriter"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegrationAsync"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImplAsync", new[] {"System.Threading.Tasks.Task`1[StackExchange.Redis.ConnectionMultiplexer]", "StackExchange.Redis.ConfigurationOptions", "System.IO.TextWriter"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegrationAsync"));
+                nativeCallTargetDefinitions.Add(new("StackExchange.Redis", "StackExchange.Redis.ConnectionMultiplexer", "ConnectImplAsync", new[] {"System.Threading.Tasks.Task`1[StackExchange.Redis.ConnectionMultiplexer]", "StackExchange.Redis.ConfigurationOptions", "System.IO.TextWriter", "System.Nullable`1[StackExchange.Redis.ServerType]"}, 2, 0, 0, 2, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.StackExchangeRedis.StackExchangeRedisIntegrationAsync"));
+            }
+
+        }
+
+        // Logs
+        var logSettings = Instrumentation.LogSettings.Value;
+        if (logSettings.LogsEnabled)
+{
+            // ILogger
+            if (logSettings.EnabledInstrumentations.Contains(LogInstrumentation.ILogger))
+            {
+                nativeCallTargetDefinitions.Add(new("Microsoft.Extensions.Logging", "Microsoft.Extensions.Logging.LoggingBuilder", ".ctor", new[] {"System.Void", "Microsoft.Extensions.DependencyInjection.IServiceCollection"}, 3, 1, 0, 7, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.Logger.LoggingBuilderIntegration"));
+            }
+
+        }
+
+        // Metrics
+        var metricSettings = Instrumentation.MetricSettings.Value;
+        if (metricSettings.MetricsEnabled)
+{
+            // NServiceBus
+            if (metricSettings.EnabledInstrumentations.Contains(MetricInstrumentation.NServiceBus))
+            {
+                nativeCallTargetDefinitions.Add(new("NServiceBus.Core", "NServiceBus.EndpointConfiguration", ".ctor", new[] {"System.Void", "System.String"}, 8, 0, 0, 8, 65535, 65535, AssemblyFullName, "OpenTelemetry.AutoInstrumentation.Instrumentations.NServiceBus.EndpointConfigurationIntegration"));
+            }
+
+        }
+
+        return nativeCallTargetDefinitions.ToArray();
+    }
+}