grpc for node and support for new proto format for node and brow… (#901)

* feat: send data using grpc for collector exporter * chore: proto submodule * chore: using new proto format for browser * chore: fixing submodule * chore: adding protos submodule * chore: cleanup * chore: cleanup * chore: adding sync for submodule * chore: testing submodule * chore: updating submodule for opentelemetry-proto * chore: updates and fixes after testing with collector, refactored helper for tests * chore: reviews * chore: removing TruncatableString * chore: reviews
open-telemetry · Apr 9, 2020 · 30200a5 · 30200a5
1 parent 43bb5a4
commit 30200a5
Show file tree

Hide file tree

Showing 17 changed files with 1,185 additions and 1,126 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "packages/opentelemetry-exporter-collector/src/platform/node/protos"]
+	path = packages/opentelemetry-exporter-collector/src/platform/node/protos
+	url = git@github.com:open-telemetry/opentelemetry-proto.git
diff --git a/packages/opentelemetry-exporter-collector/README.md b/packages/opentelemetry-exporter-collector/README.md
@@ -37,6 +37,7 @@ const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tra
 const { CollectorExporter } =  require('@opentelemetry/exporter-collector');
 
 const collectorOptions = {
+  serviceName: 'basic-service',
   url: '<opentelemetry-collector-url>' // url is optional and can be omitted - default is http://localhost:55678/v1/trace
 };
 

diff --git a/packages/opentelemetry-exporter-collector/package.json b/packages/opentelemetry-exporter-collector/package.json
@@ -16,13 +16,16 @@
     "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
     "precompile": "tsc --version",
     "compile": "npm run version:update && tsc -p .",
+    "postcompile": "npm run submodule && npm run protos:copy",
     "prepare": "npm run compile",
+    "protos:copy": "cpx src/platform/node/protos/opentelemetry/**/*.* build/src/platform/node/protos/opentelemetry",
+    "submodule": "git submodule sync --recursive && git submodule update --init --recursive",
     "tdd": "npm run test -- --watch-extensions ts --watch",
     "tdd:browser": "karma start",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts' --exclude 'test/browser/**/*.ts'",
     "test:browser": "nyc karma start --single-run",
     "version:update": "node ../../scripts/version-update.js",
-    "watch": "tsc -w"
+    "watch": "npm run protos:copy && tsc -w"
   },
   "keywords": [
     "opentelemetry",
@@ -56,6 +59,7 @@
     "@types/webpack-env": "1.13.9",
     "babel-loader": "^8.0.6",
     "codecov": "^3.1.0",
+    "cpx": "^1.5.0",
     "gts": "^1.0.0",
     "istanbul-instrumenter-loader": "^3.0.1",
     "karma": "^4.4.1",
@@ -79,10 +83,13 @@
     "webpack-merge": "^4.2.2"
   },
   "dependencies": {
+    "@grpc/proto-loader":  "^0.5.3",
     "@opentelemetry/api": "^0.6.1",
     "@opentelemetry/base": "^0.6.1",
     "@opentelemetry/core": "^0.6.1",
     "@opentelemetry/resources": "^0.6.1",
-    "@opentelemetry/tracing": "^0.6.1"
+    "@opentelemetry/tracing": "^0.6.1",
+    "google-protobuf": "^3.11.4",
+    "grpc": "^1.24.2"
   }
 }
diff --git a/packages/opentelemetry-exporter-collector/src/CollectorExporter.ts b/packages/opentelemetry-exporter-collector/src/CollectorExporter.ts
@@ -18,10 +18,8 @@ import { ExportResult } from '@opentelemetry/base';
 import { NoopLogger } from '@opentelemetry/core';
 import { ReadableSpan, SpanExporter } from '@opentelemetry/tracing';
 import { Attributes, Logger } from '@opentelemetry/api';
-import * as collectorTypes from './types';
-import { toCollectorSpan, toCollectorResource } from './transform';
 import { onInit, onShutdown, sendSpans } from './platform/index';
