fixup! update readme

open-telemetry · Dec 21, 2020 · 5035607 · 5035607
1 parent 29f76cf
commit 5035607
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -231,8 +231,8 @@ To request automatic tracing support for a module not on this list, please [file
 
 [PR-1764](https://github.com/open-telemetry/opentelemetry-js/pull/1764) removed some APIs from `Tracer`:
 
-- `Tracer.getCurrentSpan()`: use `api.getActiveSpan(api.context.active())`
-- `Tracer.withSpan(span)`: use `api.context.with(api.setActiveSpan(api.context.active(), span))`
+- `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

diff --git a/packages/opentelemetry-context-zone-peer-dep/README.md b/packages/opentelemetry-context-zone-peer-dep/README.md
@@ -22,7 +22,7 @@ npm install --save @opentelemetry/context-zone-peer-dep
 ## Usage
 
 ```js
-import { context, getActiveSpan, setActiveSpan } from '@opentelemetry/api';
+import { context, getSpan, setSpan } from '@opentelemetry/api';
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracerProvider } from '@opentelemetry/web';
 import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep';
@@ -36,21 +36,21 @@ providerWithZone.register({
 // Example how the ZoneContextManager keeps the reference to the correct context during async operations
 const webTracerWithZone = providerWithZone.getTracer('default');
 const span1 = webTracerWithZone.startSpan('foo1');
-context.with(setActiveSpan(context.active(), span1, () => {
-  console.log('Current span is span1', getActiveSpan(context.active()) === span1);
+context.with(setSpan(context.active(), span1, () => {
+  console.log('Current span is span1', getSpan(context.active()) === span1);
   setTimeout(() => {
     const span2 = webTracerWithZone.startSpan('foo2');
-    console.log('Current span is span1', getActiveSpan(context.active()) === span1);
-    context.with(setActiveSpan(context.active(), span2, () => {
-      console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+    console.log('Current span is span1', getSpan(context.active()) === span1);
+    context.with(setSpan(context.active(), span2, () => {
+      console.log('Current span is span2', getSpan(context.active()) === span2);
       setTimeout(() => {
-        console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+        console.log('Current span is span2', getSpan(context.active()) === span2);
       }, 500);
     });
     // there is a timeout which still keeps span2 active
-    console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+    console.log('Current span is span2', getSpan(context.active()) === span2);
   }, 500);
-  console.log('Current span is span1', getActiveSpan(context.active()) === span1);
+  console.log('Current span is span1', getSpan(context.active()) === span1);
 });
 
 ```

diff --git a/packages/opentelemetry-context-zone/README.md b/packages/opentelemetry-context-zone/README.md
@@ -19,7 +19,7 @@ npm install --save @opentelemetry/context-zone
 ## Usage
 
 ```js
-import { context, getActiveSpan, setActiveSpan } from '@opentelemetry/api';
+import { context, getSpan, setSpan } from '@opentelemetry/api';
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracerProvider } from '@opentelemetry/web';
 import { ZoneContextManager } from '@opentelemetry/context-zone';
@@ -34,21 +34,21 @@ provider.register({
 const webTracerWithZone = providerWithZone.getTracer('default');
 const span1 = webTracerWithZone.startSpan('foo1');
 
-context.with(setActiveSpan(context.active(), span1), () => {
-  console.log('Current span is span1', getActiveSpan(context.active()) === span1);
+context.with(setSpan(context.active(), span1), () => {
+  console.log('Current span is span1', getSpan(context.active()) === span1);
   setTimeout(() => {
     const span2 = webTracerWithZone.startSpan('foo2');
-    console.log('Current span is span1', getActiveSpan(context.active()) === span1);
-    context.with(setActiveSpan(context.active(), span2), () => {
-      console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+    console.log('Current span is span1', getSpan(context.active()) === span1);
+    context.with(setSpan(context.active(), span2), () => {
+      console.log('Current span is span2', getSpan(context.active()) === span2);
       setTimeout(() => {
-        console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+        console.log('Current span is span2', getSpan(context.active()) === span2);
       }, 500);
     });
     // there is a timeout which still keeps span2 active
-    console.log('Current span is span2', getActiveSpan(context.active()) === span2);
+    console.log('Current span is span2', getSpan(context.active()) === span2);
   }, 500);
-  console.log('Current span is span1', getActiveSpan(context.active()) === span1);
+  console.log('Current span is span1', getSpan(context.active()) === span1);
 });
 
 ```