Skip to content

Commit 3ff1df2

Browse files
authored
[otlp] Update README for UseOtlpExporter & new experimental flag (#5452)
1 parent af57ae8 commit 3ff1df2

File tree

4 files changed

+326
-89
lines changed

4 files changed

+326
-89
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
OpenTelemetry.OpenTelemetryBuilderOtlpExporterExtensions
22
static OpenTelemetry.OpenTelemetryBuilderOtlpExporterExtensions.UseOtlpExporter(this OpenTelemetry.IOpenTelemetryBuilder! builder) -> OpenTelemetry.IOpenTelemetryBuilder!
3-
static OpenTelemetry.OpenTelemetryBuilderOtlpExporterExtensions.UseOtlpExporter(this OpenTelemetry.IOpenTelemetryBuilder! builder, OpenTelemetry.Exporter.OtlpExportProtocol protocol, System.Uri! baseEndpoint) -> OpenTelemetry.IOpenTelemetryBuilder!
3+
static OpenTelemetry.OpenTelemetryBuilderOtlpExporterExtensions.UseOtlpExporter(this OpenTelemetry.IOpenTelemetryBuilder! builder, OpenTelemetry.Exporter.OtlpExportProtocol protocol, System.Uri! baseUrl) -> OpenTelemetry.IOpenTelemetryBuilder!

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Builder/OpenTelemetryBuilderOtlpExporterExtensions.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public static class OpenTelemetryBuilderOtlpExporterExtensions
2626
/// tracing.</item>
2727
/// <item>The exporter registered by this method will be added as the last
2828
/// processor in the pipeline established for logging and tracing.</item>
29-
/// <item>This method can only be called once. Subsequent calls will results
29+
/// <item>This method can only be called once. Subsequent calls will result
3030
/// in a <see cref="NotSupportedException"/> being thrown.</item>
3131
/// <item>This method cannot be called in addition to signal-specific
3232
/// <c>AddOtlpExporter</c> methods. If this method is called signal-specific
@@ -45,25 +45,25 @@ public static IOpenTelemetryBuilder UseOtlpExporter(
4545
/// <returns><inheritdoc cref="UseOtlpExporter(IOpenTelemetryBuilder)" path="/returns"/></returns>
4646
/// <param name="builder"><see cref="IOpenTelemetryBuilder"/>.</param>
4747
/// <param name="protocol"><see cref="OtlpExportProtocol"/>.</param>
48-
/// <param name="baseEndpoint">
49-
/// <para>Base endpoint to use.</para>
50-
/// Note: A signal-specific path will be appended to the base endpoint for
51-
/// each signal automatically if the protocol is set to <see
48+
/// <param name="baseUrl">
49+
/// <para>Base URL to use.</para>
50+
/// Note: A signal-specific path will be appended to the base URL for each
51+
/// signal automatically if the protocol is set to <see
5252
/// cref="OtlpExportProtocol.HttpProtobuf"/>.
5353
/// </param>
5454
public static IOpenTelemetryBuilder UseOtlpExporter(
5555
this IOpenTelemetryBuilder builder,
5656
OtlpExportProtocol protocol,
57-
Uri baseEndpoint)
57+
Uri baseUrl)
5858
{
59-
Guard.ThrowIfNull(baseEndpoint);
59+
Guard.ThrowIfNull(baseUrl);
6060

6161
return UseOtlpExporter(builder, name: null, configuration: null, configure: otlpBuilder =>
6262
{
6363
otlpBuilder.ConfigureDefaultExporterOptions(o =>
6464
{
6565
o.Protocol = protocol;
66-
o.Endpoint = baseEndpoint;
66+
o.Endpoint = baseUrl;
6767
});
6868
});
6969
}

0 commit comments

Comments
 (0)