Add nodejs sdk package #1187

dyladan · 2020-06-11T20:06:47Z

This PR is a ~~WIP~~ SDK package for NodeJS. It exports a configure function which configures a working tracing and metrics SDK. Any configuration can be set using this method, but if configurations are omitted a default configuration will be used.

dyladan · 2020-06-11T20:10:49Z

/cc @open-telemetry/javascript-approvers PTAL

codecov · 2020-06-11T20:16:08Z

Codecov Report

Merging #1187 into master will decrease coverage by 0.24%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##           master    #1187      +/-   ##
==========================================
- Coverage   93.53%   93.28%   -0.25%     
==========================================
  Files         148      149       +1     
  Lines        4144     4200      +56     
  Branches      840      861      +21     
==========================================
+ Hits         3876     3918      +42     
- Misses        268      282      +14

Impacted Files	Coverage Δ
packages/opentelemetry-sdk-node/src/sdk.ts	`75.00% <75.00%> (ø)`

packages/opentelemetry-sdk-node/src/types.ts

packages/opentelemetry-sdk-node/src/index.ts

packages/opentelemetry-sdk-node/README.md

Co-authored-by: Naseem <naseemkullah@gmail.com>

dyladan · 2020-06-19T15:31:45Z

@markwolff PTAL at the new version

vmarchaud

lgtm, it matches pretty much what i've wrote to abstract away sdk initialization at my company

dyladan · 2020-06-23T20:48:41Z

Still working on adding tests and things like that, but I'm going to mark this as ready for reviews.

mayurkale22 · 2020-06-24T06:16:30Z

packages/opentelemetry-sdk-node/README.md

+// You can optionally detect resources asynchronously from the environment.
+// Detected resources are merged with the resources provided in the SDK configuration.
+sdk
+  .autoDetectResources()


I believe resource detection should be integral part of the SDK, I should be available implicitly in the SDK. No extra call required from the users to register it. WDYT?

Resource detection may do some async work so we need some way for users to wait for it. If it is done at construction there is no way to wait for it.

Would having a detectResources flag on NodeSDKConfiguration be a reasonable compromise? If set to true, start would block until they resolved, but it would save the additional API call. I'm neutral as to whether it'd default to true or false.

packages/opentelemetry-sdk-node/src/types.ts

packages/opentelemetry-sdk-node/src/sdk.ts

packages/opentelemetry-sdk-node/package.json

packages/opentelemetry-sdk-node/test/sdk.test.ts

mwear

This looks like it's off to a good start and goes a long way towards simplifying setup. What do you think about having a shutdown method as a central place to flush the export pipeline?

mwear

LGTM modulo the bug with suggested fix in the comments. If we're waiting on other work for the shutdown suggestion (#1187 (review)) it's fine to move forward with this and add it in later.

Thanks for putting this together. It makes setup so much easier!

packages/opentelemetry-sdk-node/LICENSE

packages/opentelemetry-sdk-node/src/sdk.ts

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

obecny

lgtm, just few minor things, not sure why but all files are missing new line in the end of file ?

packages/opentelemetry-sdk-node/LICENSE

packages/opentelemetry-sdk-node/README.md

packages/opentelemetry-sdk-node/src/sdk.ts

packages/opentelemetry-sdk-node/src/types.ts

…etry-js into node-sdk

packages/opentelemetry-metrics/src/index.ts

obecny · 2020-07-27T17:26:53Z

@dyladan can you fix the build so that it can get be merged and released with 0.10 ? it has already all required reviews

