Add otlp log extension methods for LoggerProviderBuilder #5103
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| static OpenTelemetry.Logs.OtlpLogExporterHelperExtensions.AddOtlpExporter(this OpenTelemetry.Logs.LoggerProviderBuilder! builder) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
| static OpenTelemetry.Logs.OtlpLogExporterHelperExtensions.AddOtlpExporter(this OpenTelemetry.Logs.LoggerProviderBuilder! builder, string? name, System.Action<OpenTelemetry.Exporter.OtlpExporterOptions!, OpenTelemetry.Logs.LogRecordExportProcessorOptions!>? configureExporterAndProcessor) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
| static OpenTelemetry.Logs.OtlpLogExporterHelperExtensions.AddOtlpExporter(this OpenTelemetry.Logs.LoggerProviderBuilder! builder, string? name, System.Action<OpenTelemetry.Exporter.OtlpExporterOptions!>? configureExporter) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
| static OpenTelemetry.Logs.OtlpLogExporterHelperExtensions.AddOtlpExporter(this OpenTelemetry.Logs.LoggerProviderBuilder! builder, System.Action<OpenTelemetry.Exporter.OtlpExporterOptions!, OpenTelemetry.Logs.LogRecordExportProcessorOptions!>! configureExporterAndProcessor) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
| static OpenTelemetry.Logs.OtlpLogExporterHelperExtensions.AddOtlpExporter(this OpenTelemetry.Logs.LoggerProviderBuilder! builder, System.Action<OpenTelemetry.Exporter.OtlpExporterOptions!>! configureExporter) -> OpenTelemetry.Logs.LoggerProviderBuilder! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,9 @@ | |
| #nullable enable | ||
|
|
||
| using System.Diagnostics; | ||
| #if EXPOSE_EXPERIMENTAL_FEATURES && NET8_0_OR_GREATER | ||
| using System.Diagnostics.CodeAnalysis; | ||
| #endif | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
@@ -106,29 +109,280 @@ public static OpenTelemetryLoggerOptions AddOtlpExporter( | |
| }); | ||
| } | ||
|
|
||
| #if EXPOSE_EXPERIMENTAL_FEATURES | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <remarks><b>WARNING</b>: This is an experimental API which might change or be removed in the future. Use at your own risk.</remarks> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| #if NET8_0_OR_GREATER | ||
| [Experimental(DiagnosticDefinitions.LoggerProviderExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)] | ||
| #endif | ||
| public | ||
| #else | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| internal | ||
| #endif | ||
| static LoggerProviderBuilder AddOtlpExporter(this LoggerProviderBuilder builder) | ||
| => AddOtlpExporter(builder, name: null, configureExporter: null); | ||
|
|
||
| #if EXPOSE_EXPERIMENTAL_FEATURES | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <remarks><b>WARNING</b>: This is an experimental API which might change or be removed in the future. Use at your own risk.</remarks> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="configureExporter">Callback action for configuring <see cref="OtlpExporterOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| #if NET8_0_OR_GREATER | ||
| [Experimental(DiagnosticDefinitions.LoggerProviderExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)] | ||
| #endif | ||
| public | ||
| #else | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="configureExporter">Callback action for configuring <see cref="OtlpExporterOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| internal | ||
| #endif | ||
| static LoggerProviderBuilder AddOtlpExporter(this LoggerProviderBuilder builder, Action<OtlpExporterOptions> configureExporter) | ||
| => AddOtlpExporter(builder, name: null, configureExporter); | ||
|
|
||
| #if EXPOSE_EXPERIMENTAL_FEATURES | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <remarks><b>WARNING</b>: This is an experimental API which might change or be removed in the future. Use at your own risk.</remarks> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="configureExporterAndProcessor">Callback action for | ||
| /// configuring <see cref="OtlpExporterOptions"/> and <see | ||
| /// cref="LogRecordExportProcessorOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| #if NET8_0_OR_GREATER | ||
| [Experimental(DiagnosticDefinitions.LoggerProviderExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)] | ||
| #endif | ||
| public | ||
| #else | ||
| internal | ||
| #endif | ||
| static LoggerProviderBuilder AddOtlpExporter(this LoggerProviderBuilder builder, Action<OtlpExporterOptions, LogRecordExportProcessorOptions> configureExporterAndProcessor) | ||
| => AddOtlpExporter(builder, name: null, configureExporterAndProcessor); | ||
|
|
||
| #if EXPOSE_EXPERIMENTAL_FEATURES | ||
| /// <summary> | ||
| /// Adds OpenTelemetry Protocol (OTLP) exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <remarks><b>WARNING</b>: This is an experimental API which might change or be removed in the future. Use at your own risk.</remarks> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="name">Optional name which is used when retrieving options.</param> | ||
| /// <param name="configureExporter">Optional callback action for configuring <see cref="OtlpExporterOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| #if NET8_0_OR_GREATER | ||
| [Experimental(DiagnosticDefinitions.LoggerProviderExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)] | ||
| #endif | ||
| public | ||
| #else | ||
| /// <summary> | ||
| /// Adds OpenTelemetry Protocol (OTLP) exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="name">Optional name which is used when retrieving options.</param> | ||
| /// <param name="configureExporter">Optional callback action for configuring <see cref="OtlpExporterOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| internal | ||
| #endif | ||
| static LoggerProviderBuilder AddOtlpExporter( | ||
| this LoggerProviderBuilder builder, | ||
| string? name, | ||
| Action<OtlpExporterOptions>? configureExporter) | ||
| { | ||
| var finalOptionsName = name ?? Options.DefaultName; | ||
|
|
||
| builder.ConfigureServices(services => | ||
| { | ||
| if (name != null && configureExporter != null) | ||
| { | ||
| // If we are using named options we register the | ||
| // configuration delegate into options pipeline. | ||
| services.Configure(finalOptionsName, configureExporter); | ||
utpilla marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| RegisterOptions(services); | ||
| }); | ||
|
|
||
| return builder.AddProcessor(sp => | ||
| { | ||
| OtlpExporterOptions exporterOptions; | ||
|
|
||
| if (name == null) | ||
| { | ||
| // If we are NOT using named options we create a new | ||
| // instance always. The reason for this is | ||
| // OtlpExporterOptions is shared by all signals. Without a | ||
| // name, delegates for all signals will mix together. See: | ||
| // https://github.com/open-telemetry/opentelemetry-dotnet/issues/4043 | ||
| exporterOptions = sp.GetRequiredService<IOptionsFactory<OtlpExporterOptions>>().Create(finalOptionsName); | ||
|
|
||
| // Configuration delegate is executed inline on the fresh instance. | ||
| configureExporter?.Invoke(exporterOptions); | ||
| } | ||
| else | ||
| { | ||
| // When using named options we can properly utilize Options | ||
| // API to create or reuse an instance. | ||
| exporterOptions = sp.GetRequiredService<IOptionsMonitor<OtlpExporterOptions>>().Get(finalOptionsName); | ||
| } | ||
|
|
||
| // Note: Not using finalOptionsName here for SdkLimitOptions. | ||
| // There should only be one provider for a given service | ||
| // collection so SdkLimitOptions is treated as a single default | ||
| // instance. | ||
| var sdkLimitOptions = sp.GetRequiredService<IOptionsMonitor<SdkLimitOptions>>().CurrentValue; | ||
|
|
||
| return BuildOtlpLogExporter( | ||
| sp, | ||
| exporterOptions, | ||
| sp.GetRequiredService<IOptionsMonitor<LogRecordExportProcessorOptions>>().Get(finalOptionsName), | ||
| sdkLimitOptions, | ||
| sp.GetRequiredService<IOptionsMonitor<ExperimentalOptions>>().Get(finalOptionsName)); | ||
| }); | ||
| } | ||
|
|
||
| #if EXPOSE_EXPERIMENTAL_FEATURES | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <remarks><b>WARNING</b>: This is an experimental API which might change or be removed in the future. Use at your own risk.</remarks> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="name">Optional name which is used when retrieving options.</param> | ||
| /// <param name="configureExporterAndProcessor">Optional callback action for | ||
| /// configuring <see cref="OtlpExporterOptions"/> and <see | ||
| /// cref="LogRecordExportProcessorOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| #if NET8_0_OR_GREATER | ||
| [Experimental(DiagnosticDefinitions.LoggerProviderExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)] | ||
| #endif | ||
| public | ||
| #else | ||
| /// <summary> | ||
| /// Adds an OTLP exporter to the LoggerProvider. | ||
| /// </summary> | ||
| /// <param name="builder"><see cref="LoggerProviderBuilder"/> builder to use.</param> | ||
| /// <param name="name">Optional name which is used when retrieving options.</param> | ||
| /// <param name="configureExporterAndProcessor">Optional callback action for | ||
| /// configuring <see cref="OtlpExporterOptions"/> and <see | ||
| /// cref="LogRecordExportProcessorOptions"/>.</param> | ||
| /// <returns>The instance of <see cref="LoggerProviderBuilder"/> to chain the calls.</returns> | ||
| internal | ||
| #endif | ||
| static LoggerProviderBuilder AddOtlpExporter( | ||
| this LoggerProviderBuilder builder, | ||
| string? name, | ||
| Action<OtlpExporterOptions, LogRecordExportProcessorOptions>? configureExporterAndProcessor) | ||
| { | ||
| var finalOptionsName = name ?? Options.DefaultName; | ||
|
|
||
| builder.ConfigureServices(RegisterOptions); | ||
|
|
||
| return builder.AddProcessor(sp => | ||
| { | ||
| OtlpExporterOptions exporterOptions; | ||
|
|
||
| if (name == null) | ||
| { | ||
| // If we are NOT using named options we create a new | ||
| // instance always. The reason for this is | ||
| // OtlpExporterOptions is shared by all signals. Without a | ||
| // name, delegates for all signals will mix together. See: | ||
| // https://github.com/open-telemetry/opentelemetry-dotnet/issues/4043 | ||
| exporterOptions = sp.GetRequiredService<IOptionsFactory<OtlpExporterOptions>>().Create(finalOptionsName); | ||
| } | ||
| else | ||
| { | ||
| // When using named options we can properly utilize Options | ||
| // API to create or reuse an instance. | ||
| exporterOptions = sp.GetRequiredService<IOptionsMonitor<OtlpExporterOptions>>().Get(finalOptionsName); | ||
| } | ||
|
|
||
| var processorOptions = sp.GetRequiredService<IOptionsMonitor<LogRecordExportProcessorOptions>>().Get(finalOptionsName); | ||
|
|
||
| // Configuration delegate is executed inline. | ||
| configureExporterAndProcessor?.Invoke(exporterOptions, processorOptions); | ||
|
|
||
| // Note: Not using finalOptionsName here for SdkLimitOptions. | ||
| // There should only be one provider for a given service | ||
| // collection so SdkLimitOptions is treated as a single default | ||
| // instance. | ||
| var sdkLimitOptions = sp.GetRequiredService<IOptionsMonitor<SdkLimitOptions>>().CurrentValue; | ||
|
|
||
| return BuildOtlpLogExporter( | ||
| sp, | ||
| exporterOptions, | ||
| processorOptions, | ||
| sdkLimitOptions, | ||
| sp.GetRequiredService<IOptionsMonitor<ExperimentalOptions>>().Get(finalOptionsName)); | ||
| }); | ||
| } | ||
|
|
||
| internal static BaseProcessor<LogRecord> BuildOtlpLogExporter( | ||
| IServiceProvider sp, | ||
| OtlpExporterOptions exporterOptions, | ||
| LogRecordExportProcessorOptions processorOptions, | ||
| Func<BaseExporter<LogRecord>, BaseExporter<LogRecord>>? configureExporterInstance = null) | ||
| { | ||
| Debug.Assert(sp != null, "sp was null"); | ||
|
|
||
| var config = sp!.GetRequiredService<IConfiguration>(); | ||
|
|
||
| var sdkLimitOptions = new SdkLimitOptions(config); | ||
|
||
| var experimentalOptions = new ExperimentalOptions(config); | ||
|
|
||
| return BuildOtlpLogExporter(sp!, exporterOptions, processorOptions, sdkLimitOptions, experimentalOptions, configureExporterInstance); | ||
| } | ||
|
|
||
| private static BaseProcessor<LogRecord> BuildOtlpLogExporter( | ||
| IServiceProvider sp, | ||
| OtlpExporterOptions exporterOptions, | ||
| LogRecordExportProcessorOptions processorOptions, | ||
| SdkLimitOptions sdkLimitOptions, | ||
| ExperimentalOptions experimentalOptions, | ||
| Func<BaseExporter<LogRecord>, BaseExporter<LogRecord>>? configureExporterInstance = null) | ||
| { | ||
| // Note: sp is not currently used by this method but it should be used | ||
| // at some point for IHttpClientFactory integration. | ||
| Debug.Assert(sp != null, "sp was null"); | ||
| Debug.Assert(exporterOptions != null, "exporterOptions was null"); | ||
| Debug.Assert(processorOptions != null, "processorOptions was null"); | ||
| Debug.Assert(sdkLimitOptions != null, "sdkLimitOptions was null"); | ||
| Debug.Assert(experimentalOptions != null, "experimentalOptions was null"); | ||
|
|
||
| /* | ||
| * Note: | ||
| * | ||
| * We don't currently enable IHttpClientFactory for OtlpLogExporter. | ||
| * | ||
| * The DefaultHttpClientFactory requires the ILoggerFactory in its ctor: | ||
| * https://github.com/dotnet/runtime/blob/fa40ecf7d36bf4e31d7ae968807c1c529bac66d6/src/libraries/Microsoft.Extensions.Http/src/DefaultHttpClientFactory.cs#L64 | ||
| * | ||
| * This creates a circular reference: ILoggerFactory -> | ||
| * OpenTelemetryLoggerProvider -> OtlpLogExporter -> IHttpClientFactory | ||
| * -> ILoggerFactory | ||
| * | ||
| * exporterOptions.TryEnableIHttpClientFactoryIntegration(sp, | ||
| * "OtlpLogExporter"); | ||
| */ | ||
|
|
||
| BaseExporter<LogRecord> otlpExporter = new OtlpLogExporter( | ||
| exporterOptions!, | ||
| sdkLimitOptions!, | ||
| experimentalOptions!); | ||
|
|
||
| if (configureExporterInstance != null) | ||
| { | ||
|
|
@@ -152,6 +406,13 @@ internal static BaseProcessor<LogRecord> BuildOtlpLogExporter( | |
| } | ||
| } | ||
|
|
||
| private static void RegisterOptions(IServiceCollection services) | ||
| { | ||
| OtlpExporterOptions.RegisterOtlpExporterOptionsFactory(services); | ||
| services.RegisterOptionsFactory(configuration => new SdkLimitOptions(configuration)); | ||
| services.RegisterOptionsFactory(configuration => new ExperimentalOptions(configuration)); | ||
| } | ||
|
|
||
| private static OtlpExporterOptions GetOtlpExporterOptions(IServiceProvider sp, string? name, string finalName) | ||
| { | ||
| // Note: If OtlpExporter has been registered for tracing and/or metrics | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.