Named Tracers / Tracer Registry

.gitignore

@@ -71,6 +71,7 @@ docs
 
 #lerna
 .changelog
+package.json.lerna_backup
 
 # OS generated files
 .DS_Store

examples/basic-tracer-node/index.js

@@ -1,5 +1,5 @@
 const opentelemetry = require('@opentelemetry/core');
-const { BasicTracer, SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { BasicTracerRegistry, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
@@ -17,13 +17,13 @@ if (EXPORTER.toLowerCase().startsWith('z')) {
   exporter = new JaegerExporter(options);
 }
 
-const tracer = new BasicTracer();
+const registry = new BasicTracerRegistry();
 
 // Configure span processor to send spans to the provided exporter
-tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
 // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-opentelemetry.initGlobalTracer(tracer);
+opentelemetry.initGlobalTracerRegistry(registry);
 
 // Create a span. A span must be closed.
 const span = opentelemetry.getTracer().startSpan('main');

examples/dns/setup.js

@@ -1,14 +1,14 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer({
+  const registry = new NodeTracerRegistry({
       plugins: {
           dns: {
             enabled: true,
@@ -32,10 +32,10 @@ function setupTracerAndExporters(service) {
     });
   }
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/grpc/setup.js

@@ -1,14 +1,14 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer({
+  const registry = new NodeTracerRegistry({
     plugins: {
       grpc: {
         enabled: true,
@@ -31,10 +31,10 @@ function setupTracerAndExporters(service) {
     });
   }
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/grpc_dynamic_codegen/setup.js

@@ -1,14 +1,14 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer({
+  const registry = new NodeTracerRegistry({
     plugins: {
       grpc: {
         enabled: true,
@@ -33,10 +33,10 @@ function setupTracerAndExporters(service) {
 
   // It is recommended to use this `BatchSpanProcessor` for better performance
   // and optimization, especially in production.
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/http/setup.js

@@ -1,14 +1,14 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer();
+  const registry = new NodeTracerRegistry();
 
   let exporter;
   if (EXPORTER.toLowerCase().startsWith('z')) {
@@ -23,10 +23,10 @@ function setupTracerAndExporters(service) {
     });
   }
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/https/setup.js

@@ -1,15 +1,15 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 function setupTracerAndExporters(service) {
   let exporter;
-  const tracer = new NodeTracer();
+  const registry = new NodeTracerRegistry();
 
   if (EXPORTER.toLowerCase().startsWith('z')) {
     exporter = new ZipkinExporter({
@@ -23,10 +23,10 @@ function setupTracerAndExporters(service) {
     });
   }
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/mysql/setup.js

@@ -1,13 +1,13 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer({
+  const registry = new NodeTracerRegistry({
     plugins: {
       mysql: {
         enabled: true,
@@ -20,17 +20,17 @@ function setupTracerAndExporters(service) {
     }
   });
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(new ZipkinExporter({
+  registry.addSpanProcessor(new SimpleSpanProcessor(new ZipkinExporter({
     serviceName: service,
   })));
-  tracer.addSpanProcessor(new SimpleSpanProcessor(new JaegerExporter({
+  registry.addSpanProcessor(new SimpleSpanProcessor(new JaegerExporter({
     serviceName: service,
     // The default flush interval is 5 seconds.
     flushInterval: 2000
   })));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/redis/setup.js

@@ -1,14 +1,14 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/core');
-const { NodeTracer } = require('@opentelemetry/node');
+const { NodeTracerRegistry } = 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 || '';
 
 function setupTracerAndExporters(service) {
-  const tracer = new NodeTracer();
+  const registry = new NodeTracerRegistry();
 
   let exporter;
   if (EXPORTER.toLowerCase().startsWith('z')) {
@@ -23,10 +23,10 @@ function setupTracerAndExporters(service) {
     });
   }
 
-  tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+  registry.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
   // Initialize the OpenTelemetry APIs to use the BasicTracer bindings
-  opentelemetry.initGlobalTracer(tracer);
+  opentelemetry.initGlobalTracerRegistry(registry);
 }
 
 exports.setupTracerAndExporters = setupTracerAndExporters;

examples/tracer-web/index.js

@@ -1,58 +1,59 @@
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
-import { WebTracer } from '@opentelemetry/web';
+import { WebTracerRegistry } from '@opentelemetry/web';
 import { DocumentLoad } from '@opentelemetry/plugin-document-load';
 import { ZoneScopeManager } from '@opentelemetry/scope-zone';
 
-const webTracer = new WebTracer({
+const registry = new WebTracerRegistry({
   plugins: [
     new DocumentLoad()
   ]
 });
-webTracer.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+registry.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
 
-const webTracerWithZone = new WebTracer({
+const registryWithZone = new WebTracerRegistry({
   scopeManager: new ZoneScopeManager(),
   plugins: [
     new DocumentLoad()
   ]
 });
-webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+registryWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+const tracerWithZone = registryWithZone.getTracer();
 
-console.log('Current span is window', webTracerWithZone.getCurrentSpan() === window);
+console.log('Current span is window', tracerWithZone.getCurrentSpan() === window);
 
 // example of keeping track of scope between async operations
 const prepareClickEvent = () => {
   const url1 = 'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/master/package.json';
   const url2 = 'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/master/packages/opentelemetry-web/package.json';
 
   const element = document.getElementById('button1');
-  let mainSpan = webTracerWithZone.startSpan('main-span');
-  webTracerWithZone.bind(element, mainSpan);
+  let mainSpan = tracerWithZone.startSpan('main-span');
+  tracerWithZone.bind(element, mainSpan);
 
   const onClick = () => {
-    const span1 = webTracerWithZone.startSpan(`files-series-info-1`, {
-      parent: webTracerWithZone.getCurrentSpan()
+    const span1 = tracerWithZone.startSpan(`files-series-info-1`, {
+      parent: tracerWithZone.getCurrentSpan()
     });
 
-    const span2 = webTracerWithZone.startSpan(`files-series-info-2`, {
-      parent: webTracerWithZone.getCurrentSpan()
+    const span2 = tracerWithZone.startSpan(`files-series-info-2`, {
+      parent: tracerWithZone.getCurrentSpan()
     });
 
-    webTracerWithZone.withSpan(span1, () => {
+    tracerWithZone.withSpan(span1, () => {
       getData(url1).then((data) => {
-        console.log('current span is span1', webTracerWithZone.getCurrentSpan() === span1);
+        console.log('current span is span1', tracerWithZone.getCurrentSpan() === span1);
         console.log('info from package.json', data.description, data.version);
-        webTracerWithZone.getCurrentSpan().addEvent('fetching-span1-completed');
+        tracerWithZone.getCurrentSpan().addEvent('fetching-span1-completed');
         span1.end();
       });
     });
 
-    webTracerWithZone.withSpan(span2, () => {
+    tracerWithZone.withSpan(span2, () => {
       getData(url2).then((data) => {
         setTimeout(() => {
-          console.log('current span is span2', webTracerWithZone.getCurrentSpan() === span2);
+          console.log('current span is span2', tracerWithZone.getCurrentSpan() === span2);
           console.log('info from package.json', data.description, data.version);
-          webTracerWithZone.getCurrentSpan().addEvent('fetching-span2-completed');
+          tracerWithZone.getCurrentSpan().addEvent('fetching-span2-completed');
           span2.end();
         }, 100);
       });

packages/opentelemetry-core/src/index.ts

@@ -26,6 +26,7 @@ export * from './trace/globaltracer-utils';
 export * from './trace/instrumentation/BasePlugin';
 export * from './trace/NoopSpan';
 export * from './trace/NoopTracer';
+export * from './trace/NoopTracerRegistry';
 export * from './trace/NoRecordingSpan';
 export * from './trace/sampler/ProbabilitySampler';
 export * from './trace/spancontext-utils';

packages/opentelemetry-core/src/trace/NoopTracer.ts

@@ -59,3 +59,5 @@ export class NoopTracer implements Tracer {
     return NOOP_HTTP_TEXT_FORMAT;
   }
 }
+
+export const noopTracer = new NoopTracer();

packages/opentelemetry-core/src/trace/NoopTracerRegistry.ts

@@ -0,0 +1,24 @@
+/*!
+ * 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.
+ */
+
+import * as types from '@opentelemetry/types';
+import { noopTracer } from './NoopTracer';
+
+export class NoopTracerRegistry implements types.TracerRegistry {
+  getTracer(_name?: string, _version?: string): types.Tracer {
+    return noopTracer;
+  }
+}