* upstream/master: fix: add missing grpc-js index (open-telemetry#1358) chore: 0.10.0 release proposal (open-telemetry#1345) Proto update to latest to support arrays and maps (open-telemetry#1339) feat: add OTEL_LOG_LEVEL env var (open-telemetry#974) Add nodejs sdk package (open-telemetry#1187) feat: add baggage support to the opentracing shim (open-telemetry#918) Removing default span attributes (open-telemetry#1342)

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: 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 (#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 (#918) Co-authored-by: Mayur Kale <mayurkale@google.com> * Add nodejs sdk package (#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 (#974) * Proto update to latest to support arrays and maps (#1339) * chore: 0.10.0 release proposal (#1345) * fix: add missing grpc-js index (#1358) * chore: 0.10.1 release proposal (#1359) * feat(api/context-base): change compile target to es5 (#1368) * Feat: Make ID generator configurable (#1331) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * fix: require grpc-js instead of grpc in grpc-js example (#1364) Co-authored-by: Bartlomiej Obecny <bobecny@gmail.com> * chore(deps): update all non-major dependencies (#1371) * chore: bump metapackage dependencies (#1383) * chore: 0.10.2 proposal (#1382) * fix: remove unnecesary trace provider member function * refactor(metrics): distinguish different aggregator types (#1325) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * Propagate b3 parentspanid and debug flag (#1346) * feat: Export MinMaxLastSumCountAggregator metrics to the collector as Summary (#1320) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * feat: Collector Metric Exporter for the Web (#1308) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * Fix issues in TypeScript getting started example code (#1374) Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> * chore: deploy canary releases (#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>

dyladan added 3 commits June 11, 2020 16:05

feat: add nodejs sdk package

bfbdc3f

chore: set eslint environment

5d05108

Merge branch 'master' into node-sdk

a9588c1

markwolff reviewed Jun 11, 2020

View reviewed changes

packages/opentelemetry-sdk-node/src/types.ts Show resolved Hide resolved

markwolff reviewed Jun 11, 2020

View reviewed changes

packages/opentelemetry-sdk-node/src/index.ts Outdated Show resolved Hide resolved

mwear mentioned this pull request Jun 11, 2020

Consider detecting resources during initialization #1188

Closed

2 tasks

naseemkullah reviewed Jun 12, 2020

View reviewed changes

packages/opentelemetry-sdk-node/README.md Outdated Show resolved Hide resolved

dyladan and others added 3 commits June 12, 2020 08:10

Update packages/opentelemetry-sdk-node/README.md

3d0ab78

Co-authored-by: Naseem <naseemkullah@gmail.com>

Merge remote-tracking branch 'origin/master' into node-sdk

13aacad

refactor: separate sdk configuration and start

acb3a50

dyladan added 5 commits June 19, 2020 11:34

chore: update sdk readme

406988e

chore: markdown lint

7f20ea2

Merge remote-tracking branch 'origin/master' into node-sdk

276a9b2

chore: use tracerConfig

5bbb7b8

chore: start adding tests

54c2a77

vmarchaud reviewed Jun 23, 2020

View reviewed changes

dyladan marked this pull request as ready for review June 23, 2020 20:48

dyladan requested review from bg451, legendecas, mayurkale22, mwear, obecny, OlivierAlbertini and rochdev as code owners June 23, 2020 20:48

mayurkale22 reviewed Jun 24, 2020

View reviewed changes

dyladan changed the title ~~WIP: add nodejs sdk package~~ Add nodejs sdk package Jul 1, 2020

dyladan added 3 commits July 2, 2020 14:05

Merge remote-tracking branch 'origin/master' into node-sdk

f9b5566

chore: document sdk options

d8de20b

chore: fix empty link

4941111

mwear reviewed Jul 7, 2020

View reviewed changes

dyladan added 2 commits July 15, 2020 12:40

Merge branch 'master' into node-sdk

6d18096

chore: add auto detect resources

caa9547

mwear approved these changes Jul 21, 2020

View reviewed changes

packages/opentelemetry-sdk-node/LICENSE Outdated Show resolved Hide resolved

packages/opentelemetry-sdk-node/src/sdk.ts Outdated Show resolved Hide resolved

dyladan and others added 2 commits July 21, 2020 15:42

fix: replace resource with merged resource

ee625a6

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

chore: copyright header

7578e7b

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

obecny approved these changes Jul 22, 2020

View reviewed changes

dyladan added 3 commits July 22, 2020 15:40

chore: make tests pass

c93a6cc

Merge remote-tracking branch 'origin/master' into node-sdk

a41a11d

Merge branch 'node-sdk' of github.com:dynatrace-oss-contrib/opentelem…

f042247

…etry-js into node-sdk

codeboten reviewed Jul 23, 2020

View reviewed changes

packages/opentelemetry-metrics/src/index.ts Outdated Show resolved Hide resolved

dyladan added 2 commits July 23, 2020 16:05

chore: remove double export

1c0b6e4

Merge branch 'master' into node-sdk

6a16c73

vmarchaud approved these changes Jul 25, 2020

View reviewed changes

chore: remove default attributes

6b0e26e

mayurkale22 approved these changes Jul 27, 2020

View reviewed changes

mwear mentioned this pull request Jul 27, 2020

chore: 0.10.0 release proposal #1345

Merged

chore: fix build

a1f65e0

dyladan added the enhancement New feature or request label Jul 27, 2020

dyladan added 2 commits July 27, 2020 13:40

chore: lint

5e1a233

Merge remote-tracking branch 'origin/master' into node-sdk

68f4598

dyladan merged commit 54f1be5 into open-telemetry:master Jul 27, 2020

dyladan deleted the node-sdk branch July 27, 2020 17:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add nodejs sdk package #1187

Add nodejs sdk package #1187

dyladan commented Jun 11, 2020 •

edited by obecny

Loading

dyladan commented Jun 11, 2020

codecov bot commented Jun 11, 2020 •

edited

Loading

dyladan commented Jun 19, 2020

vmarchaud left a comment

dyladan commented Jun 23, 2020

mayurkale22 Jun 24, 2020

dyladan Jul 1, 2020

mwear Jul 15, 2020

mwear left a comment

mwear left a comment

obecny left a comment •

edited

Loading

obecny commented Jul 27, 2020

Add nodejs sdk package #1187

Add nodejs sdk package #1187

Conversation

dyladan commented Jun 11, 2020 • edited by obecny Loading

dyladan commented Jun 11, 2020

codecov bot commented Jun 11, 2020 • edited Loading

Codecov Report

dyladan commented Jun 19, 2020

vmarchaud left a comment

Choose a reason for hiding this comment

dyladan commented Jun 23, 2020

mayurkale22 Jun 24, 2020

Choose a reason for hiding this comment

dyladan Jul 1, 2020

Choose a reason for hiding this comment

mwear Jul 15, 2020

Choose a reason for hiding this comment

mwear left a comment

Choose a reason for hiding this comment

mwear left a comment

Choose a reason for hiding this comment

obecny left a comment • edited Loading

Choose a reason for hiding this comment

obecny commented Jul 27, 2020

dyladan commented Jun 11, 2020 •

edited by obecny

Loading

codecov bot commented Jun 11, 2020 •

edited

Loading

obecny left a comment •

edited

Loading