Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[javascript] discontinue use of deprecated APIs #6416

Merged
merged 4 commits into from
Feb 27, 2025
Merged

[javascript] discontinue use of deprecated APIs #6416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
756341a
docs(js-exporters): stop using deprecated options in NodeSDK constructor
pichlermarc Feb 25, 2025
67f46be
docs(js-instrumentation): stop using addSpanProcessor, BasicTracerPro…
pichlermarc Feb 25, 2025
f33e3cf
docs(js-serverless): stop using addSpanProcessor, update versions
pichlermarc Feb 25, 2025
ae862b7
docs(demo-frontend-service): stop using addSpanProcessor
pichlermarc Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions content/en/docs/demo/services/frontend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,9 @@ const FrontendTracer = async () => {
resource: new Resource({
[SEMRESATTRS_SERVICE_NAME]: process.env.NEXT_PUBLIC_OTEL_SERVICE_NAME,
}),
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should be the snippet of FrontendTracer.ts.
But it seems it is already out-of-date, so I won't block this PR.

I've created the issue open-telemetry/opentelemetry-demo#2080 to follow-up on the Demo repo.

});

provider.addSpanProcessor(new SimpleSpanProcessor(new OTLPTraceExporter()));

const contextManager = new ZoneContextManager();

provider.register({
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/js/exporters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';

const sdk = new NodeSDK({
spanProcessor: new SimpleSpanProcessor(exporter),
spanProcessors: [new SimpleSpanProcessor(exporter)],
instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
Expand All @@ -371,7 +371,7 @@ const {
} = require('@opentelemetry/auto-instrumentations-node');

const sdk = new opentelemetry.NodeSDK({
spanProcessor: new SimpleSpanProcessor(exporter)
spanProcessors: [new SimpleSpanProcessor(exporter)],
instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
Expand Down
54 changes: 40 additions & 14 deletions content/en/docs/languages/js/instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,12 +367,13 @@ const resource = Resource.default().merge(
}),
);

const exporter = new ConsoleSpanExporter();
const processor = new BatchSpanProcessor(exporter);

const provider = new WebTracerProvider({
resource: resource,
spanProcessors: [processor],
});
const exporter = new ConsoleSpanExporter();
const processor = new BatchSpanProcessor(exporter);
provider.addSpanProcessor(processor);

provider.register();
```
Expand All @@ -399,12 +400,13 @@ const resource = Resource.default().merge(
}),
);

const exporter = new ConsoleSpanExporter();
const processor = new BatchSpanProcessor(exporter);

const provider = new WebTracerProvider({
resource: resource,
spanProcessors: [processor],
});
const exporter = new ConsoleSpanExporter();
const processor = new BatchSpanProcessor(exporter);
provider.addSpanProcessor(processor);

provider.register();
```
Expand Down Expand Up @@ -1125,17 +1127,29 @@ Initializing tracing is similar to how you'd do it with Node.js or the Web SDK.

```ts
import opentelemetry from '@opentelemetry/api';
import {
CompositePropagator,
W3CTraceContextPropagator,
W3CBaggagePropagator,
} from '@opentelemetry/core';
import {
BasicTracerProvider,
BatchSpanProcessor,
ConsoleSpanExporter,
} from '@opentelemetry/sdk-trace-base';

const provider = new BasicTracerProvider();
opentelemetry.trace.setGlobalTracerProvider(
new BasicTracerProvider({
// Configure span processor to send spans to the exporter
spanProcessors: [new BatchSpanProcessor(new ConsoleSpanExporter())],
}),
);

// Configure span processor to send spans to the exporter
provider.addSpanProcessor(new BatchSpanProcessor(new ConsoleSpanExporter()));
provider.register();
opentelemetry.propagation.setGlobalPropagator(
new CompositePropagator({
propagators: [new W3CTraceContextPropagator(), new W3CBaggagePropagator()],
}),
);

// This is what we'll access in all instrumentation code
const tracer = opentelemetry.trace.getTracer('example-basic-tracer-node');
Expand All @@ -1145,17 +1159,29 @@ const tracer = opentelemetry.trace.getTracer('example-basic-tracer-node');

```js
const opentelemetry = require('@opentelemetry/api');
const {
CompositePropagator,
W3CTraceContextPropagator,
W3CBaggagePropagator,
} = require('@opentelemetry/core');
const {
BasicTracerProvider,
ConsoleSpanExporter,
BatchSpanProcessor,
} = require('@opentelemetry/sdk-trace-base');

const provider = new BasicTracerProvider();
opentelemetry.trace.setGlobalTracerProvider(
new BasicTracerProvider({
// Configure span processor to send spans to the exporter
spanProcessors: [new BatchSpanProcessor(new ConsoleSpanExporter())],
}),
);

// Configure span processor to send spans to the exporter
provider.addSpanProcessor(new BatchSpanProcessor(new ConsoleSpanExporter()));
provider.register();
opentelemetry.propagation.setGlobalPropagator(
new CompositePropagator({
propagators: [new W3CTraceContextPropagator(), new W3CBaggagePropagator()],
}),
);

// This is what we'll access in all instrumentation code
const tracer = opentelemetry.trace.getTracer('example-basic-tracer-node');
Expand Down
51 changes: 23 additions & 28 deletions content/en/docs/languages/js/serverless.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,15 @@ const {

api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.ALL);

const provider = new NodeTracerProvider();
const collectorOptions = {
url: '<backend_url>',
};

const spanProcessor = new BatchSpanProcessor(
new OTLPTraceExporter(collectorOptions),
new OTLPTraceExporter({
url: '<backend_url>',
}),
);

provider.addSpanProcessor(spanProcessor);
provider.register();
const provider = new NodeTracerProvider({
spanProcessors: [spanProcessor],
});

registerInstrumentations({
instrumentations: [
Expand Down Expand Up @@ -241,24 +239,21 @@ const {
getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');

const providerConfig = {
resource: new Resource({
[SEMRESATTRS_SERVICE_NAME]: '<your function name>',
}),
};

api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.ALL);

const provider = new NodeTracerProvider(providerConfig);
const collectorOptions = {
url: '<address for your backend>',
};

const spanProcessor = new BatchSpanProcessor(
new OTLPTraceExporter(collectorOptions),
);
const provider = new NodeTracerProvider({
resource: resourceFromAttributes({
[SEMRESATTRS_SERVICE_NAME]: '<your function name>',
}),
spanProcessors: [
new BatchSpanProcessor(new OTLPTraceExporter(collectorOptions)),
],
});

provider.addSpanProcessor(spanProcessor);
provider.register();

registerInstrumentations({
Expand All @@ -274,15 +269,15 @@ Add the following to your `package.json`:
{
"dependencies": {
"@google-cloud/functions-framework": "^3.0.0",
"@opentelemetry/api": "^1.3.0",
"@opentelemetry/auto-instrumentations-node": "^0.35.0",
"@opentelemetry/exporter-trace-otlp-http": "^0.34.0",
"@opentelemetry/instrumentation": "^0.34.0",
"@opentelemetry/sdk-node": "^0.34.0",
"@opentelemetry/sdk-trace-base": "^1.8.0",
"@opentelemetry/sdk-trace-node": "^1.8.0",
"@opentelemetry/resources": "^1.8.0",
"@opentelemetry/semantic-conventions": "^1.8.0"
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/auto-instrumentations-node": "^0.56.1",
"@opentelemetry/exporter-trace-otlp-http": "^0.57.2",
"@opentelemetry/instrumentation": "^0.57.2",
"@opentelemetry/sdk-node": "^0.57.2",
"@opentelemetry/sdk-trace-base": "^1.30.1",
"@opentelemetry/sdk-trace-node": "^1.30.1",
"@opentelemetry/resources": "^1.30.1",
"@opentelemetry/semantic-conventions": "^1.30.0"
}
}
```
Expand Down
Loading