Skip to content
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.

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

[sdk-logs] Add LoggerProviderBuilderExtensions to SDK #4450

Merged
merged 3 commits into from
Apr 27, 2023
Merged
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
161 changes: 161 additions & 0 deletions src/OpenTelemetry/Logs/Builder/LoggerProviderBuilderExtensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
// <copyright file="LoggerProviderBuilderExtensions.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 Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenTelemetry.Internal;
using OpenTelemetry.Resources;

namespace OpenTelemetry.Logs;

/// <summary>
/// Contains extension methods for the <see cref="LoggerProviderBuilder"/> class.
/// </summary>
internal static class LoggerProviderBuilderExtensions
{
/// <summary>
/// Sets the <see cref="ResourceBuilder"/> from which the Resource associated with
/// this provider is built from. Overwrites currently set ResourceBuilder.
/// You should usually use <see cref="ConfigureResource(LoggerProviderBuilder, Action{ResourceBuilder})"/> instead
/// (call <see cref="ResourceBuilder.Clear"/> if desired).
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <param name="resourceBuilder"><see cref="ResourceBuilder"/> from which Resource will be built.</param>
/// <returns>Returns <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder SetResourceBuilder(this LoggerProviderBuilder loggerProviderBuilder, ResourceBuilder resourceBuilder)
{
Guard.ThrowIfNull(resourceBuilder);

loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
{
if (builder is LoggerProviderBuilderSdk loggerProviderBuilderSdk)
{
loggerProviderBuilderSdk.SetResourceBuilder(resourceBuilder);
}
});

return loggerProviderBuilder;
}

/// <summary>
/// Modify the <see cref="ResourceBuilder"/> from which the Resource associated with
/// this provider is built from in-place.
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <param name="configure">An action which modifies the provided <see cref="ResourceBuilder"/> in-place.</param>
/// <returns>Returns <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder ConfigureResource(this LoggerProviderBuilder loggerProviderBuilder, Action<ResourceBuilder> configure)
{
Guard.ThrowIfNull(configure);

loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
{
if (builder is LoggerProviderBuilderSdk loggerProviderBuilderSdk)
{
loggerProviderBuilderSdk.ConfigureResource(configure);
}
});

return loggerProviderBuilder;
}

/// <summary>
/// Adds a processor to the provider.
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <param name="processor">LogRecord processor to add.</param>
/// <returns>Returns <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder AddProcessor(this LoggerProviderBuilder loggerProviderBuilder, BaseProcessor<LogRecord> processor)
{
Guard.ThrowIfNull(processor);

loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
{
if (builder is LoggerProviderBuilderSdk loggerProviderBuilderSdk)
{
loggerProviderBuilderSdk.AddProcessor(processor);
}
});

return loggerProviderBuilder;
}

/// <summary>
/// Adds a processor to the provider which will be retrieved using dependency injection.
/// </summary>
/// <remarks>
/// Note: The type specified by <typeparamref name="T"/> will be
/// registered as a singleton service into application services.
/// </remarks>
/// <typeparam name="T">Processor type.</typeparam>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <returns>The supplied <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder AddProcessor<T>(this LoggerProviderBuilder loggerProviderBuilder)
where T : BaseProcessor<LogRecord>
{
loggerProviderBuilder.ConfigureServices(services => services.TryAddSingleton<T>());

loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
{
if (builder is LoggerProviderBuilderSdk loggerProviderBuilderSdk)
{
loggerProviderBuilderSdk.AddProcessor(sp.GetRequiredService<T>());
}
});

return loggerProviderBuilder;
}

/// <summary>
/// Adds a processor to the provider which will be retrieved using dependency injection.
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <param name="implementationFactory">The factory that creates the service.</param>
/// <returns>The supplied <see cref="LoggerProviderBuilder"/> for chaining.</returns>
public static LoggerProviderBuilder AddProcessor(
this LoggerProviderBuilder loggerProviderBuilder,
Func<IServiceProvider, BaseProcessor<LogRecord>> implementationFactory)
{
Guard.ThrowIfNull(implementationFactory);

loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
{
if (builder is LoggerProviderBuilderSdk loggerProviderBuilderSdk)
{
loggerProviderBuilderSdk.AddProcessor(implementationFactory(sp));
}
});

return loggerProviderBuilder;
}

/// <summary>
/// Run the given actions to initialize the <see cref="LoggerProvider"/>.
/// </summary>
/// <param name="loggerProviderBuilder"><see cref="LoggerProviderBuilder"/>.</param>
/// <returns><see cref="LoggerProvider"/>.</returns>
public static LoggerProvider Build(this LoggerProviderBuilder loggerProviderBuilder)
{
if (loggerProviderBuilder is LoggerProviderServiceCollectionBuilder loggerProviderServiceCollectionBuilder)
{
return loggerProviderServiceCollectionBuilder.Build();
}

return new LoggerProvider();
}
}
4 changes: 2 additions & 2 deletions src/OpenTelemetry/Logs/Builder/LoggerProviderBuilderSdk.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public LoggerProviderBuilderSdk(IServiceProvider serviceProvider)

public LoggerProvider? Provider => this.loggerProvider;

public List<BaseProcessor<Activity>> Processors { get; } = new();
public List<BaseProcessor<LogRecord>> Processors { get; } = new();

public void RegisterProvider(LoggerProviderSdk loggerProvider)
{
Expand Down Expand Up @@ -91,7 +91,7 @@ public LoggerProviderBuilder SetResourceBuilder(ResourceBuilder resourceBuilder)
return this;
}

public LoggerProviderBuilder AddProcessor(BaseProcessor<Activity> processor)
public LoggerProviderBuilder AddProcessor(BaseProcessor<LogRecord> processor)
{
Debug.Assert(processor != null, "processor was null");

Expand Down