Add & use ConfigureResource API. by Oberon00 · Pull Request #3307 · open-telemetry/opentelemetry-dotnet

Oberon00 · 2022-05-25T16:04:35Z

Changes

Added ConfigureResources which can replace SetResourceBuilder more succinctly in most cases
and has greater flexibility (applies to TracerProvicerBuilder, MeterProviderBuilder, OpenTelemetryLoggingOptions).

Appropriate CHANGELOG.md updated for non-trivial changes
~~[ ] Design discussion issue #~~ Although this is very similar to the design proposed in SetResourceBuilder is overly restrictive, no way to cooperatively initialize Resources #2909
Changes in public API reviewed

codecov · 2022-05-25T16:13:57Z

Codecov Report

Merging #3307 (e8be4f5) into main (98b4fde) will increase coverage by 0.05%.
The diff coverage is 63.63%.

@@            Coverage Diff             @@
##             main    #3307      +/-   ##
==========================================
+ Coverage   86.20%   86.25%   +0.05%     
==========================================
  Files         258      258              
  Lines        9254     9269      +15     
==========================================
+ Hits         7977     7995      +18     
+ Misses       1277     1274       -3

Impacted Files	Coverage Δ
...c/OpenTelemetry/Logs/OpenTelemetryLoggerOptions.cs	`78.57% <0.00%> (-21.43%)`	⬇️
...elemetry/Metrics/MeterProviderBuilderExtensions.cs	`63.82% <33.33%> (-7.60%)`	⬇️
.../OpenTelemetry/Metrics/MeterProviderBuilderBase.cs	`87.71% <66.66%> (-1.57%)`	⬇️
...c/OpenTelemetry/Trace/TracerProviderBuilderBase.cs	`91.66% <100.00%> (+0.14%)`	⬆️
...Telemetry/Trace/TracerProviderBuilderExtensions.cs	`90.90% <100.00%> (+2.67%)`	⬆️
src/OpenTelemetry/BatchExportProcessor.cs	`79.04% <0.00%> (-2.86%)`	⬇️
...Telemetry/Internal/SelfDiagnosticsEventListener.cs	`96.87% <0.00%> (-0.79%)`	⬇️
...metryProtocol/Implementation/ActivityExtensions.cs	`94.50% <0.00%> (+3.29%)`	⬆️
...tation/OpenTelemetryProtocolExporterEventSource.cs	`85.00% <0.00%> (+10.00%)`	⬆️
... and 2 more

cijothomas · 2022-05-26T17:22:10Z

@Oberon00 Thanks for the PR. I am going to hold off for a week, as we'll be doing 1.3.0 stable very soon, and want to include this to 1.4 series, so as to have some time to gather feedbacks before calling it stable.

alanwest

I like this PR @Oberon00, big improvement! Just have one comment to discuss naming, but otherwise things seem solid.

examples/AspNetCore/Program.cs

alanwest · 2022-05-26T21:43:31Z

docs/logs/customizing-the-sdk/Program.cs

-                options.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(
-                    serviceName: "MyService",
-                    serviceVersion: "1.0.0"));
+                options.ConfigureResources(r => r.AddService(serviceName: "MyService", serviceVersion: "1.0.0"));


We'll need to make sure we follow up with opentelemetry.io docs as well. Quite a few examples using SetResourceBuilder like: https://opentelemetry.io/docs/instrumentation/net/getting-started/#console-application

cijothomas · 2022-06-03T19:39:26Z

@Oberon00 could you fix the conflicts?
We just finished 1.3.0 release, and I am back to reviewing/merging all pending PRs..:)

Oberon00 · 2022-06-04T09:20:51Z

Make sure to change the name (or let me change the name) before releasing if desired.

Oberon00 · 2022-06-14T10:52:43Z

Build failures seem unrelated to this PR.

cijothomas · 2022-06-14T15:34:52Z

@Oberon00 you can close/open the PR (or push a dummy commit) to re-trigger CI.

cijothomas · 2022-06-14T15:35:24Z

