Rename ConfigureResources to sg ConfigureResource.

open-telemetry · Jun 13, 2022 · 1834277 · 1834277
1 parent 4d6e747
commit 1834277
Show file tree

Hide file tree

Showing 22 changed files with 29 additions and 29 deletions.
diff --git a/docs/logs/customizing-the-sdk/Program.cs b/docs/logs/customizing-the-sdk/Program.cs
@@ -30,7 +30,7 @@ public static void Main()
             builder.AddOpenTelemetry(options =>
             {
                 options.IncludeScopes = true;
-                options.ConfigureResources(r => r.AddService(serviceName: "MyService", serviceVersion: "1.0.0"));
+                options.ConfigureResource(r => r.AddService(serviceName: "MyService", serviceVersion: "1.0.0"));
                 options.AddConsoleExporter();
             });
         });

diff --git a/docs/logs/customizing-the-sdk/README.md b/docs/logs/customizing-the-sdk/README.md
@@ -52,14 +52,14 @@ var loggerFactory = LoggerFactory.Create(builder =>
 
 For more information on Processors, please review [Extending the SDK](../extending-the-sdk/README.md#processor)
 
-### ConfigureResources
+### ConfigureResource
 
 [Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)
 is the immutable representation of the entity producing the telemetry.
 If no `Resource` is explicitly configured, the default is to use a resource
 indicating this [Telemetry
 SDK](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk).
-The `ConfigureResources` method on `OpenTelemetryLoggerOptions` can be used to
+The `ConfigureResource` method on `OpenTelemetryLoggerOptions` can be used to
 configure the `ResourceBuilder`. It is not possible to change the resources
 *after* creating the `LoggerFactory`.
 
@@ -70,7 +70,7 @@ var loggerFactory = LoggerFactory.Create(builder =>
 {
     builder.AddOpenTelemetry(options =>
     {
-        options.ConfigureResources(r => r.AddService(
+        options.ConfigureResource(r => r.AddService(
             serviceName: "MyService",
             serviceVersion: "1.0.0"
             ));

diff --git a/examples/AspNetCore/Program.cs b/examples/AspNetCore/Program.cs
@@ -45,7 +45,7 @@
 builder.Services.AddOpenTelemetryTracing(options =>
 {
     options
-        .ConfigureResources(configureResources)
+        .ConfigureResource(configureResources)
         .SetSampler(new AlwaysOnSampler())
         .AddHttpClientInstrumentation()
         .AddAspNetCoreInstrumentation();
@@ -89,7 +89,7 @@
 
 builder.Logging.AddOpenTelemetry(options =>
 {
-    options.ConfigureResources(configureResources);
+    options.ConfigureResource(configureResources);
     var logExporter = builder.Configuration.GetValue<string>("UseLogExporter").ToLowerInvariant();
     switch (logExporter)
     {
@@ -115,7 +115,7 @@
 // Metrics
 builder.Services.AddOpenTelemetryMetrics(options =>
 {
-    options.ConfigureResources(configureResources)
+    options.ConfigureResource(configureResources)
         .AddHttpClientInstrumentation()
         .AddAspNetCoreInstrumentation();
 

diff --git a/examples/Console/TestConsoleExporter.cs b/examples/Console/TestConsoleExporter.cs
@@ -39,7 +39,7 @@ private static object RunWithActivitySource()
             // and use Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                    .ConfigureResources(res => res.AddService("console-test"))
+                    .ConfigureResource(res => res.AddService("console-test"))
                     .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
                     .AddConsoleExporter()
                     .Build();

diff --git a/examples/Console/TestHttpClient.cs b/examples/Console/TestHttpClient.cs
@@ -34,7 +34,7 @@ internal static object Run()
 
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                 .AddHttpClientInstrumentation()
-                .ConfigureResources(r => r.AddService("http-service-example"))
+                .ConfigureResource(r => r.AddService("http-service-example"))
                 .AddSource("http-client-test")
                 .AddConsoleExporter()
                 .Build();

diff --git a/examples/Console/TestInMemoryExporter.cs b/examples/Console/TestInMemoryExporter.cs
@@ -51,7 +51,7 @@ private static void RunWithActivitySource(ICollection<Activity> exportedItems)
             // and use InMemory exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                    .ConfigureResources(r => r.AddService("inmemory-test"))
+                    .ConfigureResource(r => r.AddService("inmemory-test"))
                     .AddInMemoryExporter(exportedItems)
                     .Build();
 

diff --git a/examples/Console/TestJaegerExporter.cs b/examples/Console/TestJaegerExporter.cs
@@ -56,7 +56,7 @@ internal static object RunWithActivity(string host, int port)
             // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
             // and use the Jaeger exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-                    .ConfigureResources(r => r.AddService("jaeger-test"))
+                    .ConfigureResource(r => r.AddService("jaeger-test"))
                     .AddSource("Samples.SampleClient", "Samples.SampleServer")
                     .AddJaegerExporter(o =>
                     {

diff --git a/examples/Console/TestMetrics.cs b/examples/Console/TestMetrics.cs
@@ -33,7 +33,7 @@ internal static object Run(MetricsOptions options)
             using var meter = new Meter("TestMeter");
 
             var providerBuilder = Sdk.CreateMeterProviderBuilder()
-                .ConfigureResources(r => r.AddService("myservice"))
+                .ConfigureResource(r => r.AddService("myservice"))
                 .AddMeter(meter.Name); // All instruments from this meter are enabled.
 
             if (options.UseExporter.Equals("otlp", StringComparison.OrdinalIgnoreCase))

diff --git a/examples/Console/TestOTelShimWithConsoleExporter.cs b/examples/Console/TestOTelShimWithConsoleExporter.cs
@@ -28,7 +28,7 @@ internal static object Run(OpenTelemetryShimOptions options)
             // and use a single pipeline with a custom MyProcessor, and Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("MyCompany.MyProduct.MyWebServer")
-                    .ConfigureResources(r => r.AddService("MyServiceName"))
+                    .ConfigureResource(r => r.AddService("MyServiceName"))
                     .AddConsoleExporter()
                     .Build();
 

diff --git a/examples/Console/TestOpenTracingShim.cs b/examples/Console/TestOpenTracingShim.cs
@@ -31,7 +31,7 @@ internal static object Run(OpenTracingShimOptions options)
             // and use Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("MyCompany.MyProduct.MyWebServer")
-                    .ConfigureResources(r => r.AddService("MyServiceName"))
+                    .ConfigureResource(r => r.AddService("MyServiceName"))
                     .AddConsoleExporter()
                     .Build();
 

diff --git a/examples/Console/TestOtlpExporter.cs b/examples/Console/TestOtlpExporter.cs
@@ -71,7 +71,7 @@ private static object RunWithActivitySource(string endpoint, string protocol)
             // and use OTLP exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                    .ConfigureResources(r => r.AddService("otlp-test"))
+                    .ConfigureResource(r => r.AddService("otlp-test"))
                     .AddOtlpExporter(opt =>
                     {
                         // If endpoint was not specified, the proper one will be selected according to the protocol.

diff --git a/examples/Console/TestZipkinExporter.cs b/examples/Console/TestZipkinExporter.cs
@@ -39,7 +39,7 @@ internal static object Run(string zipkinUri)
             // and use the Zipkin exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                    .ConfigureResources(r => r.AddService("zipkin-test"))
+                    .ConfigureResource(r => r.AddService("zipkin-test"))
                     .AddZipkinExporter(o =>
                     {
                         o.Endpoint = new Uri(zipkinUri);

diff --git a/examples/GrpcService/Startup.cs b/examples/GrpcService/Startup.cs
@@ -45,7 +45,7 @@ public void ConfigureServices(IServiceCollection services)
             {
                 case "jaeger":
                     services.AddOpenTelemetryTracing((builder) => builder
-                        .ConfigureResources(r => r.AddService(this.Configuration.GetValue<string>("Jaeger:ServiceName")))
+                        .ConfigureResource(r => r.AddService(this.Configuration.GetValue<string>("Jaeger:ServiceName")))
                         .AddAspNetCoreInstrumentation()
                         .AddJaegerExporter(jaegerOptions =>
                         {

diff --git a/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/net462/PublicAPI.Unshipped.txt
@@ -1,4 +1,4 @@
 #nullable enable
 OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ConfigureResources(System.Action<OpenTelemetry.Resources.ResourceBuilder!>! configure) -> OpenTelemetry.Logs.OpenTelemetryLoggerOptions!
 ~static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.ConfigureResources(this OpenTelemetry.Metrics.MeterProviderBuilder meterProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Metrics.MeterProviderBuilder
-~static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResources(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+~static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResource(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt
@@ -1,4 +1,4 @@
 #nullable enable
 OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ConfigureResources(System.Action<OpenTelemetry.Resources.ResourceBuilder!>! configure) -> OpenTelemetry.Logs.OpenTelemetryLoggerOptions!
 ~static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.ConfigureResources(this OpenTelemetry.Metrics.MeterProviderBuilder meterProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Metrics.MeterProviderBuilder
-~static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResources(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+~static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResource(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder, System.Action<OpenTelemetry.Resources.ResourceBuilder> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -24,7 +24,7 @@ Released 2022-June-1
 * Swallow `ObjectDisposedException` in `BatchExportProcessor` and
   `PeriodicExportingMetricReader`.
   ([#3291](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3291))
-* Add `ConfigureResources` which can replace SetResourceBuilder more succinctly
+* Add `ConfigureResource` which can replace SetResourceBuilder more succinctly
   in most cases and has greater flexibility (applies to
   TracerProvicerBuilder, MeterProviderBuilder, OpenTelemetryLoggingOptions).
   ([#3307](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3307))

diff --git a/src/OpenTelemetry/Logs/OpenTelemetryLoggerOptions.cs b/src/OpenTelemetry/Logs/OpenTelemetryLoggerOptions.cs
@@ -74,7 +74,7 @@ public OpenTelemetryLoggerOptions AddProcessor(BaseProcessor<LogRecord> processo
         /// <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="ConfigureResources(Action{ResourceBuilder})"/> instead
+        /// You should usually use <see cref="ConfigureResource(Action{ResourceBuilder})"/> instead
         /// (call <see cref="ResourceBuilder.Clear"/> if desired).
         /// </summary>
         /// <param name="resourceBuilder"><see cref="ResourceBuilder"/> from which Resource will be built.</param>
@@ -93,7 +93,7 @@ public OpenTelemetryLoggerOptions SetResourceBuilder(ResourceBuilder resourceBui
         /// </summary>
         /// <param name="configure">An action which modifies the provided <see cref="ResourceBuilder"/> in-place.</param>
         /// <returns>Returns <see cref="OpenTelemetryLoggerOptions"/> for chaining.</returns>
-        public OpenTelemetryLoggerOptions ConfigureResources(Action<ResourceBuilder> configure)
+        public OpenTelemetryLoggerOptions ConfigureResource(Action<ResourceBuilder> configure)
         {
             Guard.ThrowIfNull(configure, nameof(configure));
             configure(this.ResourceBuilder);

diff --git a/src/OpenTelemetry/Metrics/MeterProviderBuilderExtensions.cs b/src/OpenTelemetry/Metrics/MeterProviderBuilderExtensions.cs
@@ -183,7 +183,7 @@ public static MeterProviderBuilder SetMaxMetricPointsPerMetricStream(this MeterP
         /// <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="ConfigureResources(MeterProviderBuilder, Action{ResourceBuilder})"/> instead
+        /// You should usually use <see cref="ConfigureResource(MeterProviderBuilder, Action{ResourceBuilder})"/> instead
         /// (call <see cref="ResourceBuilder.Clear"/> if desired).
         /// </summary>
         /// <param name="meterProviderBuilder">MeterProviderBuilder instance.</param>
@@ -206,7 +206,7 @@ public static MeterProviderBuilder SetResourceBuilder(this MeterProviderBuilder
         /// <param name="meterProviderBuilder">MeterProviderBuilder instance.</param>
         /// <param name="configure">An action which modifies the provided <see cref="ResourceBuilder"/> in-place.</param>
         /// <returns>Returns <see cref="MeterProviderBuilder"/> for chaining.</returns>
-        public static MeterProviderBuilder ConfigureResources(this MeterProviderBuilder meterProviderBuilder, Action<ResourceBuilder> configure)
+        public static MeterProviderBuilder ConfigureResource(this MeterProviderBuilder meterProviderBuilder, Action<ResourceBuilder> configure)
         {
             Guard.ThrowIfNull(meterProviderBuilder, nameof(meterProviderBuilder));
             Guard.ThrowIfNull(configure, nameof(configure));

diff --git a/src/OpenTelemetry/README.md b/src/OpenTelemetry/README.md
@@ -255,7 +255,7 @@ using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
 
 using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-    .ConfigureResources(r => r.AddService("MyServiceName"))
+    .ConfigureResource(r => r.AddService("MyServiceName"))
     .Build();
 ```
 

diff --git a/src/OpenTelemetry/Trace/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry/Trace/TracerProviderBuilderExtensions.cs
@@ -62,7 +62,7 @@ public static TracerProviderBuilder SetSampler(this TracerProviderBuilder tracer
         /// <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="ConfigureResources(TracerProviderBuilder, Action{ResourceBuilder})"/> instead
+        /// You should usually use <see cref="ConfigureResource(TracerProviderBuilder, Action{ResourceBuilder})"/> instead
         /// (call <see cref="ResourceBuilder.Clear"/> if desired).
         /// </summary>
         /// <param name="tracerProviderBuilder">TracerProviderBuilder instance.</param>
@@ -85,7 +85,7 @@ public static TracerProviderBuilder SetResourceBuilder(this TracerProviderBuilde
         /// <param name="tracerProviderBuilder">TracerProviderBuilder instance.</param>
         /// <param name="configure">An action which modifies the provided <see cref="ResourceBuilder"/> in-place.</param>
         /// <returns>Returns <see cref="TracerProviderBuilder"/> for chaining.</returns>
-        public static TracerProviderBuilder ConfigureResources(this TracerProviderBuilder tracerProviderBuilder, Action<ResourceBuilder> configure)
+        public static TracerProviderBuilder ConfigureResource(this TracerProviderBuilder tracerProviderBuilder, Action<ResourceBuilder> configure)
         {
             Guard.ThrowIfNull(tracerProviderBuilder, nameof(tracerProviderBuilder));
             Guard.ThrowIfNull(configure, nameof(configure));

diff --git a/test/Benchmarks/Instrumentation/InstrumentedHttpClientBenchmark.cs b/test/Benchmarks/Instrumentation/InstrumentedHttpClientBenchmark.cs
@@ -52,7 +52,7 @@ public void GlobalSetup()
 
             this.tracerProvider = Sdk.CreateTracerProviderBuilder()
                 .AddHttpClientInstrumentation()
-                .ConfigureResources(r => r.AddService(ServiceName))
+                .ConfigureResource(r => r.AddService(ServiceName))
                 .AddSource(SourceName)
                 .Build();
 

diff --git a/test/OpenTelemetry.Tests/Trace/TracerProviderSdkTest.cs b/test/OpenTelemetry.Tests/Trace/TracerProviderSdkTest.cs
@@ -1068,7 +1068,7 @@ public void TracerProviderSdkBuildsWithSDKResource(bool useConfigure)
             var tracerProvider = useConfigure ?
                 Sdk.CreateTracerProviderBuilder().SetResourceBuilder(
                     ResourceBuilder.CreateDefault().AddTelemetrySdk()).Build() :
-                Sdk.CreateTracerProviderBuilder().ConfigureResources(r => r.AddTelemetrySdk()).Build();
+                Sdk.CreateTracerProviderBuilder().ConfigureResource(r => r.AddTelemetrySdk()).Build();
             var resource = tracerProvider.GetResource();
             var attributes = resource.Attributes;