Skip to content

Prefer meter registration via scanning with special case for .NET 9 #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevejgordon merged 2 commits into from
Mar 31, 2025
Merged

Prefer meter registration via scanning with special case for .NET 9 #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e7ab36
Prefer meter registration via scanning with special case for .NET9
stevejgordon Mar 31, 2025
2e5eb09
Fix test
stevejgordon Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 8 additions & 24 deletions src/Elastic.OpenTelemetry/Extensions/MeterProviderBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using OpenTelemetry.Exporter;
using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Resources;

Expand Down Expand Up @@ -151,11 +150,11 @@ internal static MeterProviderBuilder WithElasticDefaultsCore(

static void ConfigureBuilder(MeterProviderBuilder builder, BuilderState builderState, IServiceCollection? services)
{
const string loggingProviderName = nameof(MeterProviderBuilder);
const string meterProviderBuilderName = nameof(MeterProviderBuilder);
var components = builderState.Components;
var logger = components.Logger;

logger.LogConfiguringBuilder(loggingProviderName, builderState.InstanceIdentifier);
logger.LogConfiguringBuilder(meterProviderBuilderName, builderState.InstanceIdentifier);

builder.ConfigureResource(r => r.WithElasticDefaults(builderState, services));

Expand All @@ -167,20 +166,17 @@ static void ConfigureBuilder(MeterProviderBuilder builder, BuilderState builderS
o.TemporalityPreference = MetricReaderTemporalityPreference.Delta));

#if NET9_0_OR_GREATER
// On .NET 9, the contrib HTTP instrumentation is no longer required. If the dependency exists,
// it will be registered via the reflection-based assembly scanning.
// .NET 9 introduced semantic convention compatible instrumentation in System.Net.Http so it's recommended to no longer
// use the contrib instrumentation. We don't bring in the dependency for .NET 9+. However, if the consuming app depends
// on it, it will be assumed that the user prefers it and therefore we allow the assembly scanning to add it. We don't
// add the native meter to avoid doubling up on metrics.
if (SignalBuilder.InstrumentationAssemblyExists("OpenTelemetry.Instrumentation.Http.dll"))
{
logger.LogHttpInstrumentationFound("metric", nameof(MeterProviderBuilder), builderState.InstanceIdentifier);
logger.LogHttpInstrumentationFound("metric", meterProviderBuilderName, builderState.InstanceIdentifier);

// For native AOT scenarios, the reflection-based assembly scanning will not run.
// Therefore, we log a warning since no HTTP instrumentation will be automatically registered.
// In this scenario, the consumer must register the contrib instrumentation manually, or
// remove the dependency so that the native .NET 9 HTTP instrumentation source will be added
// instead.
if (!RuntimeFeature.IsDynamicCodeSupported)
logger.LogWarning("The OpenTelemetry.Instrumentation.Http.dll was found alongside the executing assembly. " +
"When using Native AOT publishing on .NET, the metric instrumentation is not registered automatically. Either register it manually, " +
"When using Native AOT publishing on .NET, the metrics instrumentation is not registered automatically. Either register it manually, " +
"or remove the dependency so that the native `System.Net.Http` instrumentation (available in .NET 9) is observed instead.");
}
else
Expand Down Expand Up @@ -208,12 +204,7 @@ static void ConfigureBuilder(MeterProviderBuilder builder, BuilderState builderS
{
AddMeterWithLogging(builder, logger, "System.Runtime", builderState.InstanceIdentifier);
}
#else
AddWithLogging(builder, logger, "HTTP", b => b.AddHttpClientInstrumentation(), builderState.InstanceIdentifier);
AddWithLogging(builder, logger, "Runtime", b => b.AddRuntimeInstrumentation(), builderState.InstanceIdentifier);
#endif
// We explicity include this dependency and add it, since the current curated metric dashboard requires the memory metric.
AddWithLogging(builder, logger, "Process", b => b.AddProcessInstrumentation(), builderState.InstanceIdentifier);

if (SignalBuilder.InstrumentationAssemblyExists("OpenTelemetry.Instrumentation.AspNetCore.dll"))
{
Expand Down Expand Up @@ -254,12 +245,5 @@ static void AddMeterWithLogging(MeterProviderBuilder builder, ILogger logger, st
builder.AddMeter(meterName);
logger.LogMeterAdded(meterName, builderIdentifier);
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
static void AddWithLogging(MeterProviderBuilder builder, ILogger logger, string name, Action<MeterProviderBuilder> add, string builderIdentifier)
{
add.Invoke(builder);
logger.LogAddedInstrumentation(name, nameof(MeterProviderBuilder), builderIdentifier);
}
}
}
11 changes: 10 additions & 1 deletion src/Elastic.OpenTelemetry/Extensions/TracerProviderBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,16 @@ private static void ConfigureBuilder(TracerProviderBuilder builder, BuilderState
// use the contrib instrumentation. We don't bring in the dependency for .NET 9+. However, if the consuming app depends
// on it, it will be assumed that the user prefers it and therefore we allow the assembly scanning to add it. We don't
// add the native source to avoid doubling up on spans.
if (!SignalBuilder.InstrumentationAssemblyExists("OpenTelemetry.Instrumentation.Http.dll"))
if (SignalBuilder.InstrumentationAssemblyExists("OpenTelemetry.Instrumentation.Http.dll"))
{
logger.LogHttpInstrumentationFound("trace", tracerProviderBuilderName, builderState.InstanceIdentifier);

if (!RuntimeFeature.IsDynamicCodeSupported)
logger.LogWarning("The OpenTelemetry.Instrumentation.Http.dll was found alongside the executing assembly. " +
"When using Native AOT publishing on .NET, the trace instrumentation is not registered automatically. Either register it manually, " +
"or remove the dependency so that the native `System.Net.Http` instrumentation (available in .NET 9) is observed instead.");
}
else
{
TracerProvderBuilderExtensions.AddActivitySourceWithLogging(builder, logger, "System.Net.Http", builderState.InstanceIdentifier);
}
Expand Down
25 changes: 17 additions & 8 deletions src/Elastic.OpenTelemetry/Instrumentation/ContribMetricsInstrumentation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,28 @@ public static InstrumentationAssemblyInfo[] GetMetricsInstrumentationAssembliesI
InstrumentationMethod = "AddEventCountersInstrumentation"
},

#if NET9_0_OR_GREATER
// On .NET 9, we add the `System.Net.Http` source for native instrumentation, rather than referencing
// the contrib instrumentation. However, if the consuming application has their own reference to
// `OpenTelemetry.Instrumentation.Http`, then we use that since it signals the consumer prefers the
// contrib instrumentation. Therefore, on .NET 9+ targets, we attempt to dynamically load the contrib
// instrumentation, when available.
new()
{
Name = "Http",
Name = "HTTP",
Filename = "OpenTelemetry.Instrumentation.Http.dll",
FullyQualifiedType = "OpenTelemetry.Metrics.HttpClientInstrumentationMeterProviderBuilderExtensions",
InstrumentationMethod = "AddHttpClientInstrumentation"
},
#endif

new()
{
Name = "Runtime",
Filename = "OpenTelemetry.Instrumentation.Runtime.dll",
FullyQualifiedType = "OpenTelemetry.Metrics.MeterProviderBuilderExtensions",
InstrumentationMethod = "AddRuntimeInstrumentation"
},

new()
{
Name = "Process",
Filename = "OpenTelemetry.Instrumentation.Process.dll",
FullyQualifiedType = "OpenTelemetry.Metrics.MeterProviderBuilderExtensions",
InstrumentationMethod = "AddProcessInstrumentation"
}
];
}
4 changes: 2 additions & 2 deletions tests/Elastic.OpenTelemetry.Tests/InstrumentationScanningTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ public partial class InstrumentationScanningTests(WebApplicationFactory<Program>
private readonly ITestOutputHelper _output = output;

#if NET8_0
[GeneratedRegex(@"^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\]\[\d{6}\]\[-*\]\[Debug\]\s+Added contrib instrumentation 'HTTP' to TracerProviderBuilder.*")]
[GeneratedRegex(@"^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\]\[\d{6}\]\[-*\]\[Debug\]\s+Added contrib instrumentation 'HTTP' to TracerProviderBuilder*")]
private static partial Regex HttpTracerProviderBuilderRegex();

[GeneratedRegex(@"^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\]\[\d{6}\]\[-*\]\[Debug\]\s+Added contrib instrumentation 'HTTP' to MeterProviderBuilder.*")]
[GeneratedRegex(@"^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\]\[\d{6}\]\[-*\]\[Debug\]\s+Added contrib instrumentation 'HTTP' to MeterProviderBuilder*")]
private static partial Regex HttpMeterProviderBuilderRegex();
#elif NET9_0
[GeneratedRegex(@"^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\]\[\d{6}\]\[-*\]\[Debug\]\s+Added 'System.Net.Http' to TracerProviderBuilder.*")]
Expand Down
Loading