update examples and getting started for provider and api package (#750)

* chore: rename provider in examples and getting started * chore: update examples, bench, and getting started for api * chore: update examples for latest changes * chore: lint examples
open-telemetry · Feb 5, 2020 · c5bc438 · c5bc438
1 parent 470fc62
commit c5bc438
Show file tree

Hide file tree

Showing 40 changed files with 181 additions and 179 deletions.
diff --git a/benchmark/tracer.js b/benchmark/tracer.js
@@ -1,15 +1,16 @@
 'use strict';
 
 const benchmark = require('./benchmark');
-const opentelemetry = require('../packages/opentelemetry-core');
+const opentelemetry = require('../packages/opentelemetry-api');
+const { NoopLogger } = require('../packages/opentelemetry-core');
 const { BasicTracerProvider, BatchSpanProcessor, InMemorySpanExporter, SimpleSpanProcessor } = require('../packages/opentelemetry-tracing');
 
-const logger = new opentelemetry.NoopLogger();
+const logger = new NoopLogger();
 
 const setups = [
   {
     name: 'NoopTracerProvider',
-    provider: opentelemetry.getTracerProvider()
+    provider: new opentelemetry.NoopTracerProvider()
   },
   {
     name: 'BasicTracerProvider',

diff --git a/examples/basic-tracer-node/index.js b/examples/basic-tracer-node/index.js
@@ -1,7 +1,7 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { BasicTracerRegistry, SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const opentelemetry = require('@opentelemetry/api');
+const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 const { CollectorExporter } = require('@opentelemetry/exporter-collector');
@@ -22,14 +22,14 @@ if (EXPORTER.toLowerCase().startsWith('z')) {
   exporter = new CollectorExporter(options);
 }
 
-const registry = new BasicTracerRegistry();
+const provider = new BasicTracerProvider();
 
 // Configure span processor to send spans to the provided exporter
-registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-// Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-opentelemetry.initGlobalTracerRegistry(registry);
-const tracer = opentelemetry.getTracer('example-basic-tracer-node');
+// Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+opentelemetry.trace.initGlobalTracerProvider(provider);
+const tracer = opentelemetry.trace.getTracer('example-basic-tracer-node');
 
 // Create a span. A span must be closed.
 const parentSpan = tracer.startSpan('main');

diff --git a/examples/basic-tracer-node/multi_exporter.js b/examples/basic-tracer-node/multi_exporter.js
@@ -1,12 +1,12 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { BasicTracerRegistry, BatchSpanProcessor, SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const opentelemetry = require('@opentelemetry/api');
+const { BasicTracerProvider, BatchSpanProcessor, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 const { CollectorExporter } = require('@opentelemetry/exporter-collector');
 
-const registry = new BasicTracerRegistry();
+const provider = new BasicTracerProvider();
 
 const zipkinExporter = new ZipkinExporter({ serviceName: 'basic-service' });
 const jaegerExporter = new JaegerExporter({
@@ -16,21 +16,21 @@ const collectorExporter = new CollectorExporter({ serviceName: 'basic-service' }
 
 // It is recommended to use this BatchSpanProcessor for better performance
 // and optimization, especially in production.
-registry.addSpanProcessor(new BatchSpanProcessor(zipkinExporter, {
+provider.addSpanProcessor(new BatchSpanProcessor(zipkinExporter, {
   // This is added for example, default size is 100.
   bufferSize: 10,
 }));
 
-const tracer = opentelemetry.getTracer('default');
+const tracer = opentelemetry.trace.getTracer('default');
 
 tracer.addSpanProcessor(new BatchSpanProcessor(jaegerExporter), {
   bufferSize: 10,
 });
 
-registry.addSpanProcessor(new SimpleSpanProcessor(collectorExporter));
+provider.addSpanProcessor(new SimpleSpanProcessor(collectorExporter));
 
-// Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-opentelemetry.initGlobalTracerRegistry(registry);
+// Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+opentelemetry.trace.initGlobalTracerProvider(provider);
 
 // Create a span. A span must be closed.
 const parentSpan = tracer.startSpan('main');

diff --git a/examples/basic-tracer-node/package.json b/examples/basic-tracer-node/package.json
@@ -30,7 +30,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-collector": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",

diff --git a/examples/dns/package.json b/examples/dns/package.json
@@ -26,7 +26,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",

diff --git a/examples/dns/tracer.js b/examples/dns/tracer.js
@@ -1,15 +1,15 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
-  const registry = new NodeTracerRegistry({
+  const provider = new NodeTracerProvider({
     plugins: {
       dns: {
         enabled: true,
@@ -31,10 +31,10 @@ module.exports = (serviceName) => {
     });
   }
 
-  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-  // Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-  opentelemetry.initGlobalTracerRegistry(registry);
+  // Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+  opentelemetry.trace.initGlobalTracerProvider(provider);
 
-  return opentelemetry.getTracer();
+  return opentelemetry.trace.getTracer('dns-example');
 };
diff --git a/examples/grpc/package.json b/examples/grpc/package.json
@@ -28,7 +28,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",

diff --git a/examples/grpc/tracer.js b/examples/grpc/tracer.js
@@ -1,15 +1,15 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
-  const registry = new NodeTracerRegistry({
+  const provider = new NodeTracerProvider({
     plugins: {
       grpc: {
         enabled: true,
@@ -29,10 +29,10 @@ module.exports = (serviceName) => {
     });
   }
 
-  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-  // Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-  opentelemetry.initGlobalTracerRegistry(registry);
+  // Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+  opentelemetry.trace.initGlobalTracerProvider(provider);
 
-  return opentelemetry.getTracer();
+  return opentelemetry.trace.getTracer('grpc-example');
 };
diff --git a/examples/grpc_dynamic_codegen/capitalize_server.js b/examples/grpc_dynamic_codegen/capitalize_server.js
@@ -2,7 +2,7 @@
 
 // eslint-disable-next-line import/order
 const tracer = require('./tracer')('example-grpc-capitalize-server');
-const { SpanKind } = require('@opentelemetry/types');
+const { SpanKind } = require('@opentelemetry/api');
 const path = require('path');
 const grpc = require('grpc');
 const protoLoader = require('@grpc/proto-loader');

diff --git a/examples/grpc_dynamic_codegen/package.json b/examples/grpc_dynamic_codegen/package.json
@@ -28,13 +28,13 @@
   },
   "dependencies": {
     "@grpc/proto-loader": "^0.4.0",
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",
     "@opentelemetry/plugin-grpc": "^0.3.3",
     "@opentelemetry/tracing": "^0.3.3",
-    "@opentelemetry/types": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "grpc": "^1.23.3",
     "node-pre-gyp": "0.12.0"
   },

diff --git a/examples/grpc_dynamic_codegen/tracer.js b/examples/grpc_dynamic_codegen/tracer.js
@@ -1,15 +1,15 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
-  const registry = new NodeTracerRegistry({
+  const provider = new NodeTracerProvider({
     plugins: {
       grpc: {
         enabled: true,
@@ -32,10 +32,10 @@ module.exports = (serviceName) => {
 
   // It is recommended to use this `BatchSpanProcessor` for better performance
   // and optimization, especially in production.
-  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-  // Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-  opentelemetry.initGlobalTracerRegistry(registry);
+  // Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+  opentelemetry.trace.initGlobalTracerProvider(provider);
 
-  return opentelemetry.getTracer();
+  return opentelemetry.trace.getTracer('grpc-dynamic-codegen-example');
 };
diff --git a/examples/http/package.json b/examples/http/package.json
@@ -28,7 +28,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",

diff --git a/examples/http/tracer.js b/examples/http/tracer.js
@@ -1,15 +1,15 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
-  const registry = new NodeTracerRegistry();
+  const provider = new NodeTracerProvider();
 
   let exporter;
   if (EXPORTER.toLowerCase().startsWith('z')) {
@@ -22,10 +22,10 @@ module.exports = (serviceName) => {
     });
   }
 
-  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-  // Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-  opentelemetry.initGlobalTracerRegistry(registry);
+  // Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+  opentelemetry.trace.initGlobalTracerProvider(provider);
 
-  return opentelemetry.getTracer();
+  return opentelemetry.trace.getTracer('http-example');
 };
diff --git a/examples/https/package.json b/examples/https/package.json
@@ -29,7 +29,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",

diff --git a/examples/https/tracer.js b/examples/https/tracer.js
@@ -1,7 +1,7 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
@@ -11,7 +11,7 @@ process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 
 module.exports = (serviceName) => {
   let exporter;
-  const registry = new NodeTracerRegistry();
+  const provider = new NodeTracerProvider();
 
   if (EXPORTER.toLowerCase().startsWith('z')) {
     exporter = new ZipkinExporter({
@@ -23,10 +23,10 @@ module.exports = (serviceName) => {
     });
   }
 
-  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-  // Initialize the OpenTelemetry APIs to use the BasicTracerRegistry bindings
-  opentelemetry.initGlobalTracerRegistry(registry);
+  // Initialize the OpenTelemetry APIs to use the BasicTracerProvider bindings
+  opentelemetry.trace.initGlobalTracerProvider(provider);
 
-  return opentelemetry.getTracer();
+  return opentelemetry.trace.getTracer('https-example');
 };
diff --git a/examples/ioredis/package.json b/examples/ioredis/package.json
@@ -28,7 +28,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",
     "@opentelemetry/plugin-ioredis": "^0.3.3",

diff --git a/examples/ioredis/tracer.js b/examples/ioredis/tracer.js
@@ -1,17 +1,17 @@
 'use strict';
 
-const opentelemetry = require('@opentelemetry/core');
-const { NodeTracerRegistry } = require('@opentelemetry/node');
+const opentelemetry = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 
-const tracerRegistry = new NodeTracerRegistry();
+const provider = new NodeTracerProvider();
 
 const exporter = new JaegerExporter({ serviceName: 'ioredis-example' });
 
-tracerRegistry.addSpanProcessor(new SimpleSpanProcessor(exporter));
+provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
 // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-opentelemetry.initGlobalTracerRegistry(tracerRegistry);
+opentelemetry.trace.initGlobalTracerProvider(provider);
 
-module.exports = opentelemetry.getTracer();
+module.exports = opentelemetry.trace.getTracer('ioredis-example');
diff --git a/examples/mysql/package.json b/examples/mysql/package.json
@@ -28,7 +28,7 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "dependencies": {
-    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/api": "^0.3.3",
     "@opentelemetry/exporter-jaeger": "^0.3.3",
     "@opentelemetry/exporter-zipkin": "^0.3.3",
     "@opentelemetry/node": "^0.3.3",