Add initial benchmark suite (#390)

* feat: add initial benchmark suite

* fix: remove nock

* feat: add propagator benchmarks

* fix: use new package names

Author: mayurkale22

benchmark/benchmark.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Benchmark = require('benchmark');
+const benchmarks = require('beautify-benchmark');
+
+Benchmark.options.maxTime = 0;
+// @todo : Change it to between 50-100 or keep it random.
+Benchmark.options.minSamples = 10;
+
+module.exports = () => {
+  const suite = new Benchmark.Suite();
+
+  return suite
+    .on('cycle', event => {
+      benchmarks.add(event.target);
+    })
+    .on('error', event => {
+      throw event.target.error;
+    })
+    .on('complete', function () {
+      benchmarks.log();
+    });
+};

benchmark/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const execSync = require('child_process').execSync;
+const exec = cmd => execSync(cmd, { stdio: [0, 1, 2] });
+
+exec('node benchmark/tracer');
+exec('node benchmark/propagator');

benchmark/propagator.js

@@ -0,0 +1,42 @@
+'use strict';
+
+const benchmark = require('./benchmark');
+const opentelemetry = require('@opentelemetry/core');
+
+const setups = [
+  {
+    name: 'B3Format',
+    propagator: new opentelemetry.B3Format(),
+    injectCarrier: {},
+    extractCarrier: {
+      'x-b3-traceid': 'd4cda95b652f4a1592b449d5929fda1b',
+      'x-b3-spanid': '6e0c63257de34c92'
+    }
+  },
+  {
+    name: 'HttpTraceContext',
+    propagator: new opentelemetry.HttpTraceContext(),
+    injectCarrier: {},
+    extractCarrier: {
+      traceparent: '00-d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-00'
+    }
+  }
+];
+
+for (const setup of setups) {
+  console.log(`Beginning ${setup.name} Benchmark...`);
+  const propagator = setup.propagator;
+  const suite = benchmark()
+    .add('#Inject', function () {
+      propagator.inject({
+        traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+        spanId: '6e0c63257de34c92'
+      }, setup.name, setup.injectCarrier);
+    })
+    .add('#Extract', function () {
+      propagator.extract(setup.name, setup.extractCarrier);
+    });
+
+  // run async
+  suite.run({ async: false });
+}

benchmark/tracer.js

@@ -0,0 +1,75 @@
+'use strict';
+
+const benchmark = require('./benchmark');
+const opentelemetry = require('@opentelemetry/core');
+const { BasicTracer, BatchSpanProcessor, InMemorySpanExporter, SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { NodeTracer } = require('@opentelemetry/node');
+
+const exporter = new InMemorySpanExporter();
+const logger = new opentelemetry.NoopLogger();
+
+const setups = [
+  {
+    name: 'BasicTracer',
+    tracer: new BasicTracer({ logger })
+  },
+  {
+    name: 'NodeTracer',
+    tracer: new NodeTracer({ logger })
+  }
+];
+
+for (const setup of setups) {
+  console.log(`Beginning ${setup.name} Benchmark...`);
+  const tracer = setup.tracer;
+  const suite = benchmark()
+    .add('#startSpan', function () {
+      const span = tracer.startSpan('op');
+      span.end();
+    })
+    .add('#startSpan:parent', function () {
+      const span = tracer.startSpan('op');
+      const childSpan = tracer.startSpan('client-op', { parent: span });
+      childSpan.end();
+      span.end();
+    })
+    .add('#startSpan with attribute', function () {
+      const span = tracer.startSpan('op');
+      span.setAttribute('attr-key-one', 'attr-value-one');
+      span.end();
+    })
+    .add('#startSpan with 30 attributes', function () {
+      const span = tracer.startSpan('op');
+      for (let j = 0; j < 30; j++) {
+        span.setAttribute('attr-key-' + j, 'attr-value-' + j);
+      }
+      span.end();
+    })
+    .add('#startSpan with 100 attributes', function () {
+      const span = tracer.startSpan('op');
+      for (let j = 0; j < 100; j++) {
+        span.setAttribute('attr-key-' + j, 'attr-value-' + j);
+      }
+      span.end();
+    })
+    .add('#startSpan with SimpleSpanProcessor', function () {
+      const simpleSpanProcessor = new SimpleSpanProcessor(exporter);
+
+      tracer.addSpanProcessor(simpleSpanProcessor);
+      const span = tracer.startSpan('op');
+      span.end();
+
+      simpleSpanProcessor.shutdown();
+    })
+    .add('#startSpan with BatchSpanProcessor', function () {
+      const batchSpanProcessor = new BatchSpanProcessor(exporter);
+
+      tracer.addSpanProcessor(batchSpanProcessor);
+      const span = tracer.startSpan('op');
+      span.end();
+      batchSpanProcessor.shutdown();
+    });
+
+  // run async
+  suite.run({ async: false });
+}

lerna.json

@@ -3,7 +3,8 @@
   "npmClient": "yarn",
   "packages": [
     "packages/*",
-    "examples/*"
+    "examples/*",
+    "benchmark/*"
   ],
   "version": "0.1.1",
   "changelog": {

package.json

@@ -5,6 +5,7 @@
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "scripts": {
+    "bench": "node benchmark",
     "clean": "lerna run clean",
     "fix": "lerna run fix",
     "postinstall": "yarn run bootstrap",
@@ -35,6 +36,8 @@
     "@commitlint/cli": "^8.2.0",
     "@commitlint/config-conventional": "^8.2.0",
     "husky": "^3.0.9",
+    "benchmark": "^2.1.4",
+    "beautify-benchmark": "^0.2.4",
     "gts": "^1.0.0",
     "lerna": "^3.17.0",
     "lerna-changelog": "^0.8.2",