Skip to content

Commit 5035607

Browse files
committed
fixup! update readme
1 parent 29f76cf commit 5035607

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ To request automatic tracing support for a module not on this list, please [file
231231

232232
[PR-1764](https://github.com/open-telemetry/opentelemetry-js/pull/1764) removed some APIs from `Tracer`:
233233

234-
- `Tracer.getCurrentSpan()`: use `api.getActiveSpan(api.context.active())`
235-
- `Tracer.withSpan(span)`: use `api.context.with(api.setActiveSpan(api.context.active(), span))`
234+
- `Tracer.getCurrentSpan()`: use `api.getSpan(api.context.active())`
235+
- `Tracer.withSpan(span)`: use `api.context.with(api.setSpan(api.context.active(), span))`
236236
- `Tracer.bind(target)`: use `api.context.bind(target)`
237237

238238
## Useful links

packages/opentelemetry-context-zone-peer-dep/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ npm install --save @opentelemetry/context-zone-peer-dep
2222
## Usage
2323

2424
```js
25-
import { context, getActiveSpan, setActiveSpan } from '@opentelemetry/api';
25+
import { context, getSpan, setSpan } from '@opentelemetry/api';
2626
import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
2727
import { WebTracerProvider } from '@opentelemetry/web';
2828
import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep';
@@ -36,21 +36,21 @@ providerWithZone.register({
3636
// Example how the ZoneContextManager keeps the reference to the correct context during async operations
3737
const webTracerWithZone = providerWithZone.getTracer('default');
3838
const span1 = webTracerWithZone.startSpan('foo1');
39-
context.with(setActiveSpan(context.active(), span1, () => {
40-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
39+
context.with(setSpan(context.active(), span1, () => {
40+
console.log('Current span is span1', getSpan(context.active()) === span1);
4141
setTimeout(() => {
4242
const span2 = webTracerWithZone.startSpan('foo2');
43-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
44-
context.with(setActiveSpan(context.active(), span2, () => {
45-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
43+
console.log('Current span is span1', getSpan(context.active()) === span1);
44+
context.with(setSpan(context.active(), span2, () => {
45+
console.log('Current span is span2', getSpan(context.active()) === span2);
4646
setTimeout(() => {
47-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
47+
console.log('Current span is span2', getSpan(context.active()) === span2);
4848
}, 500);
4949
});
5050
// there is a timeout which still keeps span2 active
51-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
51+
console.log('Current span is span2', getSpan(context.active()) === span2);
5252
}, 500);
53-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
53+
console.log('Current span is span1', getSpan(context.active()) === span1);
5454
});
5555

5656
```

packages/opentelemetry-context-zone/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ npm install --save @opentelemetry/context-zone
1919
## Usage
2020

2121
```js
22-
import { context, getActiveSpan, setActiveSpan } from '@opentelemetry/api';
22+
import { context, getSpan, setSpan } from '@opentelemetry/api';
2323
import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
2424
import { WebTracerProvider } from '@opentelemetry/web';
2525
import { ZoneContextManager } from '@opentelemetry/context-zone';
@@ -34,21 +34,21 @@ provider.register({
3434
const webTracerWithZone = providerWithZone.getTracer('default');
3535
const span1 = webTracerWithZone.startSpan('foo1');
3636

37-
context.with(setActiveSpan(context.active(), span1), () => {
38-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
37+
context.with(setSpan(context.active(), span1), () => {
38+
console.log('Current span is span1', getSpan(context.active()) === span1);
3939
setTimeout(() => {
4040
const span2 = webTracerWithZone.startSpan('foo2');
41-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
42-
context.with(setActiveSpan(context.active(), span2), () => {
43-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
41+
console.log('Current span is span1', getSpan(context.active()) === span1);
42+
context.with(setSpan(context.active(), span2), () => {
43+
console.log('Current span is span2', getSpan(context.active()) === span2);
4444
setTimeout(() => {
45-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
45+
console.log('Current span is span2', getSpan(context.active()) === span2);
4646
}, 500);
4747
});
4848
// there is a timeout which still keeps span2 active
49-
console.log('Current span is span2', getActiveSpan(context.active()) === span2);
49+
console.log('Current span is span2', getSpan(context.active()) === span2);
5050
}, 500);
51-
console.log('Current span is span1', getActiveSpan(context.active()) === span1);
51+
console.log('Current span is span1', getSpan(context.active()) === span1);
5252
});
5353

5454
```

0 commit comments

Comments
 (0)