Skip to content

[sdk-logs] Add Sdk.CreateLoggerProviderBuilder #4464

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
merged 2 commits into from
May 5, 2023
Merged

[sdk-logs] Add Sdk.CreateLoggerProviderBuilder #4464

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
426a493
Add Sdk.CreateLoggerProviderBuilder.
CodeBlanch May 4, 2023
f42ac8d
Code review.
CodeBlanch May 4, 2023
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
15 changes: 15 additions & 0 deletions src/OpenTelemetry/Sdk.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
using System.Diagnostics;
using OpenTelemetry.Context.Propagation;
using OpenTelemetry.Internal;
using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;

Expand Down Expand Up @@ -83,5 +84,19 @@ public static TracerProviderBuilder CreateTracerProviderBuilder()
{
return new TracerProviderBuilderBase();
}

/// <summary>
/// Creates a <see cref="LoggerProviderBuilder"/> which is used to build
/// a <see cref="LoggerProvider"/>. In a typical application, a single
/// <see cref="LoggerProvider"/> is created at application startup and
/// disposed at application shutdown. It is important to ensure that the
/// provider is not disposed too early.
/// </summary>
/// <returns><see cref="LoggerProviderBuilder"/> instance, which is used
/// to build a <see cref="LoggerProvider"/>.</returns>
internal static LoggerProviderBuilder CreateLoggerProviderBuilder()
{
return new LoggerProviderServiceCollectionBuilder();
Copy link
Contributor

@utpilla utpilla May 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we rename LoggerProviderServiceCollectionBuilder to LoggerProviderBuilderBase to stay consistent with Traces and Metrics?

Copy link
Member Author

@CodeBlanch CodeBlanch May 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can, but I would prefer not to. Here is the reasoning...

If you look at the 1.3.1 branch, hosting used to have two classes TracerProviderBuilderHosting and MeterProviderBuilderHosting. Those used the TracerProviderBuilderBase & MeterProviderBuilderBase base classes which were shipped public.

Things changed in 1.4 and we no longer use inheritance to make this stuff work. The new LoggerProviderServiceCollectionBuilder doesn't need to ever be made public (it is sealed class).

So we could rename it LoggerProviderBuilderBase but that would be misleading IMO because it isn't a base class thing. I picked the current name because I thought it better reflected the design and made things more understandable (at the cost of some consistency). I would rename TracerProviderBuilderBase & MeterProviderBuilderBase if I could be we already shipped them stable 😭

}
}
}