Skip to content

Commit e9ba507

Browse files
committed
doc(*): Migrate away from deprecated addSpanProcessor in READMEs
This migrates from the deprecated `addSpanProcessor` method to the constructor option in preparation for the upcoming SDK 2.0 release. This commit migrates everything in the README.md of each package, other than that there are no runtime code changes. Technically this is a user-facing change for users that previously followed the examples. Ref #2645
1 parent e57f3e4 commit e9ba507

File tree

10 files changed

+47
-21
lines changed
  • metapackages
  • plugins
    • node
    • web
      • opentelemetry-instrumentation-document-load
      • opentelemetry-instrumentation-long-task
      • opentelemetry-instrumentation-user-interaction

10 files changed

+47
-21
lines changed

metapackages/auto-instrumentations-node/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,10 @@ const provider = new NodeTracerProvider({
138138
resource: new Resource({
139139
[SEMRESATTRS_SERVICE_NAME]: 'basic-service',
140140
}),
141+
spanProcessors: [
142+
new SimpleSpanProcessor(exporter),
143+
],
141144
});
142-
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
143145
provider.register();
144146

145147
registerInstrumentations({

metapackages/auto-instrumentations-web/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,11 @@ const exporter = new CollectorTraceExporter({
2626
serviceName: 'auto-instrumentations-web',
2727
});
2828

29-
const provider = new WebTracerProvider();
30-
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
29+
const provider = new WebTracerProvider({
30+
spanProcessors: [
31+
new SimpleSpanProcessor(exporter),
32+
],
33+
});
3134
provider.register({
3235
contextManager: new ZoneContextManager(),
3336
propagator: new B3Propagator(),

plugins/node/instrumentation-undici/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,12 @@ const {
3535
} = require('@opentelemetry/sdk-trace-node');
3636
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
3737

38-
const provider = new NodeTracerProvider();
38+
const provider = new NodeTracerProvider({
39+
spanProcessors: [
40+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
41+
],
42+
});
3943

40-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
4144
provider.register();
4245

4346
registerInstrumentations({

plugins/node/opentelemetry-instrumentation-generic-pool/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
2727
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
2828
const { GenericPoolInstrumentation } = require('@opentelemetry/instrumentation-generic-pool');
2929

30-
const provider = new NodeTracerProvider();
30+
const provider = new NodeTracerProvider({
31+
spanProcessors: [
32+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
33+
],
34+
});
3135

32-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
3336
provider.register();
3437

3538
registerInstrumentations({

plugins/node/opentelemetry-instrumentation-knex/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk
2727
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
2828
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
2929

30-
const provider = new NodeTracerProvider();
30+
const provider = new NodeTracerProvider({
31+
spanProcessors: [
32+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
33+
],
34+
});
3135

32-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
3336
provider.register();
3437

3538
registerInstrumentations({

plugins/node/opentelemetry-instrumentation-restify/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk
2727
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
2828
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
2929

30-
const provider = new NodeTracerProvider();
30+
const provider = new NodeTracerProvider({
31+
spanProcessors: [
32+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
33+
]
34+
});
3135

32-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
3336
provider.register();
3437

3538
registerInstrumentations({

plugins/node/opentelemetry-instrumentation-router/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
2727
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
2828
const { RouterInstrumentation } = require('@opentelemetry/instrumentation-router');
2929

30-
const provider = new NodeTracerProvider();
30+
const provider = new NodeTracerProvider({
31+
spanProcessors: [
32+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
33+
],
34+
});
3135

32-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
3336
provider.register();
3437

3538
registerInstrumentations({

plugins/web/opentelemetry-instrumentation-document-load/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ import { registerInstrumentations } from '@opentelemetry/instrumentation';
2626
import { B3Propagator } from '@opentelemetry/propagator-b3';
2727
import { CompositePropagator, W3CTraceContextPropagator } from '@opentelemetry/core';
2828

29-
const provider = new WebTracerProvider();
30-
31-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
29+
const provider = new WebTracerProvider({
30+
spanProcessors: [
31+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
32+
],
33+
});
3234

3335
provider.register({
3436
propagator: new CompositePropagator({

plugins/web/opentelemetry-instrumentation-long-task/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
2323
import { LongTaskInstrumentation } from '@opentelemetry/instrumentation-long-task';
2424
import { registerInstrumentations } from '@opentelemetry/instrumentation';
2525

26-
const provider = new WebTracerProvider();
27-
28-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
26+
const provider = new WebTracerProvider({
27+
spanProcessors: [
28+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
29+
],
30+
});
2931

3032
registerInstrumentations({
3133
tracerProvider: provider,

plugins/web/opentelemetry-instrumentation-user-interaction/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@ import { registerInstrumentations } from '@opentelemetry/instrumentation';
3232
// import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep';
3333

3434
const provider = new WebTracerProvider({
35-
contextManager: new ZoneContextManager()
35+
contextManager: new ZoneContextManager(),
36+
spanProcessors: [
37+
new SimpleSpanProcessor(new ConsoleSpanExporter()),
38+
],
3639
});
3740

38-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
3941
provider.register();
4042

4143
registerInstrumentations({

0 commit comments

Comments
 (0)