feat: Collector Metric Exporter for the Web #1308

davidwitten · 2020-07-13T19:21:33Z

Summary

This PR addresses Issue #1109.

Currently, the Collector Exporter only sends traces to the collector. In Python, Java, and Go, for example, metric exporting already exists for the collector. This PR adds that feature. I created two versions, one for Node and the other for browser. The node version uses gRPC, and the browser uses Beacon or XHR. It's up to date with all previous collector exporter commits.

What this PR does

This is the 6th part of this long PR.

Note: Please review this PR first

I previously did some refactoring, which, when merged, would greatly simplify this PR.

This PR creates a CollectorMetricExporter.ts file that is almost identical to the CollectorTraceExporter.ts.

Testing

I created unit tests and I E2E tested exporting metrics with a sample application connected to Google Cloud Monitoring.

Next Steps

I will be pushing a PR to create the Node version of this exporter in parallel. Once both are merged, I will submit an example project.

codecov · 2020-07-13T19:26:05Z

Codecov Report

Merging #1308 into master will increase coverage by 0.25%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1308      +/-   ##
==========================================
+ Coverage   93.77%   94.03%   +0.25%     
==========================================
  Files         149      149              
  Lines        4322     4322              
  Branches      880      880              
==========================================
+ Hits         4053     4064      +11     
+ Misses        269      258      -11

Impacted Files	Coverage Δ
...lemetry-exporter-collector/src/transformMetrics.ts	`95.69% <0.00%> (+11.82%)`	⬆️

davidwitten · 2020-07-15T15:52:20Z

Please review the Node PR first, as this one depends on the other one.

davidwitten · 2020-07-29T17:58:56Z

Added example and verified that it works on my computer

examples/collector-exporter-node/docker/docker-compose.yaml

examples/collector-exporter-node/start.js

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorExporterBrowserBase.ts

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorMetricExporter.ts

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorExporterBrowserBase.ts

dyladan · 2020-08-04T18:16:31Z

@open-telemetry/javascript-approvers Please take a look as this PR has been open for quite a while.

In particular I would like @obecny's approval on this as you have been active on David's other PRs and you wrote the original OTLP exporter.

obecny

lgtm, great work David, one comment

examples/collector-exporter-node/package.json

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 (#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>

davidwitten added 6 commits July 10, 2020 22:17

Merged from upstream

7482b43

Add test

b02949a

Basic node

5bd4fef

Tests and functions

a002c1d

minor

1d28df4

new line

cf100b3

davidwitten requested review from dyladan, legendecas, markwolff, mayurkale22, mwear, naseemkullah, obecny, OlivierAlbertini and vmarchaud as code owners July 13, 2020 19:21

davidwitten changed the title ~~feat: Collector Exporter for the Web~~ feat: Collector Metric Exporter for the Web Jul 13, 2020

davidwitten added 6 commits July 13, 2020 20:17

DefaultURL

6a3e948

Add JSON tests

4eb3831

Test rename

547e63b

Refactor a lot

b08de2c

Restored those files

dffc3dd

Variable anme

9c9abae

dyladan added the release:required-for-ga label Jul 15, 2020

davidwitten added 2 commits July 15, 2020 15:16

Merge remote-tracking branch 'upstream/master' into browser

589a0e1

Duplicate test

6c98095

davidwitten added 2 commits July 15, 2020 18:30

Fixed strings

0ecb031

Changed metrics to functions and added summary

629fa50

davidwitten added 2 commits July 29, 2020 17:36

merged

e61e809

Newline

765ddfa

davidwitten added 2 commits July 29, 2020 15:58

feat: simplified example

10236ee

chore: merge

44eab55

obecny reviewed Jul 31, 2020

View reviewed changes

examples/collector-exporter-node/docker/docker-compose.yaml Show resolved Hide resolved

obecny reviewed Jul 31, 2020

View reviewed changes

examples/collector-exporter-node/start.js Outdated Show resolved Hide resolved

davidwitten added 3 commits July 31, 2020 08:33

chore: rename start

21c9e8b

refactor: split up files

a8857d3

fix: lint

15de18b

dyladan reviewed Jul 31, 2020

View reviewed changes

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorExporterBrowserBase.ts Outdated Show resolved Hide resolved

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorMetricExporter.ts Show resolved Hide resolved

fix: add comments

175e050

davidwitten requested review from obecny and dyladan August 3, 2020 16:09

dyladan reviewed Aug 3, 2020

View reviewed changes

packages/opentelemetry-exporter-collector/src/platform/browser/CollectorExporterBrowserBase.ts Outdated Show resolved Hide resolved

fix: private

e526e11

dyladan approved these changes Aug 4, 2020

View reviewed changes

Merge branch 'master' into browser

6d3a080

obecny approved these changes Aug 4, 2020

View reviewed changes

examples/collector-exporter-node/package.json Outdated Show resolved Hide resolved

davidwitten added 3 commits August 4, 2020 19:16

Merge remote-tracking branch 'upstream/master' into browser

d29be93

fix: readme

ccedacc

Merged

775d2a4

naseemkullah approved these changes Aug 5, 2020

View reviewed changes

dyladan added the Internship Ending Soon label Aug 5, 2020

dyladan merged commit 2af2d0c into open-telemetry:master Aug 5, 2020

jonahrosenblum pushed a commit to jonahrosenblum/opentelemetry-js that referenced this pull request Aug 8, 2020

feat: Collector Metric Exporter for the Web (open-telemetry#1308)

4d92d39

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Collector Metric Exporter for the Web #1308

feat: Collector Metric Exporter for the Web #1308

davidwitten commented Jul 13, 2020 •

edited

Loading

codecov bot commented Jul 13, 2020 •

edited

Loading

davidwitten commented Jul 15, 2020

davidwitten commented Jul 29, 2020 •

edited

Loading

dyladan commented Aug 4, 2020

obecny left a comment

feat: Collector Metric Exporter for the Web #1308

feat: Collector Metric Exporter for the Web #1308

Conversation

davidwitten commented Jul 13, 2020 • edited Loading

Summary

What this PR does

Note: Please review this PR first

Testing

Next Steps

codecov bot commented Jul 13, 2020 • edited Loading

Codecov Report

davidwitten commented Jul 15, 2020

davidwitten commented Jul 29, 2020 • edited Loading

dyladan commented Aug 4, 2020

obecny left a comment

Choose a reason for hiding this comment

davidwitten commented Jul 13, 2020 •

edited

Loading

codecov bot commented Jul 13, 2020 •

edited

Loading

davidwitten commented Jul 29, 2020 •

edited

Loading