D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.publicApi\net462\PublicAPI.Unshipped.txt(2,1): error RS0017: Symbol 'OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ConfigureResources(System.Action<OpenTelemetry.Resources.ResourceBuilder!>! configure) -> OpenTelemetry.Logs.OpenTelemetryLoggerOptions!' is part of the declared API, but is either not public or could not be found [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry\OpenTelemetry.csproj]

^^ This looks like this PR itself. Could you check this?

Oberon00 · 2022-06-20T11:12:46Z

Hopefully I now covered all target frameworks.

cijothomas · 2022-06-27T15:57:09Z

src/OpenTelemetry/Trace/TracerProviderBuilderExtensions.cs

+        /// <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 ConfigureResource(this TracerProviderBuilder tracerProviderBuilder, Action<ResourceBuilder> configure)


Thoughts on the name ConfigureResource vs ConfigureResourceBuilder? @alanwest @Oberon00 ?

Staged up the change in #3411. I'm kind of partial to the shorter name, but open to the name change if others like it.

cijothomas

Looks good overall. I would like to get more thoughts on ConfigureResource vs ConfigureResourceBuilder as the name, but this can be decided before we ship a stable version, so wont block this PR.

* Added Jaeger Propagator to Opentelemetry.Extensions.Propagators (#3309) * Remove unnecessary bullet in CHANGELOG.md (#3352) Co-authored-by: Cijo Thomas <cithomas@microsoft.com> * Fix OTLP test (#3357) * Show that test is not doing what you might think it does * More asserts the merrier * Show this little test that it has potential * improve test coverage: InMemoryExporter & IDeferredMeterProviderBuilder (#3345) * [SDK] Circular buffer tweaks + cpu pressure test (#3349) * CircularBuffer tweaks and cpu pressure test. * Switch to Volatile.Read. * Perf tweaks. * Remove race check in debug after doing more testing. Co-authored-by: Cijo Thomas <cithomas@microsoft.com> * Fix event name logic + support null categoryname. (#3359) * In-memory Exporter: Buffer log scopes (#3360) * Buffer log scopes when using in-memory exporter. * CHANGELOG update. * Code review. * Tests. * CHANGELOG tweak. * SDK: Forward SetParentProvider to children of CompositeProcessor (#3368) * Examples: Fix ParentProvider not being set on MyFilteringProcessor (#3370) * Fix ParentProvider not being set on MyFilteringProcessor example. * Added XML comments. * Tweak. * Typo. * Logs: Add helper ctors & forceflush on OpenTelemetryLoggerProvider (#3364) * Add helper ctors & forceflush on OpenTelemetryLoggerProvider. * CHANGELOG update. * Unit tests. * Code review. * Code review. * Tweak. * SDK: Nullable annotations for base classes & batch + shims to enable compiler features (#3374) * Nullable annotations and shims for SDK base classes & batch. * Target updates. * Remove System.Collections.Immutable ref. * ApiCompat attribute exclusions. * ASPNETCore instrumentation to populate httpflavor tag (#3372) * improve test coverage: InMemoryExporter SnapshotMetric (#3344) * Fix AspNetCore metrics to use correct value for http.flavor (#3379) * Fix AspNetCore metrics to use correct value for http.flavor * word better * Logs: Add LogRecordData (#3378) * Add LogRecordData and hook up to LogRecord. * CHANGELOG update. * Code review. * Remove SetHttpFlavor from Http instrumentations (#3381) * Asp.Net Core trace instrumentation to populate http schema tag (#3392) * Try asp.net core tests with inproc server (#3394) * Dedupe IsPackable (#3398) * Remove AspNet and AspNet.TelemetryHttpModule instrumentation projects (#3397) * Handle possible exception when initializing the default service name (#3405) * HttpClient: Invoke Enrich when SocketException = HostNotFound (#3407) * Add & use ConfigureResource API. (#3307) Co-authored-by: tyler jago <ty_bone11@hotmail.com> Co-authored-by: Robert Pająk <rpajak@splunk.com> Co-authored-by: Cijo Thomas <cithomas@microsoft.com> Co-authored-by: Timothy Mothra <tilee@microsoft.com> Co-authored-by: Mikel Blanchard <mblanchard@macrosssoftware.com> Co-authored-by: Reiley Yang <reyang@microsoft.com> Co-authored-by: Utkarsh Umesan Pillai <utpilla@microsoft.com> Co-authored-by: Christian Neumüller <christian.neumueller@dynatrace.com>

Oberon00 mentioned this pull request May 25, 2022

SetResourceBuilder is overly restrictive, no way to cooperatively initialize Resources #2909

Closed

Oberon00 marked this pull request as ready for review May 25, 2022 16:33

Oberon00 requested a review from a team May 25, 2022 16:33

alanwest approved these changes May 26, 2022

View reviewed changes

examples/AspNetCore/Program.cs Outdated Show resolved Hide resolved

alanwest reviewed May 26, 2022

View reviewed changes

Oberon00 force-pushed the feature/cooperative-resource-init branch from 1834277 to 7d7054d Compare June 20, 2022 11:00

Oberon00 added 8 commits June 20, 2022 13:04

Add & use ConfigureResource API.

89c7cde

Add PR#

32369df

Revert accidentally committed changes by "dotnet format".

cbe9d92

Fix markdownlint.

4e32dc5

Update xmldoc of MeterProviderBuilderExtensions.SetResourceBuilder.

45a4941

Rename ConfigureResources to sg ConfigureResource.

b06808e

Fix net462, rename in sample.

f9b7cad

Add to more missed targets.

d4ba187

Oberon00 force-pushed the feature/cooperative-resource-init branch from 7d7054d to d4ba187 Compare June 20, 2022 11:12

Oberon00 added 2 commits June 23, 2022 17:52

Merge branch 'main' into feature/cooperative-resource-init

d5748b7

Merge branch 'main' into feature/cooperative-resource-init

e8be4f5

cijothomas reviewed Jun 27, 2022

View reviewed changes

cijothomas approved these changes Jun 27, 2022

View reviewed changes

cijothomas merged commit 34efdbf into open-telemetry:main Jun 27, 2022

alanwest mentioned this pull request Jun 27, 2022

Rename ConfigureResource -> ConfigureResourceBuilder #3411

Closed

Oberon00 deleted the feature/cooperative-resource-init branch June 28, 2022 07:17

Oberon00 mentioned this pull request Jul 5, 2022

AWS Lambda wrapper enhancements: Trace methods enhancements and Activity creation behaviour changes. open-telemetry/opentelemetry-dotnet-contrib#408

Merged

CodeBlanch mentioned this pull request Aug 3, 2022

[Logs] Support dependency injection in logging build-up #3504

Merged

3 tasks

CodeBlanch mentioned this pull request Dec 9, 2022

[Logs] Remove ConfigureResource on OpenTelemetryLoggingOptions #3999

Merged

1 task

xiang17 mentioned this pull request Feb 23, 2023

Fix CHANGELOG entry placement #4224

Merged

Oberon00 mentioned this pull request Mar 15, 2023

Removing automatic service name from Lambda instrumentation open-telemetry/opentelemetry-dotnet-contrib#1080

Merged

3 tasks

Conversation

Oberon00 commented May 25, 2022

Changes

Uh oh!

codecov bot commented May 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cijothomas commented May 26, 2022

Uh oh!

alanwest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alanwest May 26, 2022

Choose a reason for hiding this comment

Uh oh!

cijothomas commented Jun 3, 2022

Uh oh!

Oberon00 commented Jun 4, 2022

Uh oh!

Oberon00 commented Jun 14, 2022

Uh oh!

cijothomas commented Jun 14, 2022

Uh oh!

cijothomas commented Jun 14, 2022

Uh oh!

Oberon00 commented Jun 20, 2022

Uh oh!

cijothomas Jun 27, 2022

Choose a reason for hiding this comment

Uh oh!

alanwest Jun 27, 2022

Choose a reason for hiding this comment

Uh oh!

cijothomas left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented May 25, 2022 •

edited

Loading