feat: introduces ability to suppress tracing via context #1344

michaelgoin · 2020-07-23T19:39:43Z

Which problem is this PR solving?

Introduces ability to prevent downstream instrumentation by setting a bool value on the context.
Closes: Use context to stop tracing #1040

Short description of the changes

Introduced helpers for getting/setting the new 'suppressInstrumentation' value.
Updated Tracer to automatically stop span generation, via cached no-op span, when suppressInstrumentation true.
Updated span processors to set context to suppress instrumentation prior to invoking exporters.

I did not tackle updating usages of the header the currently exist. Seemed like those might be better left separate to do in small/safe steps once the mechanism is in place.

There didn't seem to be any obvious/great place for a real-world integration test of this. As such, I introduced some tests that best try to simulate the problem being solved via test helper classes. Its a bit funky but I think captures the problem in an automated fashion. Open to feedback if there are known better approaches.

linux-foundation-easycla · 2020-07-23T19:39:46Z

The committers are authorized under a signed CLA.

✅ Michael Goin (207dfdc, f5d351c, 526a08e)

codecov · 2020-07-23T19:45:28Z

Codecov Report

Merging #1344 into master will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1344      +/-   ##
==========================================
+ Coverage   93.78%   93.80%   +0.02%     
==========================================
  Files         149      149              
  Lines        4524     4539      +15     
  Branches      939      940       +1     
==========================================
+ Hits         4243     4258      +15     
  Misses        281      281

Impacted Files	Coverage Δ
packages/opentelemetry-core/src/context/context.ts	`95.83% <100.00%> (+1.71%)`	⬆️
packages/opentelemetry-tracing/src/Tracer.ts	`100.00% <100.00%> (ø)`
...telemetry-tracing/src/export/BatchSpanProcessor.ts	`92.45% <100.00%> (+0.29%)`	⬆️
...lemetry-tracing/src/export/InMemorySpanExporter.ts	`100.00% <100.00%> (ø)`
...elemetry-tracing/src/export/SimpleSpanProcessor.ts	`85.00% <100.00%> (+2.64%)`	⬆️

packages/opentelemetry-core/src/context/context.ts

packages/opentelemetry-tracing/src/Tracer.ts

dyladan · 2020-07-23T20:00:43Z

packages/opentelemetry-tracing/test/export/TestStackContextManager.ts

