chore: remove tracer apis not part of spec (#1764)

Co-authored-by: Mayur Kale <[email protected]>
Co-authored-by: Daniel Dyla <[email protected]>

Author: 3 people

README.md

@@ -225,6 +225,16 @@ To request automatic tracing support for a module not on this list, please [file
 |----------------------------------------------------------|-----------------------------------------------------------------------------------------|
 | [@opentelemetry/shim-opentracing][otel-shim-opentracing] | OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry |
 
+## Upgrade guidelines
+
+### 0.14.0 to 0.15.0
+
+[PR-1764](https://github.com/open-telemetry/opentelemetry-js/pull/1764) removed some APIs from `Tracer`:
+
+- `Tracer.getCurrentSpan()`: use `api.getSpan(api.context.active())`
+- `Tracer.withSpan(span)`: use `api.context.with(api.setSpan(api.context.active(), span))`
+- `Tracer.bind(target)`: use `api.context.bind(target)`
+
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

examples/basic-tracer-node/index.js

@@ -37,9 +37,8 @@ exporter.shutdown();
 function doWork(parent) {
   // Start another span. In this example, the main method already started a
   // span, so that'll be the parent span, and this will be a child span.
-  const span = tracer.startSpan('doWork', {
-    parent,
-  });
+  const ctx = opentelemetry.setSpan(opentelemetry.context.active(), parent);
+  const span = tracer.startSpan('doWork', undefined, ctx);
 
   // simulate some random work.
   for (let i = 0; i <= Math.floor(Math.random() * 40000000); i += 1) {

examples/collector-exporter-node/tracing.js

@@ -39,9 +39,8 @@ setTimeout(() => {
 function doWork(parent) {
   // Start another span. In this example, the main method already started a
   // span, so that'll be the parent span, and this will be a child span.
-  const span = tracer.startSpan('doWork', {
-    parent,
-  });
+  const ctx = opentelemetry.setSpan(opentelemetry.context.active(), parent);
+  const span = tracer.startSpan('doWork', undefined, ctx);
 
   // simulate some random work.
   for (let i = 0; i <= Math.floor(Math.random() * 40000000); i += 1) {

examples/grpc-js/client.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-grpc-client');
 // eslint-disable-next-line import/order
 const grpc = require('@grpc/grpc-js');
@@ -14,7 +15,7 @@ function main() {
   // the span, which is created to track work that happens outside of the
   // request lifecycle entirely.
   const span = tracer.startSpan('client.js:main()');
-  tracer.withSpan(span, () => {
+  api.context.with(api.setSpan(api.context.active(), span), () => {
     console.log('Client traceId ', span.context().traceId);
     const client = new services.GreeterClient(
       `localhost:${PORT}`,

examples/grpc-js/server.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')(('example-grpc-server'));
 // eslint-disable-next-line import/order
 const grpc = require('@grpc/grpc-js');
@@ -21,11 +22,10 @@ function startServer() {
 }
 
 function sayHello(call, callback) {
-  const currentSpan = tracer.getCurrentSpan();
+  const currentSpan = api.getSpan(api.context.active());
   // display traceid in the terminal
   console.log(`traceid: ${currentSpan.context().traceId}`);
   const span = tracer.startSpan('server.js:sayHello()', {
-    parent: currentSpan,
     kind: 1, // server
     attributes: { key: 'value' },
   });

examples/grpc/client.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-grpc-client');
 // eslint-disable-next-line import/order
 const grpc = require('grpc');
@@ -14,7 +15,7 @@ function main() {
   // the span, which is created to track work that happens outside of the
   // request lifecycle entirely.
   const span = tracer.startSpan('client.js:main()');
-  tracer.withSpan(span, () => {
+  api.context.with(api.setSpan(api.context.active(), span), () => {
     console.log('Client traceId ', span.context().traceId);
     const client = new services.GreeterClient(
       `localhost:${PORT}`,

examples/grpc/server.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')(('example-grpc-server'));
 // eslint-disable-next-line import/order
 const grpc = require('grpc');
@@ -20,7 +21,7 @@ function startServer() {
 }
 
 function sayHello(call, callback) {
-  const currentSpan = tracer.getCurrentSpan();
+  const currentSpan = api.getSpan(api.context.active());
   // display traceid in the terminal
   console.log(`traceid: ${currentSpan.context().traceId}`);
   const span = tracer.startSpan('server.js:sayHello()', {

examples/http/client.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-http-client');
 // eslint-disable-next-line import/order
 const http = require('http');
@@ -10,7 +11,7 @@ function makeRequest() {
   // the span, which is created to track work that happens outside of the
   // request lifecycle entirely.
   const span = tracer.startSpan('makeRequest');
-  tracer.withSpan(span, () => {
+  api.context.with(api.setSpan(api.context.active(), span), () => {
     http.get({
       host: 'localhost',
       port: 8080,

examples/http/server.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-http-server');
 // eslint-disable-next-line import/order
 const http = require('http');
@@ -19,11 +20,10 @@ function startServer(port) {
 
 /** A function which handles requests and send response. */
 function handleRequest(request, response) {
-  const currentSpan = tracer.getCurrentSpan();
+  const currentSpan = api.getSpan(api.context.active());
   // display traceid in the terminal
   console.log(`traceid: ${currentSpan.context().traceId}`);
   const span = tracer.startSpan('handleRequest', {
-    parent: currentSpan,
     kind: 1, // server
     attributes: { key: 'value' },
   });

examples/https/client.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-https-client');
 // eslint-disable-next-line import/order
 const https = require('https');
@@ -10,7 +11,7 @@ function makeRequest() {
   // the span, which is created to track work that happens outside of the
   // request lifecycle entirely.
   const span = tracer.startSpan('makeRequest');
-  tracer.withSpan(span, () => {
+  api.context.with(api.setSpan(api.context.active(), span), () => {
     https.get({
       host: 'localhost',
       port: 443,