-import { Resource } from '@opentelemetry/resources';
+import { opentelemetryProto } from './types';
 
 /**
  * Collector Exporter Config
@@ -65,7 +63,7 @@ export class CollectorExporter implements SpanExporter {
     this.shutdown = this.shutdown.bind(this);
 
     // platform dependent
-    onInit(this.shutdown);
+    onInit(this);
   }
 
   /**
@@ -81,33 +79,34 @@ export class CollectorExporter implements SpanExporter {
       resultCallback(ExportResult.FAILED_NOT_RETRYABLE);
       return;
     }
+
     this._exportSpans(spans)
       .then(() => {
         resultCallback(ExportResult.SUCCESS);
       })
-      .catch((status: number = 0) => {
-        if (status < 500) {
-          resultCallback(ExportResult.FAILED_NOT_RETRYABLE);
-        } else {
-          resultCallback(ExportResult.FAILED_RETRYABLE);
+      .catch(
+        (
+          error: opentelemetryProto.collector.trace.v1.ExportTraceServiceError
+        ) => {
+          if (error.message) {
+            this.logger.error(error.message);
+          }
+          if (error.code && error.code < 500) {
+            resultCallback(ExportResult.FAILED_NOT_RETRYABLE);
+          } else {
+            resultCallback(ExportResult.FAILED_RETRYABLE);
+          }
         }
-      });
+      );
   }
 
   private _exportSpans(spans: ReadableSpan[]): Promise<unknown> {
     return new Promise((resolve, reject) => {
       try {
-        const spansToBeSent: collectorTypes.Span[] = spans.map(span =>
-          toCollectorSpan(span)
-        );
-        this.logger.debug('spans to be sent', spansToBeSent);
-        const resource = toCollectorResource(
-          spansToBeSent.length > 0 ? spans[0].resource : Resource.empty()
-        );
-
+        this.logger.debug('spans to be sent', spans);
         // Send spans to [opentelemetry collector]{@link https://github.com/open-telemetry/opentelemetry-collector}
         // it will use the appropriate transport layer automatically depends on platform
-        sendSpans(spansToBeSent, resolve, reject, this, resource);
+        sendSpans(spans, resolve, reject, this);
       } catch (e) {
         reject(e);
       }
@@ -126,6 +125,6 @@ export class CollectorExporter implements SpanExporter {
     this.logger.debug('shutdown started');
 
     // platform dependent
-    onShutdown(this.shutdown);
+    onShutdown(this);
   }
 }
diff --git a/packages/opentelemetry-exporter-collector/src/platform/browser/sendSpans.ts b/packages/opentelemetry-exporter-collector/src/platform/browser/sendSpans.ts
@@ -1,5 +1,5 @@
 /*!
- * Copyright 2019, OpenTelemetry Authors
+ * Copyright 2020, OpenTelemetry Authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,26 +14,26 @@
  * limitations under the License.
  */
 
-import * as core from '@opentelemetry/core';
 import { Logger } from '@opentelemetry/api';
+import { ReadableSpan } from '@opentelemetry/tracing';
 import { CollectorExporter } from '../../CollectorExporter';
+import { toCollectorExportTraceServiceRequest } from '../../transform';
 import * as collectorTypes from '../../types';
-import { VERSION } from '../../version';
 
 /**
  * function that is called once when {@link ExporterCollector} is initialised
- * @param shutdownF shutdown method of {@link ExporterCollector}
+ * @param collectorExporter CollectorExporter {@link ExporterCollector}
  */
