Collector exporter

examples/basic-tracer-node/README.md

@@ -13,6 +13,9 @@ $ npm install
 Setup [Zipkin Tracing](https://zipkin.io/pages/quickstart.html)
 or
 Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one)
+or
+Setup [Collector Exporter](https://github.com/open-telemetry/opentelemetry-exporter-collector)
+
 
 ## Run the Application
 
@@ -57,6 +60,22 @@ Click on the trace to view its details.
 
 <p align="center"><img src="./images/jaeger-ui-detail.png?raw=true"/></p>
 
+### Collector Exporter
+Make sure you have [docker](https://docs.docker.com/) installed
+ - Run the docker container
+   ```sh
+   $ # from this directory
+   $ # open telemetry
+   $ npm run collector:docker:ot
+   $ # or alternatively open census
+   $ npm run collector:docker:oc
+   $ # at any time you can stop & clean them
+   $ npm run collector:docker:stop
+   ```
+
+#### Collector Exporter - Zipkin UI
+Please follow the section [Zipkin UI](#zipkin-ui) only
+
 ### Export to multiple exporters
 
  - Run the sample

examples/basic-tracer-node/docker/oc/collector-config.yaml

@@ -0,0 +1,7 @@
+receivers:
+  opencensus:
+    address: "127.0.0.1:55678"
+
+exporters:
+  zipkin:
+    endpoint: "http://zipkin-all-in-one:9411/api/v2/spans"

examples/basic-tracer-node/docker/oc/docker-compose.yaml

@@ -0,0 +1,19 @@
+version: "2"
+services:
+
+  # Collector
+  collector:
+    image: omnition/opencensus-collector
+    command: ["--config=/conf/collector-config.yaml", "--http-pprof-port=1777", "--receive-zipkin", "--receive-oc-trace", "--log-level=DEBUG"]
+    volumes:
+      - ./collector-config.yaml:/conf/collector-config.yaml
+    ports:
+      - "55678:55678"
+    depends_on:
+      - zipkin-all-in-one
+
+  # Zipkin
+  zipkin-all-in-one:
+    image: openzipkin/zipkin:latest
+    ports:
+      - "9411:9411"

examples/basic-tracer-node/docker/ot/collector-config.yaml

@@ -0,0 +1,18 @@
+receivers:
+  opencensus:
+    endpoint: 0.0.0.0:55678
+
+exporters:
+  zipkin:
+    url: "http://zipkin-all-in-one:9411/api/v2/spans"
+
+processors:
+  batch:
+  queued_retry:
+
+service:
+  pipelines:
+    traces:
+      receivers: [opencensus]
+      exporters: [zipkin]
+      processors: [batch, queued_retry]

examples/basic-tracer-node/docker/ot/docker-compose.yaml

@@ -0,0 +1,19 @@
+version: "2"
+services:
+
+  # Collector
+  collector:
+    image: otelcol:latest
+    command: ["--config=/conf/collector-config.yaml", "--log-level=DEBUG"]
+    volumes:
+      - ./collector-config.yaml:/conf/collector-config.yaml
+    ports:
+      - "55678:55678"
+    depends_on:
+      - zipkin-all-in-one
+
+  # Zipkin
+  zipkin-all-in-one:
+    image: openzipkin/zipkin:latest
+    ports:
+      - "9411:9411"

examples/basic-tracer-node/index.js

@@ -2,19 +2,22 @@ const opentelemetry = require('@opentelemetry/core');
 const { BasicTracer, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { CollectorExporter } =  require('@opentelemetry/exporter-collector');
 
 const options = {
   serviceName: 'basic-service'
-}
+};
 
 // Initialize an exporter depending on how we were started
 let exporter;
 
 const EXPORTER = process.env.EXPORTER || '';
 if (EXPORTER.toLowerCase().startsWith('z')) {
   exporter = new ZipkinExporter(options);
-} else {
+} else if (EXPORTER.toLowerCase().startsWith('j')) {
   exporter = new JaegerExporter(options);
+} else {
+  exporter = new CollectorExporter(options);
 }
 
 const tracer = new BasicTracer();

examples/basic-tracer-node/multi_exporter.js

@@ -2,6 +2,7 @@ const opentelemetry = require('@opentelemetry/core');
 const { BasicTracer, BatchSpanProcessor, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { CollectorExporter } =  require('@opentelemetry/exporter-collector');
 
 const tracer = new BasicTracer();
 
@@ -10,7 +11,8 @@ const jaegerExporter = new JaegerExporter({
   serviceName: 'basic-service',
   // The default flush interval is 5 seconds.
   flushInterval: 2000
-})
+});
+const collectorExporter = new CollectorExporter({serviceName: 'basic-service'});
 
 // It is recommended to use this BatchSpanProcessor for better performance
 // and optimization, especially in production.
@@ -22,6 +24,8 @@ tracer.addSpanProcessor(new BatchSpanProcessor(zipkinExporter, {
 // it's internal client already handles the spans with batching logic.
 tracer.addSpanProcessor(new SimpleSpanProcessor(jaegerExporter));
 
+tracer.addSpanProcessor(new SimpleSpanProcessor(collectorExporter));
+
 // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
 opentelemetry.initGlobalTracer(tracer);
 
@@ -36,6 +40,7 @@ span.end();
 // flush and close the connection.
 zipkinExporter.shutdown();
 jaegerExporter.shutdown();
+collectorExporter.shutdown();
 
 function doWork(parent) {
   // Start another span. In this example, the main method already started a

examples/basic-tracer-node/package.json

@@ -7,6 +7,10 @@
   "scripts": {
     "zipkin:basic": "cross-env EXPORTER=zipkin node ./index.js",
     "jaeger:basic": "cross-env EXPORTER=jaeger node ./index.js",
+    "collector:basic": "cross-env EXPORTER=collector node ./index.js",
+    "collector:docker:oc": "cd ./dockers/ot && docker-compose down && cd ../oc && docker-compose down && docker-compose up",
+    "collector:docker:ot": "cd ./dockers/oc && docker-compose down && cd ../ot && docker-compose down && docker-compose up",
+    "collector:docker:stop": "cd ./dockers/oc && docker-compose down && cd ../ot && docker-compose down",
     "multi_exporter": "node ./multi_exporter.js"
   },
   "repository": {
@@ -28,6 +32,7 @@
   },
   "dependencies": {
     "@opentelemetry/core": "^0.2.0",
+    "@opentelemetry/exporter-collector": "^0.2.0",
     "@opentelemetry/exporter-jaeger": "^0.2.0",
     "@opentelemetry/exporter-zipkin": "^0.2.0",
     "@opentelemetry/tracing": "^0.2.0"

examples/tracer-web/index.html

@@ -21,7 +21,7 @@
 </head>
 
 <body>
-  Example of using Web Tracer with document load plugin and console exporter
+  Example of using Web Tracer with document load plugin with console exporter and collector exporter
   <script type="text/javascript" src="/bundle.js"></script>
   <br/>
   <button id="button1">Test WebTracer with ZoneScopeManager - async</button>

examples/tracer-web/index.js

@@ -2,6 +2,7 @@ import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing
 import { WebTracer } from '@opentelemetry/web';
 import { DocumentLoad } from '@opentelemetry/plugin-document-load';
 import { ZoneScopeManager } from '@opentelemetry/scope-zone';
+import { CollectorExporter } from '@opentelemetry/exporter-collector'
 
 const webTracer = new WebTracer({
   plugins: [
@@ -17,6 +18,7 @@ const webTracerWithZone = new WebTracer({
   ]
 });
 webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new CollectorExporter()));
 
 console.log('Current span is window', webTracerWithZone.getCurrentSpan() === window);
 

examples/tracer-web/package.json

@@ -34,6 +34,7 @@
     "webpack-merge": "^4.2.2"
   },
   "dependencies": {
+    "@opentelemetry/exporter-collector": "^0.2.0",
     "@opentelemetry/plugin-document-load": "^0.2.0",
     "@opentelemetry/scope-zone": "^0.2.0",
     "@opentelemetry/tracing": "^0.2.0",

packages/opentelemetry-core/package.json

@@ -22,7 +22,8 @@
     "precompile": "tsc --version",
     "compile": "tsc -p .",
     "fix": "gts fix",
-    "prepare": "npm run compile"
+    "prepare": "npm run compile",
+    "watch": "tsc -w"
   },
   "keywords": [
     "opentelemetry",

packages/opentelemetry-core/src/common/time.ts

@@ -99,6 +99,33 @@ export function hrTimeDuration(
   return [seconds, nanos];
 }
 
+// Returns end time based on startTime and duration
+export function hrTimeEndTime(
+  startTime: types.HrTime,
+  duration: types.HrTime
+): types.HrTime {
+  let seconds = startTime[0] + duration[0];
+  let nanos = startTime[1] + duration[1];
+
+  // overflow
+  if (nanos < 0) {
+    seconds -= 1;
+    // negate
+    nanos += SECOND_TO_NANOSECONDS;
+  }
+
+  return [seconds, nanos];
+}
+
+// Convert hrTime to timestamp.
+export function hrTimeToTimeStamp(hrTime: types.HrTime): string {
+  const precision = NANOSECOND_DIGITS;
+  const tmp = `${'0'.repeat(precision)}${hrTime[1]}Z`;
+  const nanoString = tmp.substr(tmp.length - precision - 1);
+  const date = new Date(hrTime[0] * 1000).toISOString();
+  return date.replace('000Z', nanoString);
+}
+
 // Convert hrTime to nanoseconds.
 export function hrTimeToNanoseconds(hrTime: types.HrTime): number {
   return hrTime[0] * SECOND_TO_NANOSECONDS + hrTime[1];

packages/opentelemetry-core/src/platform/browser/index.ts

@@ -17,3 +17,4 @@
 export * from './id';
 export * from './performance';
 export * from './timer-util';
+export * from './span-id-to-base64';

packages/opentelemetry-core/src/platform/browser/span-id-to-base64.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2019, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * converts id string into base64
+ * @param hexStr - id of span
+ */
+export function spanIdToBase64(hexStr: string = ''): string {
+  const hexStrLen = hexStr.length;
+  let hexAsciiCharsStr = '';
+  for (let i = 0; i < hexStrLen; i += 2) {
+    const hexPair = hexStr.substring(i, i + 2);
+    const hexVal = parseInt(hexPair, 16);
+    hexAsciiCharsStr += String.fromCharCode(hexVal);
+  }
+  return btoa(hexAsciiCharsStr);
+}

packages/opentelemetry-core/src/platform/node/index.ts

@@ -17,3 +17,4 @@
 export * from './id';
 export * from './performance';
 export * from './timer-util';
+export * from './span-id-to-base64';

packages/opentelemetry-core/src/platform/node/span-id-to-base64.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2019, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * converts id string into base64
+ * @param hexStr - id of span
+ */
+export function spanIdToBase64(hexStr: string = ''): string {
+  const hexStrLen = hexStr.length;
+  let hexAsciiCharsStr = '';
+  for (let i = 0; i < hexStrLen; i += 2) {
+    const hexPair = hexStr.substring(i, i + 2);
+    const hexVal = parseInt(hexPair, 16);
+    hexAsciiCharsStr += String.fromCharCode(hexVal);
+  }
+
+  return Buffer.from(hexAsciiCharsStr, 'ascii').toString('base64');
+}

packages/opentelemetry-core/test/common/time.test.ts

@@ -25,7 +25,9 @@ import {
   hrTimeToNanoseconds,
   hrTimeToMilliseconds,
   hrTimeToMicroseconds,
+  hrTimeToTimeStamp,
   isTimeInput,
+  hrTimeEndTime,
 } from '../../src/common/time';
 
 describe('time', () => {
@@ -156,6 +158,33 @@ describe('time', () => {
     });
   });
 
+  describe('#hrTimeEndTime', () => {
+    it('should return endTime', () => {
+      const startTime: types.HrTime = [22, 400000000];
+      const durationTime: types.HrTime = [32, 800000000];
+
+      const output = hrTimeEndTime(startTime, durationTime);
+      assert.deepStrictEqual(output, [54, 1200000000]);
+    });
+
+    it('should handle nanosecond overflow', () => {
+      const startTime: types.HrTime = [22, 400000000];
+      const durationTime: types.HrTime = [32, 200000000];
+
+      const output = hrTimeEndTime(startTime, durationTime);
+      assert.deepStrictEqual(output, [54, 600000000]);
+    });
+  });
+
+  describe('#hrTimeToTimeStamp', () => {
+    it('should return timestamp', () => {
+      const time: types.HrTime = [1573513121, 123456];
+
+      const output = hrTimeToTimeStamp(time);
+      assert.deepStrictEqual(output, '2019-11-11T22:58:41.000123456Z');
+    });
+  });
+
   describe('#hrTimeToNanoseconds', () => {
     it('should return nanoseconds', () => {
       const output = hrTimeToNanoseconds([1, 200000000]);