chore: more advanced types for sync/async resource #2

dyladan · 2020-08-13T18:40:19Z

This allows the resource on the span to be sync in the export pipeline while allowing it to be async in the tracer and removes the need for casting.

I only did tracing for the example, but the same should be possible for metrics.

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

dyladan · 2020-08-13T18:42:05Z

packages/opentelemetry-tracing/src/Span.ts

@@ -194,6 +190,13 @@ export class Span implements api.Span, ReadableSpan {
    return this._ended;
  }

+  get resource(): Resource {


If the promise is resolved (after _resolveResources completes), then this will act like a regular sync resource to satisfy the ReadableSpan interface.

Imagine the following situation

Resource is provided as promise

Start span

Something is checking for resource, then just started span receives a resource which is Resource.createTelemetrySDKResource()

Resource that was provided as a promise has been just resolved

Span ended - export span

Span is being exported with wrong resource instead of the one provided from promise

Another situation

Resource is provided as promise

Start span

Span ended - export span

Span is being exported with wrong resource instead of the one provided from promise

Resource that was provided as a promise has been just resolved - but previously created span has been already exported with wrong resource

Something is checking for resource

Checking for resource isn't even a part of the public API until we get a "Readable Span", which is not the same as a span. It might be easier if we just send a plain object instead of the actual Span with a getter?

Span is being exported with wrong resource instead of the one provided from promise

No, the export will still have the correct resource as the span will not be sent to the exporter until the resource is resolved, and getters don't cache. Try it if you don't believe me.

Another situation

Span is being exported with wrong resource instead of the one provided from promise

Why? The span isn't actually exported until the resource resolves.

I wrote you a message on gitter 4 days ago, please read :)

D: ok thanks

Too many communication channels to keep track of

* feat: fast span and trace id generation * chore: remove unnecessary buffer alloc * chore: minimize calls to random * chore: lint * chore: check if generated id is invalid (all 0) * chore: unsigned right shift required to guarantee function in range

obecny · 2020-08-13T20:56:18Z

packages/opentelemetry-tracing/src/Span.ts

 import { TraceParams } from './types';

 /**
 * This class represents a span.
 */