+import { ContextManager, Context } from '@opentelemetry/context-base';
+
+/**
+ * A test-only ContextManager that uses an in-memory stack to keep track of


Why not use the existing stack context manager?

That would require adding a dependency to opentelemetry-web only for the purpose of running this test. That seemed even more awkward than this. Or perhaps there's some reorganization that can/should happen?

Hmm, maybe a follow up is to move it into core as there is nothing inherently web-specific about it. For now, it's fine to keep this here I guess.

you can add this dependency in dev dependency, if there will be any changes to context manager the web will never fail again

moving into core would potentially make sense to me. at the time, all the context managers seemed to be in their usage-specific modules so i hesitated to attempt things like that being new, prior to feedback. up for doing that with this PR or separately. i suppose a separate PR might be better for limiting scope of changes/review?

I think this can be handled in follow up

packages/opentelemetry-tracing/test/export/TestTracingSpanExporter.ts

obecny · 2020-07-24T18:43:24Z

is the spec merged and final for that ?

dyladan · 2020-07-24T18:51:26Z

is the spec merged and final for that ?

The spec issue has had no movement and many of the other SIGs have already implemented this type of API.

vmarchaud · 2020-08-15T14:44:54Z

@open-telemetry/javascript-approvers This one is open for 3 weeks now, would be nice to have a couple more reviews in order to move forward so we can remove the header x-opentelemetry-outgoing-request :)

packages/opentelemetry-tracing/test/Tracer.test.ts

packages/opentelemetry-core/test/context/context.test.ts

packages/opentelemetry-tracing/test/export/SimpleSpanProcessor.test.ts

packages/opentelemetry-core/src/context/context.ts

packages/opentelemetry-tracing/src/Tracer.ts

obecny · 2020-08-18T01:27:25Z

packages/opentelemetry-tracing/src/export/InMemorySpanExporter.ts

@@ -25,15 +25,16 @@ import { ExportResult } from '@opentelemetry/core';
 */
 export class InMemorySpanExporter implements SpanExporter {
  private _finishedSpans: ReadableSpan[] = [];
-  private _stopped = false;
+  protected _stopped = false;


please add some doc

@obecny what sort of doc are you looking for?

do you want a comment on why this is protected? that seems like something that would quickly get out of date with future usages, outside of the obvious fact it is now available to classes extending the InMemorySpanExporter.

or are you looking for something else?

If something is protected its meaning should be documented so that when someone subclasses this they know what the property represents. It could be argued it is obvious in this case, but it is good practice in general.

OK. i don't see that done for any other protected members (non-function) in the code base and somewhat debate the value here but am happy to go along with the standards y'all are looking for.

@michaelgoin I agree we haven't been great at being consistent about this, and in many cases the value is questionable anyways.

…ntelemetry-js into suppress-instrumentation

michaelgoin · 2020-08-20T21:01:45Z

@obecny should have everything in order now, if you wanna give another scan. thanks!

dyladan · 2020-08-21T13:46:13Z

@obecny should have everything in order now, if you wanna give another scan. thanks!

He is on vacation until monday. Looks like his concerns are addressed, but maybe @mayurkale22 can give you the second maintainer review in his place here.

dyladan

One minor style suggestion, but otherwise looks good

dyladan · 2020-08-25T18:03:21Z

packages/opentelemetry-core/src/context/context.ts

+  const value = context.getValue(SUPPRESS_INSTRUMENTATION_KEY) as boolean;
+  return !!value;


I would remove the extraneous cast and assignment, but this is minor.

Suggested change

const value = context.getValue(SUPPRESS_INSTRUMENTATION_KEY) as boolean;

return !!value;

return Boolean(context.getValue(SUPPRESS_INSTRUMENTATION_KEY));

I was definitely giving that the side-eye while I was restructuring. Thanks for the extra push. :)

It's probably minor, but since this function is likely to be called a lot, I think the performance benefit alone of skipping the assignment is worth it since you don't really lose anything here.

dyladan · 2020-08-25T18:44:00Z

@obecny this is now split into separate methods suppressInstrumentation and unsuppressInstrumentation.

obecny

split looks great now and is straightforward, thx for these changes :)

michaelgoin added 2 commits July 21, 2020 15:41

feat: introduces ability to suppress tracing via context

207dfdc

feat: span processors prevent exporter span generation

f5d351c

style: lint auto-fix

98acb74

michaelgoin force-pushed the suppress-instrumentation branch from 526a08e to 98acb74 Compare July 23, 2020 19:48

Merge branch 'master' into suppress-instrumentation

c2ac8b4

dyladan reviewed Jul 23, 2020

View reviewed changes

michaelgoin added 5 commits July 24, 2020 10:17

chore: suppressInstrumentation helper updates and cleanup

4d7e5ea

chore: resolve zalgo for InMemory/TracingTest span exporters

9a351ed

Merge branch 'master' into suppress-instrumentation

df7e85d

style: lint auto-fix

d588d4f

Merge branch 'master' into suppress-instrumentation

91d1add

michaelgoin marked this pull request as ready for review July 24, 2020 18:33

michaelgoin requested review from legendecas, markwolff, mayurkale22, mwear, naseemkullah, obecny, OlivierAlbertini and vmarchaud as code owners July 24, 2020 18:33

dyladan mentioned this pull request Jul 31, 2020

feat: add ability to filter grpc methods #1353

Merged

reggiemcdonald mentioned this pull request Aug 3, 2020

feat: use gRPC to write spans to cloud trace GoogleCloudPlatform/opentelemetry-operations-js#97

Merged

dyladan approved these changes Aug 4, 2020

View reviewed changes

dyladan mentioned this pull request Aug 4, 2020

