From 42187f28018e1d8294675f1388a275b1205c02ec Mon Sep 17 00:00:00 2001 From: Brad Frost Date: Wed, 2 Dec 2020 10:58:30 -0500 Subject: [PATCH] chore: use WebTracerProvider instead of WebTracer in docs (#1696) --- .../README.md | 8 +++++--- packages/opentelemetry-context-zone/README.md | 8 +++++--- .../README.md | 16 ++++++++++------ 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/packages/opentelemetry-context-zone-peer-dep/README.md b/packages/opentelemetry-context-zone-peer-dep/README.md index e068b8ec54..15edbcb0dd 100644 --- a/packages/opentelemetry-context-zone-peer-dep/README.md +++ b/packages/opentelemetry-context-zone-peer-dep/README.md @@ -23,15 +23,17 @@ npm install --save @opentelemetry/context-zone-peer-dep ```js import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; -import { WebTracer } from '@opentelemetry/web'; +import { WebTracerProvider } from '@opentelemetry/web'; import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep'; -const webTracerWithZone = new WebTracer({ +const providerWithZone = new WebTracerProvider(); +providerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); +providerWithZone.register({ contextManager: new ZoneContextManager() }); -webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); // Example how the ZoneContextManager keeps the reference to the correct context during async operations +const webTracerWithZone = providerWithZone.getTracer('default'); const span1 = webTracerWithZone.startSpan('foo1'); webTracerWithZone.withSpan(span1, () => { console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1); diff --git a/packages/opentelemetry-context-zone/README.md b/packages/opentelemetry-context-zone/README.md index b3c702c425..4e26999004 100644 --- a/packages/opentelemetry-context-zone/README.md +++ b/packages/opentelemetry-context-zone/README.md @@ -20,15 +20,17 @@ npm install --save @opentelemetry/context-zone ```js import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; -import { WebTracer } from '@opentelemetry/web'; +import { WebTracerProvider } from '@opentelemetry/web'; import { ZoneContextManager } from '@opentelemetry/context-zone'; -const webTracerWithZone = new WebTracer({ +const providerWithZone = new WebTracerProvider(); +providerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); +provider.register({ contextManager: new ZoneContextManager() }); -webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); // Example how the ZoneContextManager keeps the reference to the correct context during async operations +const webTracerWithZone = providerWithZone.getTracer('default'); const span1 = webTracerWithZone.startSpan('foo1'); webTracerWithZone.withSpan(span1, () => { console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1); diff --git a/packages/opentelemetry-instrumentation-xml-http-request/README.md b/packages/opentelemetry-instrumentation-xml-http-request/README.md index 89c2f63cec..0569ff17cd 100644 --- a/packages/opentelemetry-instrumentation-xml-http-request/README.md +++ b/packages/opentelemetry-instrumentation-xml-http-request/README.md @@ -18,32 +18,36 @@ npm install --save @opentelemetry/instrumentation-xml-http-request ```js import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; -import { WebTracer } from '@opentelemetry/web'; +import { WebTracerProvider } from '@opentelemetry/web'; import { XMLHttpRequestInstrumentation } from '@opentelemetry/instrumentation-xml-http-request'; import { ZoneContextManager } from '@opentelemetry/context-zone'; // this is still possible -const webTracerWithZone = new WebTracer({ - contextManager: new ZoneContextManager(), +const providerWithZone = new WebTracerProvider({ plugins: [ new XMLHttpRequestInstrumentation({ propagateTraceHeaderCorsUrls: ['http://localhost:8090'] }) ] }); +providerWithZone.register({ + contextManager: new ZoneContextManager(), +}); +const webTracerWithZone = providerWithZone.getTracer('default'); ///////////////////////////////////////// // or plugin can be also initialised separately and then set the tracer provider or meter provider const xmlHttpRequestInstrumentation = new XMLHttpRequestInstrumentation({ propagateTraceHeaderCorsUrls: ['http://localhost:8090'] }); -const webTracerWithZone = new WebTracer({ +const providerWithZone = new WebTracerProvider(); +providerWithZone.register({ contextManager: new ZoneContextManager(), }); -xmlHttpRequestInstrumentation.setTracerProvider(webTracerWithZone); +xmlHttpRequestInstrumentation.setTracerProvider(providerWithZone); ///////////////////////////////////////// -webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); +providerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); // and some test const req = new XMLHttpRequest();