-export class Span implements api.Span, ReadableSpan {


why did you remove ReadableSpan ?

It can be added back.

obecny · 2020-08-13T21:04:16Z

packages/opentelemetry-tracing/src/Span.ts

@@ -194,6 +190,13 @@ export class Span implements api.Span, ReadableSpan {
    return this._ended;
  }

+  get resource(): Resource {


Imagine the following situation

Resource is provided as promise

Start span

Something is checking for resource, then just started span receives a resource which is Resource.createTelemetrySDKResource()

Resource that was provided as a promise has been just resolved

Span ended - export span

Span is being exported with wrong resource instead of the one provided from promise

Another situation

Resource is provided as promise

Start span

Span ended - export span

Span is being exported with wrong resource instead of the one provided from promise

Resource that was provided as a promise has been just resolved - but previously created span has been already exported with wrong resource

…-telemetry#1336) Co-authored-by: Mayur Kale <mayurkale@google.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

… UpDownSumObserver (open-telemetry#1428) Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

* feat: graceful shutdown for tracing and metrics * fix: wording in test case * fix: typo * fix meterprovider config to use bracket notation Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix meterprovider config to use bracket notation Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix: add callbacks to shutdown methods * fix: merge conflict * simplify meter shutdown code Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix: fix one-liner * private function name style fix Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix: naming of private member variables * fix: graceful shutdown now works in browser * fix: window event listener will trigger once * fix: modify global shutdown helper functions * fix: remove callback from remove listener args * fix: change global shutdown function names and simplify functionality * fix: add rest of function refactoring and simplification * fix: remove unintended code snippet * fix: refactor naming of listener cleanup function and fix sandbox issue * fix: make global shutdown cleanup local * fix: change interval of MeterProvider collection to ensure it does not trigger through clock * chore: removing _cleanupGlobalShutdownListeners * fix: remove unnecesary trace provider member function * Removing default span attributes (open-telemetry#1342) * refactor(opentelemetry-tracing): removing default span attributes Signed-off-by: Aravin Sivakumar <aravinarjunn@gmail.com> * refactor(opentelemetry-tracing): removing default span attributed from tracer object Signed-off-by: Aravin Sivakumar <aravinarjunn@gmail.com> * refactor(opentelemetry-tracing): removing accidental add to package.json Signed-off-by: Aravin Sivakumar <aravinarjunn@gmail.com> * refactor(opentelemetry-tracing): removing redundant test and fixing suggestions by Shawn and Daniel Signed-off-by: Aravin Sivakumar <aravinarjunn@gmail.com> * feat: add baggage support to the opentracing shim (open-telemetry#918) Co-authored-by: Mayur Kale <mayurkale@google.com> * Add nodejs sdk package (open-telemetry#1187) Co-authored-by: Naseem <naseemkullah@gmail.com> Co-authored-by: legendecas <legendecas@gmail.com> Co-authored-by: Mark Wolff <mrw00010@gmail.com> Co-authored-by: Matthew Wear <matthew.wear@gmail.com> * feat: add OTEL_LOG_LEVEL env var (open-telemetry#974) * Proto update to latest to support arrays and maps (open-telemetry#1339) * chore: 0.10.0 release proposal (open-telemetry#1345) * fix: add missing grpc-js index (open-telemetry#1358) * chore: 0.10.1 release proposal (open-telemetry#1359) * feat(api/context-base): change compile target to es5 (open-telemetry#1368) * Feat: Make ID generator configurable (open-telemetry#1331) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix: require grpc-js instead of grpc in grpc-js example (open-telemetry#1364) Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> * chore(deps): update all non-major dependencies (open-telemetry#1371) * chore: bump metapackage dependencies (open-telemetry#1383) * chore: 0.10.2 proposal (open-telemetry#1382) * fix: remove unnecesary trace provider member function * refactor(metrics): distinguish different aggregator types (open-telemetry#1325) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * Propagate b3 parentspanid and debug flag (open-telemetry#1346) * feat: Export MinMaxLastSumCountAggregator metrics to the collector as Summary (open-telemetry#1320) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * feat: Collector Metric Exporter for the Web (open-telemetry#1308) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * Fix issues in TypeScript getting started example code (open-telemetry#1374) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * chore: deploy canary releases (open-telemetry#1384) * fix: protos pull * fix: address marius' feedback * chore: deleting removeAllListeners from prometheus, fixing tests, cleanu of events when using shutdown notifier * fix: add documentation and cleanup code * fix: remove async label from shutdown and cleanup test case * fix: update controller collect to return promise * fix: make downsides of disabling graceful shutdown more apparent Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Aravin <34178459+aravinsiva@users.noreply.github.com> Co-authored-by: Ruben Vargas Palma <ruben.vp8510@gmail.com> Co-authored-by: Mayur Kale <mayurkale@google.com> Co-authored-by: Naseem <naseemkullah@gmail.com> Co-authored-by: legendecas <legendecas@gmail.com> Co-authored-by: Mark Wolff <mrw00010@gmail.com> Co-authored-by: Matthew Wear <matthew.wear@gmail.com> Co-authored-by: Naseem <naseem@transit.app> Co-authored-by: Mark Wolff <mark.wolff@microsoft.com> Co-authored-by: Cong Zou <32532612+EdZou@users.noreply.github.com> Co-authored-by: Reginald McDonald <40721169+reggiemcdonald@users.noreply.github.com> Co-authored-by: WhiteSource Renovate <bot@renovateapp.com> Co-authored-by: srjames90 <srjames@lightstep.com> Co-authored-by: David W <dwitt12345@gmail.com> Co-authored-by: Mick Dekkers <mickdekkersnl@gmail.com>

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com>

…n-telemetry#1408) * feat: temporarily added EC2 resource detector * feat: update EC2 Resource Detector to IDMSv2 and modified detect-resource * chore: fix weird package dependency changing * chore: add final line for packages * chore: modify descriptive type for _fetchString options * chore: remove unused variables * chore: modified test name * refactor: replace request header with constant variables * chore: modify comment * refactor: remove HTTP_HEADER constant * refactor: make time out value constant * chore: revise the naming to IMDSv2 Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

…rotocolNode (open-telemetry#1432)

…metry#1366) Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

* chore: removing submodule protos from exporter-collector * chore: adding submodule opentelemetry-proto to exporter collector * chore: fixing submodule path * chore: updating proto to version v0.4.0 * chore: splitting exporter collector into 3 packages - depending on transport layer, updated examples, fixed the metrics collector for proto, fixed bug for label * chore: fixing bug with controller when shutting down * chore: ignored files * chore: fixing submodule links * chore: lint fixes - seems like some latest updates forcing extend to be in new line * chore: lint space * chore: fixing test when waiting to load proto files

* feat: adding possibility of recording exception * chore: copy * chore: copy * chore: linting * chore: reviews * chore: updating exception type * chore: reviews * chore: reviews * chore: fixing test when waiting for files to be loaded

Co-authored-by: Mayur Kale <mayurkale@google.com>

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

…try#1344) Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

…ered (open-telemetry#1448)

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

Co-authored-by: Bradley Behnke <bradley_behnke@intuit.com>

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

* refactor: make spanContext into class with isValid * refactor: use class instantiation for spanContext * refactor: moves test and fix tests * fix: add check for isValid * revert: the changes to spanContext * refactor: move spancontext-utils to api package * fix: lint and invalid psan id and invalid trace id * fix: make isValid more robust * refactor: rename isValid to isSpanContextValid * refactor: update regex and checks * fix: export isSpanContextValid from api.trace * fix: run npm run lint:fix * fix: run lint fix in api * refactor: prevent function overhead * fix: lint * fix: remove unused import Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

)

dyladan · 2020-09-02T15:24:51Z

Closed for open-telemetry#1484

sergioregueira and others added 3 commits August 13, 2020 12:57

docs: fix broken links to pg and pg-pool plugins (open-telemetry#1421)

799fdfb

Pass W3C Trace Context test suite at strictness 1 (open-telemetry#1406)

b368d32

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

chore: more advanced types for sync/async resource

8f876a3

dyladan requested a review from obecny as a code owner August 13, 2020 18:40

dyladan mentioned this pull request Aug 13, 2020

chore: refactoring sdk start so that it can be a real sync open-telemetry/opentelemetry-js#1400

Closed

dyladan commented Aug 13, 2020

View reviewed changes

dyladan added 2 commits August 13, 2020 14:46

chore: lint

cc645c3

obecny reviewed Aug 13, 2020

View reviewed changes

renovate-bot and others added 21 commits August 14, 2020 11:02

chore(deps): update all non-major dependencies (open-telemetry#1424)

f612922

fix: correlation context propagation extract for a single entry (open…

8224e1f

…-telemetry#1336) Co-authored-by: Mayur Kale <mayurkale@google.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Add mapping for 499 http status (open-telemetry#1418)

644edc3

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

chore: relax review guidelines by 1 (open-telemetry#1430)

4f991d0

fix(deps): pin dependencies (open-telemetry#1423)

da0287c

chore!: refer to resource labels as attributes (open-telemetry#1419)

27e6c2d

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Fix typo in document. (open-telemetry#1431)

cb58e7a

feat: Add missing prometheus exports for ValueRecorder, SumObserver &…

2916ecf

… UpDownSumObserver (open-telemetry#1428) Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

chore: fix histogram type documentation (open-telemetry#1427)

d511a0e

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

chore(deps): update dependency superagent to v6 (open-telemetry#1425)

739462d

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com>

docs(exporter-jaeger): add "for Node.js" (open-telemetry#1434)

f402596

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Fix canary builds (open-telemetry#1437)

6412688

chore: apply sync resource types to metrics

b6f0208

refactor: separate resource detector packages (open-telemetry#1420)

d68ff0f

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

fix: add Hapi and Koa to default supported plugins (open-telemetry#1440)

ddd84ff

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

docs(exporter-collector): CollectorTransportNode should be CollectorP…

a3357d5

…rotocolNode (open-telemetry#1432)

fix: ignore non-number value on BaseBoundInstrument.update (open-tele…

a576c3f

…metry#1366) Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

feat: add ability to filter grpc methods (open-telemetry#1353)

b2eedfb

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

feat: added AWS Beanstalk Plugins Resource Detector (open-telemetry#1385

2a8555f

) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

obecny and others added 16 commits August 24, 2020 18:34

docs: change documentation URL (open-telemetry#1460)

7ef38a1

Co-authored-by: Mayur Kale <mayurkale@google.com>

refactor: rename HttpText to TextMap propagator (open-telemetry#1458)

d8bff27

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

feat: introduces ability to suppress tracing via context (open-teleme…

47f4ce1

…try#1344) Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

feat: prometheus serializer (open-telemetry#1310)

53f0654

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

Merge remote-tracking branch 'origin/master' into sdk_sync_types

03a8ee1

feat(backcompat): @types/node backcompat tests (open-telemetry#1352)

2052a24

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

feat: tracers provided by the API become useable when provider regist…

5c7753f

…ered (open-telemetry#1448)

Fix PerformanceResource finding with relative URLs (open-telemetry#1389)

e440d5e

Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

fix: proper histogram boundaries sort (open-telemetry#1475)

c5294ba

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

chore: bump gcp-metadata (open-telemetry#1469)

40242ae

Co-authored-by: Bradley Behnke <bradley_behnke@intuit.com>

Align xhr span name with spec (open-telemetry#1476)

a7a6b7f

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

fix: updates ValueRecorder to allow negative values (open-telemetry#1373

cb6555a

)

Merge remote-tracking branch 'origin/master' into sdk_sync_types

c06f31e

dyladan closed this Sep 2, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: more advanced types for sync/async resource #2

chore: more advanced types for sync/async resource #2

dyladan commented Aug 13, 2020

dyladan Aug 13, 2020

obecny Aug 13, 2020

dyladan Aug 14, 2020

dyladan Aug 18, 2020

obecny Aug 18, 2020

dyladan Aug 18, 2020

obecny Aug 13, 2020

dyladan Aug 14, 2020

obecny Aug 13, 2020

dyladan commented Sep 2, 2020

chore: more advanced types for sync/async resource #2

chore: more advanced types for sync/async resource #2

Conversation

dyladan commented Aug 13, 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

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 Sep 2, 2020