Move stack context manager out of web #1386

Open

vmarchaud approved these changes Aug 4, 2020

View reviewed changes

Merge branch 'master' into suppress-instrumentation

9eb2d5e

dyladan added the enhancement New feature or request label Aug 12, 2020

Merge branch 'master' into suppress-instrumentation

d183bd8

obecny reviewed Aug 18, 2020

View reviewed changes

michaelgoin added 4 commits August 20, 2020 13:09

Merge branch 'master' into suppress-instrumentation

4ff9591

refactor: resolves PR feedback

6bb2eb6

Merge branch 'suppress-instrumentation' of github.com:michaelgoin/ope…

49f53e4

…ntelemetry-js into suppress-instrumentation

Merge branch 'master' into suppress-instrumentation

74a4000

refactor: splits setting of supress instrumentation into two function

2866f51

dyladan approved these changes Aug 25, 2020

View reviewed changes

michaelgoin added 3 commits August 25, 2020 11:04

Merge branch 'master' into suppress-instrumentation

6c81a98

refactor: simplifies isInstrumentationSuppressed boolean handling

cc0249b

style: lint:fix

f125085

obecny approved these changes Aug 25, 2020

View reviewed changes

dyladan merged commit 47f4ce1 into open-telemetry:master Aug 25, 2020

michaelgoin deleted the suppress-instrumentation branch August 25, 2020 18:48

johanneswuerbach mentioned this pull request Sep 7, 2020

Harden AsyncHooksScopeManager regarding faulty use of AsyncResources #591

Closed

vmarchaud mentioned this pull request Sep 19, 2020

chore: remove x-opentelemetry-outgoing-request http header #1547

Closed

aabmass mentioned this pull request Feb 1, 2021

OAuth2 request is not filtered GoogleCloudPlatform/opentelemetry-operations-js#11

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduces ability to suppress tracing via context #1344

feat: introduces ability to suppress tracing via context #1344

michaelgoin commented Jul 23, 2020

linux-foundation-easycla bot commented Jul 23, 2020 •

edited

Loading

codecov bot commented Jul 23, 2020 •

edited

Loading

dyladan Jul 23, 2020

michaelgoin Jul 23, 2020

dyladan Jul 24, 2020

obecny Jul 24, 2020

michaelgoin Jul 24, 2020

dyladan Aug 4, 2020

obecny commented Jul 24, 2020

dyladan commented Jul 24, 2020

vmarchaud commented Aug 15, 2020

obecny Aug 18, 2020

michaelgoin Aug 19, 2020

dyladan Aug 20, 2020

michaelgoin Aug 20, 2020

dyladan Aug 20, 2020

michaelgoin commented Aug 20, 2020

dyladan commented Aug 21, 2020

dyladan left a comment

dyladan Aug 25, 2020

michaelgoin Aug 25, 2020

dyladan Aug 25, 2020

dyladan commented Aug 25, 2020

obecny left a comment •

edited

Loading

		const value = context.getValue(SUPPRESS_INSTRUMENTATION_KEY) as boolean;
		return !!value;

	const value = context.getValue(SUPPRESS_INSTRUMENTATION_KEY) as boolean;
	return !!value;
	return Boolean(context.getValue(SUPPRESS_INSTRUMENTATION_KEY));

feat: introduces ability to suppress tracing via context #1344

feat: introduces ability to suppress tracing via context #1344

Conversation

michaelgoin commented Jul 23, 2020

Which problem is this PR solving?

Short description of the changes

linux-foundation-easycla bot commented Jul 23, 2020 • edited Loading

codecov bot commented Jul 23, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

obecny commented Jul 24, 2020

dyladan commented Jul 24, 2020

vmarchaud commented Aug 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelgoin commented Aug 20, 2020

dyladan commented Aug 21, 2020

dyladan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dyladan commented Aug 25, 2020

obecny left a comment • edited Loading

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Jul 23, 2020 •

edited

Loading

codecov bot commented Jul 23, 2020 •

edited

Loading

obecny left a comment •

edited

Loading