Skip to content

Commit 7287dcb

Browse files
authored
fix: update typescript getting-started tracing example and docs (#2504)
1 parent be52259 commit 7287dcb

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

getting-started/ts-example/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,17 @@ This guide uses the example application provided in the [example directory](exam
5454

5555
([link to JavaScript version](../README.md#install-the-required-opentelemetry-libraries))
5656

57-
To create traces on NodeJS, you will need `@opentelemetry/sdk-trace-node`, `@opentelemetry/core`, and any plugins required by your application such as gRPC, or HTTP. If you are using the example application, you will need to install `@opentelemetry/plugin-http`.
57+
To create traces on NodeJS, you will need `@opentelemetry/sdk-trace-node`, `@opentelemetry/api`, and any plugins required by your application such as gRPC, or HTTP. If you are using the example application, you will need to install `@opentelemetry/instrumentation-http` and `@opentelemetry/instrumentation-express`.
5858

5959
```sh
6060
$ npm install \
61-
@opentelemetry/core \
61+
@opentelemetry/api \
6262
@opentelemetry/sdk-trace-node \
6363
@opentelemetry/instrumentation \
6464
@opentelemetry/instrumentation-http \
65-
@opentelemetry/instrumentation-express
65+
@opentelemetry/instrumentation-express \
66+
@@opentelemetry/resources \
67+
@opentelemetry/semantic-conventions
6668
```
6769

6870
#### Initialize a global tracer
@@ -74,16 +76,16 @@ All tracing initialization should happen before your application’s code runs.
7476
Create a file named `tracing.ts` and add the following code:
7577

7678
```typescript
77-
import { LogLevel } from '@opentelemetry/core';
79+
import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
7880
import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
7981
import { registerInstrumentations } from '@opentelemetry/instrumentation';
8082
import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
8183
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
8284

8385

84-
const provider: NodeTracerProvider = new NodeTracerProvider({
85-
logLevel: LogLevel.ERROR,
86-
});
86+
const provider: NodeTracerProvider = new NodeTracerProvider();
87+
88+
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
8789

8890
provider.register();
8991

@@ -120,26 +122,26 @@ $ # npm install @opentelemetry/exporter-jaeger
120122
After these dependencies are installed, we will need to initialize and register them. Modify `tracing.ts` so that it matches the following code snippet, replacing the service name `"getting-started"` with your own service name if you wish.
121123

122124
```typescript
123-
import { LogLevel } from '@opentelemetry/core';
125+
import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
124126
import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
125-
127+
import { registerInstrumentations } from '@opentelemetry/instrumentation';
128+
import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
129+
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
130+
import { Resource } from '@opentelemetry/resources'
131+
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
126132
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
127133
import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';
128134
// For Jaeger, use the following line instead:
129135
// import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
130136

131-
import { registerInstrumentations } from '@opentelemetry/instrumentation';
132-
import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
133-
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
134-
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
135-
136137
const provider: NodeTracerProvider = new NodeTracerProvider({
137-
logLevel: LogLevel.ERROR,
138138
resource: new Resource({
139139
[SemanticResourceAttributes.SERVICE_NAME]: 'getting-started',
140140
}),
141141
});
142142

143+
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
144+
143145
provider.addSpanProcessor(
144146
new SimpleSpanProcessor(
145147
new ZipkinExporter({
@@ -151,7 +153,6 @@ provider.addSpanProcessor(
151153
}),
152154
),
153155
);
154-
155156
provider.register();
156157

157158
registerInstrumentations({
@@ -161,7 +162,6 @@ registerInstrumentations({
161162
],
162163
});
163164

164-
165165
console.log('tracing initialized');
166166
```
167167

getting-started/ts-example/traced-example/tracing.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
1+
import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
12
import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
2-
3+
import { registerInstrumentations } from '@opentelemetry/instrumentation';
4+
import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
5+
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
6+
import { Resource } from '@opentelemetry/resources'
7+
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
38
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
49
import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';
5-
6-
const { Resource } = require('@opentelemetry/resources');
7-
const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
810
// For Jaeger, use the following line instead:
911
// import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
1012

11-
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
12-
const { ExpressInstrumentation } = require('@opentelemetry/instrumentation-express');
13-
const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
14-
1513
const provider: NodeTracerProvider = new NodeTracerProvider({
1614
resource: new Resource({
1715
[SemanticResourceAttributes.SERVICE_NAME]: 'getting-started',
1816
}),
1917
});
18+
19+
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
20+
2021
provider.addSpanProcessor(
2122
new SimpleSpanProcessor(
2223
new ZipkinExporter({
@@ -37,4 +38,4 @@ registerInstrumentations({
3738
],
3839
});
3940

40-
console.log('tracing initialized');
41+
console.log('tracing initialized');

0 commit comments

Comments
 (0)