-export function onInit(shutdownF: EventListener) {
-  window.addEventListener('unload', shutdownF);
+export function onInit(collectorExporter: CollectorExporter) {
+  window.addEventListener('unload', collectorExporter.shutdown);
 }
 
 /**
  * function to be called once when {@link ExporterCollector} is shutdown
- * @param shutdownF - shutdown method of {@link ExporterCollector}
+ * @param collectorExporter CollectorExporter {@link ExporterCollector}
  */
-export function onShutdown(shutdownF: EventListener) {
-  window.removeEventListener('unload', shutdownF);
+export function onShutdown(collectorExporter: CollectorExporter) {
+  window.removeEventListener('unload', collectorExporter.shutdown);
 }
 
 /**
@@ -43,34 +43,17 @@ export function onShutdown(shutdownF: EventListener) {
  * @param onSuccess
  * @param onError
  * @param collectorExporter
- * @param resource
  */
 export function sendSpans(
-  spans: collectorTypes.Span[],
+  spans: ReadableSpan[],
   onSuccess: () => void,
-  onError: (status?: number) => void,
-  collectorExporter: CollectorExporter,
-  resource: collectorTypes.Resource
+  onError: (error: collectorTypes.CollectorExporterError) => void,
+  collectorExporter: CollectorExporter
 ) {
-  const exportTraceServiceRequest: collectorTypes.ExportTraceServiceRequest = {
-    node: {
-      identifier: {
-        hostName: collectorExporter.hostName || window.location.host,
-        startTimestamp: core.hrTimeToTimeStamp(core.hrTime()),
-      },
-      libraryInfo: {
-        language: collectorTypes.LibraryInfoLanguage.WEB_JS,
-        coreLibraryVersion: core.VERSION,
-        exporterVersion: VERSION,
-      },
-      serviceInfo: {
-        name: collectorExporter.serviceName,
-      },
-      attributes: collectorExporter.attributes,
-    },
-    resource,
+  const exportTraceServiceRequest = toCollectorExportTraceServiceRequest(
     spans,
-  };
+    collectorExporter
+  );
 
   const body = JSON.stringify(exportTraceServiceRequest);
 
@@ -104,7 +87,7 @@ export function sendSpans(
 function sendSpansWithBeacon(
   body: string,
   onSuccess: () => void,
-  onError: (status?: number) => void,
+  onError: (error: collectorTypes.CollectorExporterError) => void,
   logger: Logger,
   collectorUrl: string
 ) {
@@ -113,7 +96,7 @@ function sendSpansWithBeacon(
     onSuccess();
   } else {
     logger.error('sendBeacon - cannot send', body);
-    onError();
+    onError({});
   }
 }
 
@@ -129,13 +112,15 @@ function sendSpansWithBeacon(
 function sendSpansWithXhr(
   body: string,
   onSuccess: () => void,
-  onError: (status?: number) => void,
+  onError: (error: collectorTypes.CollectorExporterError) => void,
   logger: Logger,
   collectorUrl: string
 ) {
   const xhr = new XMLHttpRequest();
   xhr.open('POST', collectorUrl);
   xhr.setRequestHeader(collectorTypes.OT_REQUEST_HEADER, '1');
+  xhr.setRequestHeader('Accept', 'application/json');
+  xhr.setRequestHeader('Content-Type', 'application/json');
   xhr.send(body);
 
   xhr.onreadystatechange = () => {
@@ -144,8 +129,12 @@ function sendSpansWithXhr(
         logger.debug('xhr success', body);
         onSuccess();
       } else {
-        logger.error('xhr error', xhr.status, body);
-        onError(xhr.status);
+        logger.error('body', body);
+        logger.error('xhr error', xhr);
+        onError({
+          code: xhr.status,
+          message: xhr.responseText,
+        });
       }
     }
   };

diff --git a/packages/opentelemetry-exporter-collector/src/platform/node/README.md b/packages/opentelemetry-exporter-collector/src/platform/node/README.md
@@ -0,0 +1,45 @@
+### Important!
+**Submodule is always pointing to certain revision number. So updating the master of the submodule repo will not have impact on your code.
+Knowing this if you want to change the submodule to point to a different version (when for example proto has changed) here is how to do it:**
+
+### Updating submodule to point to certain revision number
+
+1. Make sure you are in the same folder as this instruction
+
+2. Update your submodules by running this command
+
+```shell script
+    git submodule sync --recursive
+    git submodule update --init --recursive
+```
+
+3. Find the SHA which you want to update to and copy it (the long one)
+the latest sha when this guide was written is `e6c3c4a74d57f870a0d781bada02cb2b2c497d14`
+
+4. Enter a submodule directory from this directory
+
+```shell script
+  cd protos
+```
+
+5. Updates files in the submodule tree to given commit:
+
+```shell script
+  git checkout -q <sha>
+```
+
+6. Return to the main directory:
+
+```shell script
+  cd ../
+```
+
+7. Please run `git status` you should see something like `Head detached at`. This is correct, go to next step
+
+8. Now thing which is very important. You have to commit this to apply these changes
+
+```shell script
+  git commit -am "chore: updating submodule for opentelemetry-proto"
+```
+
+9. If you look now at git log you will notice that the folder `protos` has been changed and it will show what was the previous sha and what is current one
diff --git a/packages/opentelemetry-exporter-collector/src/platform/node/protos b/packages/opentelemetry-exporter-collector/src/platform/node/protos