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.

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

MeterProvider and TracerProvider lifetime guidance added to XML docs #2850

Merged
merged 3 commits into from
Feb 3, 2022
Merged

MeterProvider and TracerProvider lifetime guidance added to XML docs #2850

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12fd62f
Lifetime guidance for MeterProvider and TracerProvider
alanwest Feb 3, 2022
4517e49
Merge branch 'main' into alanwest/once-in-a-lifetime-water-flowing-un…
cijothomas Feb 3, 2022
1f8275c
Merge branch 'main' into alanwest/once-in-a-lifetime-water-flowing-un…
cijothomas Feb 3, 2022
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
17 changes: 12 additions & 5 deletions src/OpenTelemetry/Sdk.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,26 @@ public static void SetDefaultTextMapPropagator(TextMapPropagator textMapPropagat
}

/// <summary>
/// Creates MeterProviderBuilder which should be used to build MeterProvider.
/// Creates a <see cref="MeterProviderBuilder"/> which is used to build
/// a <see cref="MeterProvider"/>. In a typical application, a single
/// <see cref="MeterProvider"/> 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>MeterProviderBuilder instance, which should be used to build MeterProvider.</returns>
/// <returns><see cref="MeterProviderBuilder"/> instance, which is used to build a <see cref="MeterProvider"/>.</returns>
public static MeterProviderBuilder CreateMeterProviderBuilder()
{
return new MeterProviderBuilderSdk();
}

/// <summary>
/// Creates TracerProviderBuilder which should be used to build
/// TracerProvider.
/// Creates a <see cref="TracerProviderBuilder"/> which is used to build
/// a <see cref="TracerProvider"/>. In a typical application, a single
/// <see cref="TracerProvider"/> 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>TracerProviderBuilder instance, which should be used to build TracerProvider.</returns>
/// <returns><see cref="TracerProviderBuilder"/> instance, which is used to build a <see cref="TracerProvider"/>.</returns>
public static TracerProviderBuilder CreateTracerProviderBuilder()
{
return new TracerProviderBuilderSdk();
Expand Down