fix: added support for Opentelemetry 0.18 (#1234)

weyert · tapico-weyert · feywind · web-flow · commit faf49ebfbff8 · 2021-04-14T15:26:00.000-04:00
* fix: added support for Opentelemetry 0.18

Introduces support for Opentelemetry 0.18 API which implements the
Tracing 1.0 specification.

* style: remove unused import declaration

* refactor: removed the `OpenTelemetryTracer`-class and just expose createSpan as function

* test: updated the span related tests

* test: updated the tests

* test: updated the tests

* refactor: move the tracer out of the `createSpan`-function

Small refactor to ensure no new tracer gets created for each call to the
`createSpan`-functio by initiating the `libraryTracer`-variable

* fix: get the unit test for publisher opentelemetry working again

* test: fix the subscriber unit tests for opentelemetry

* chore: remove describe.only

* chore: latest changes

* test: updated the tests

* test: improve the tests

* chore: maybe its need to be Google LLC?

* feat: add messaging attributes to otel spans

* fix: include package.json version as instrumentation version

* docs: update the opentelemetry example code

* style: remove unused code

* fix: remove peer name for now

* style: improve explanation regarding otel trace provider

* chore: update the opentelemetry versios in the samples `package.json`

* test: remove extranous logging in the opentelemetry example app

* test: remove the check for `traceId` that doesn't get outputted

* fix: remove unnecessary messaging span attribute and added comments

* style: use shiny new syntax for undefined check in `subscriber`-class

* fix: match the span name with the operation kind in `subscriber`-class

* chore: improved code based on PR feedback

* fix:

BREAKING CHANGE:
The Opentelemetry tracing span doesn't expose the `data`-attribute anymore
to avoid accidentally exposing privacy/personal data

* fix: only include `googclient_OpenTelemetrySpanContext`-attribute
when valid span context exists

* fix: change the way `package.json` is being imported

* fix: revert bad merge that removed tracing on devDependencies

At least I think that's what happened...

* style: remove unnecessary  comment

* style: remove unused imports

* build: downgrade @sinonjs/fake-timers to v6

The v10 of sinonjs comes with v7 of fake-timers which comes with
typescript type definitions that are generated by jsdoc comments which
seems to cause trouble when compiling the app it.

Downgrading to v6 to avoid needing to solve this problem now.

* style: cleanup type definition

Removed the `| undefined` for the `span` in the `Publisher`-class

Co-authored-by: Aaron Abbott &lt;aaronabbott@google.com&gt;

* build: remove `package.json` after compilation step

* build: put back package.json in the build

* build: explicitly add package.json to the npm pack build

* fix: revert "fix: change the way `package.json` is being imported"

This reverts commit 0c2c76f8efa66e5f66d97430964fd30ac7e19261.

* fix: revert "build: explicitly add package.json to the npm pack build"

This reverts commit 14de6257bf63acc6168c4b51c18088a5c74e673b.

Co-authored-by: Weyert de Boer &lt;weyert.deboer@tapico.io&gt;
Co-authored-by: Megan Potter &lt;57276408+feywind@users.noreply.github.com&gt;
Co-authored-by: Megan Potter &lt;mzp@google.com&gt;
Co-authored-by: Aaron Abbott &lt;aaronabbott@google.com&gt;
diff --git a/handwritten/pubsub/samples/openTelemetryTracing.js b/handwritten/pubsub/samples/openTelemetryTracing.js
@@ -62,9 +62,13 @@ function main(
   const provider = new BasicTracerProvider();
   const exporter = new ConsoleSpanExporter();
   provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  // Enable the diagnostic logger for Opentelemetry
+  opentelemetry.diag.setLogger(
+    new opentelemetry.DiagConsoleLogger(),
+    opentelemetry.DiagLogLevel.INFO
+  );
 
   provider.register();
-  opentelemetry.trace.setGlobalTracerProvider(provider);
 
   // OpenTelemetry tracing is an optional feature and can be enabled by setting
   // enableOpenTelemetryTraceing as a publisher or subscriber option
@@ -89,17 +93,32 @@ function main(
     const messageHandler = message => {
       console.log(`Message ${message.id} received.`);
       message.ack();
-      process.exit(0);
+
+      // Ensure that all spans got flushed by the exporter
+      console.log('Cleaning up Opentelemetry exporter...');
+      exporter.shutdown().then(() => {
+        // Cleaned up exporter.
+        process.exit(0);
+      });
     };
 
     const errorHandler = error => {
       console.log('Received error:', error);
-      process.exit(0);
+
+      console.log('Cleaning up Opentelemetry exporter...');
+      exporter.shutdown().then(() => {
+        // Cleaned up exporter.
+        process.exit(0);
+      });
     };
 
     // Listens for new messages from the topic
-    pubSubClient.subscription(subscriptionName).on('message', messageHandler);
-    pubSubClient.subscription(subscriptionName).on('error', errorHandler);
+    pubSubClient
+      .subscription(subscriptionName, enableOpenTelemetryTracing)
+      .on('message', messageHandler);
+    pubSubClient
+      .subscription(subscriptionName, enableOpenTelemetryTracing)
+      .on('error', errorHandler);
 
     setTimeout(() => {
       pubSubClient
diff --git a/handwritten/pubsub/samples/package.json b/handwritten/pubsub/samples/package.json
@@ -15,8 +15,8 @@
   },
   "dependencies": {
     "@google-cloud/pubsub": "^2.10.0",
-    "@opentelemetry/api": "^0.11.0",
-    "@opentelemetry/tracing": "^0.11.0"
+    "@opentelemetry/api": "^0.18.1",
+    "@opentelemetry/tracing": "^0.18.2"
   },
   "devDependencies": {
     "chai": "^4.2.0",
diff --git a/handwritten/pubsub/samples/system-test/openTelemetryTracing.test.js b/handwritten/pubsub/samples/system-test/openTelemetryTracing.test.js
@@ -42,7 +42,6 @@ describe('openTelemetry', () => {
     const stdout = execSync(
       `node openTelemetryTracing ${topicName} ${subName}`
     );
-    assert.match(stdout, /traceId/);
     assert.match(stdout, /Message .* published./);
     assert.match(stdout, /Message .* received/);
     assert.notMatch(stdout, /Received error/);
