Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Api/Logs/LoggerProviderBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace OpenTelemetry.Logs;
/// <summary>
/// LoggerProviderBuilder base class.
/// </summary>
internal abstract class LoggerProviderBuilder
public abstract class LoggerProviderBuilder
{
/// <summary>
/// Initializes a new instance of the <see cref="LoggerProviderBuilder"/> class.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Logging;
using OpenTelemetry.Internal;
using OpenTelemetry.Resources;

Expand All @@ -28,6 +29,24 @@ namespace OpenTelemetry.Logs;
/// </summary>
internal static class LoggerProviderBuilderExtensions
{
/// <summary>
/// Registers a configuration action for the <see
/// cref="OpenTelemetryLoggerOptions"/> used by <see cref="ILogger"/>
/// integration (<see cref="OpenTelemetryLoggerProvider"/>).
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <param name="configure">Configuration action.</param>
/// <returns>Returns <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder ConfigureLoggerOptions(
this LoggerProviderBuilder loggerProviderBuilder,
Action<OpenTelemetryLoggerOptions> configure)
{
Guard.ThrowIfNull(configure);

return loggerProviderBuilder.ConfigureServices(
services => services.Configure(configure));
}

/// <summary>
/// Sets the <see cref="ResourceBuilder"/> from which the Resource associated with
/// this provider is built from. Overwrites currently set ResourceBuilder.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public class OpenTelemetryLoggerOptions
/// </summary>
/// <param name="processor">Log processor to add.</param>
/// <returns>Returns <see cref="OpenTelemetryLoggerOptions"/> for chaining.</returns>
// todo: [Obsolete("Use the OpenTelemetryLoggingBuilder returned by AddOpenTelemetry or call IServiceCollection.ConfigureOpenTelemetryLoggerProvider instead. AddProcessor will be removed in a future version.")]
public OpenTelemetryLoggerOptions AddProcessor(BaseProcessor<LogRecord> processor)
{
Guard.ThrowIfNull(processor);
Expand All @@ -104,6 +105,7 @@ public OpenTelemetryLoggerOptions AddProcessor(BaseProcessor<LogRecord> processo
/// </summary>
/// <param name="resourceBuilder"><see cref="ResourceBuilder"/> from which Resource will be built.</param>
/// <returns>Returns <see cref="OpenTelemetryLoggerOptions"/> for chaining.</returns>
// todo: [Obsolete("Use the OpenTelemetryLoggingBuilder returned by AddOpenTelemetry or call IServiceCollection.ConfigureOpenTelemetryLoggerProvider instead. SetResourceBuilder will be removed in a future version.")]
public OpenTelemetryLoggerOptions SetResourceBuilder(ResourceBuilder resourceBuilder)
{
Guard.ThrowIfNull(resourceBuilder);
Expand Down
63 changes: 63 additions & 0 deletions src/OpenTelemetry/Logs/ILogger/OpenTelemetryLoggingBuilder.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
// <copyright file="OpenTelemetryLoggingBuilder.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>

#nullable enable

using System.Diagnostics;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace OpenTelemetry.Logs;

/// <summary>
/// An <see cref="ILoggingBuilder"/> implementation that exposes methods for configuring OpenTelemetry.
/// </summary>
public sealed class OpenTelemetryLoggingBuilder : LoggerProviderBuilder, ILoggerProviderBuilder, ILoggingBuilder
{
private readonly LoggerProviderServiceCollectionBuilder innerBuiler;

internal OpenTelemetryLoggingBuilder(IServiceCollection services)
{
Debug.Assert(services != null, "services was null");

services.AddOpenTelemetrySharedProviderBuilderServices();

this.innerBuiler = new LoggerProviderServiceCollectionBuilder(services!);
this.Services = services!;
}

/// <inheritdoc />
public IServiceCollection Services { get; }

/// <inheritdoc/>
LoggerProvider? ILoggerProviderBuilder.Provider => null;

/// <inheritdoc/>
public override LoggerProviderBuilder AddInstrumentation<TInstrumentation>(Func<TInstrumentation> instrumentationFactory)
=> this.innerBuiler.AddInstrumentation(instrumentationFactory);

/// <inheritdoc/>
LoggerProviderBuilder IDeferredLoggerProviderBuilder.Configure(Action<IServiceProvider, LoggerProviderBuilder> configure)
{
return ((IDeferredLoggerProviderBuilder)this.innerBuiler).Configure(configure);
}

/// <inheritdoc/>
LoggerProviderBuilder ILoggerProviderBuilder.ConfigureServices(Action<IServiceCollection> configure)
{
return this.innerBuiler.ConfigureServices(configure);
}
}
52 changes: 27 additions & 25 deletions src/OpenTelemetry/Logs/ILogger/OpenTelemetryLoggingExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public static class OpenTelemetryLoggingExtensions
/// will be created for a given <see cref="IServiceCollection"/>.
/// </remarks>
/// <param name="builder">The <see cref="ILoggingBuilder"/> to use.</param>
/// <returns>The supplied <see cref="ILoggingBuilder"/> for call chaining.</returns>
public static ILoggingBuilder AddOpenTelemetry(
/// <returns><see cref="OpenTelemetryLoggingBuilder"/>.</returns>
public static OpenTelemetryLoggingBuilder AddOpenTelemetry(
this ILoggingBuilder builder)
{
Guard.ThrowIfNull(builder);
Expand All @@ -51,34 +51,36 @@ public static ILoggingBuilder AddOpenTelemetry(
// Note: This will bind logger options element (eg "Logging:OpenTelemetry") to OpenTelemetryLoggerOptions
LoggerProviderOptions.RegisterProviderOptions<OpenTelemetryLoggerOptions, OpenTelemetryLoggerProvider>(builder.Services);

new LoggerProviderServiceCollectionBuilder(builder.Services).ConfigureBuilder(
(sp, logging) =>
{
var options = sp.GetRequiredService<IOptionsMonitor<OpenTelemetryLoggerOptions>>().CurrentValue;

if (options.ResourceBuilder != null)
{
logging.SetResourceBuilder(options.ResourceBuilder);

options.ResourceBuilder = null;
}

foreach (var processor in options.Processors)
{
logging.AddProcessor(processor);
}

options.Processors.Clear();
});

builder.Services.TryAddEnumerable(
ServiceDescriptor.Singleton<ILoggerProvider, OpenTelemetryLoggerProvider>(
sp => new OpenTelemetryLoggerProvider(
sp.GetRequiredService<LoggerProvider>(),
sp.GetRequiredService<IOptionsMonitor<OpenTelemetryLoggerOptions>>().CurrentValue,
disposeProvider: false)));

return builder;
var otelBuilder = new OpenTelemetryLoggingBuilder(builder.Services);

// Note: This is to support legacy AddProcessor & SetResourceBuilder APIs on OpenTelemetryLoggerOptions
otelBuilder.ConfigureBuilder((sp, logging) =>
{
var options = sp.GetRequiredService<IOptionsMonitor<OpenTelemetryLoggerOptions>>().CurrentValue;

if (options.ResourceBuilder != null)
{
logging.SetResourceBuilder(options.ResourceBuilder);

options.ResourceBuilder = null;
}

foreach (var processor in options.Processors)
{
logging.AddProcessor(processor);
}

options.Processors.Clear();
});

return otelBuilder;
}

/// <summary>
Expand All @@ -87,8 +89,8 @@ public static ILoggingBuilder AddOpenTelemetry(
/// <remarks><inheritdoc cref="AddOpenTelemetry(ILoggingBuilder)" path="/remarks"/></remarks>
/// <param name="builder">The <see cref="ILoggingBuilder"/> to use.</param>
/// <param name="configure">Optional configuration action.</param>
/// <returns>The supplied <see cref="ILoggingBuilder"/> for call chaining.</returns>
public static ILoggingBuilder AddOpenTelemetry(
/// <returns><see cref="OpenTelemetryLoggingBuilder"/>.</returns>
public static OpenTelemetryLoggingBuilder AddOpenTelemetry(
this ILoggingBuilder builder,
Action<OpenTelemetryLoggerOptions>? configure)
{
Expand Down