Skip to content

Commit b09ee6f

Browse files
authored
chore: update the website getting started docs (#2306)
1 parent 2276e4f commit b09ee6f

File tree

4 files changed

+181
-236
lines changed

4 files changed

+181
-236
lines changed

getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To create traces on NodeJS, you need `@opentelemetry/node`, `@opentelemetry/core
5858

5959
```sh
6060
$ npm install \
61-
@opentelemetry/core \
61+
@opentelemetry/api \
6262
@opentelemetry/node \
6363
@opentelemetry/instrumentation-http \
6464
@opentelemetry/instrumentation-express \

website_docs/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ export data.
1212

1313
## Status and Releases
1414

15-
| Tracing | Metrics |
16-
| ------- | ------- |
17-
| Beta | Alpha |
15+
| | Tracing | Metrics |
16+
| ----- | ------- | ------- |
17+
| API | GA | Alpha |
18+
| SDK | Beta | Alpha |
1819

1920
You can find release information [here](https://github.com/open-telemetry/opentelemetry-js/releases)
2021

website_docs/getting_started/browser.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,24 @@ Add the following code to the `document-load.js` to create a tracer provider, wh
6969
```javascript
7070
// This is necessary for "parcel" to work OOTB. It is not needed for other build tools.
7171
import 'regenerator-runtime/runtime'
72-
import { LogLevel } from "@opentelemetry/core";
7372
import { WebTracerProvider } from '@opentelemetry/web';
7473
import { DocumentLoad } from '@opentelemetry/plugin-document-load';
74+
import { ZoneContextManager } from '@opentelemetry/context-zone';
75+
import { registerInstrumentations } from '@opentelemetry/instrumentation';
7576

76-
// Minimum required setup - supports only synchronous operations
77-
const provider = new WebTracerProvider({
78-
plugins: [
79-
new DocumentLoad()
80-
]
77+
const provider = new WebTracerProvider();
78+
79+
provider.register({
80+
// Changing default contextManager to use ZoneContextManager - supports asynchronous operations - optional
81+
contextManager: new ZoneContextManager(),
82+
});
83+
84+
// Registering instrumentations / plugins
85+
registerInstrumentations({
86+
instrumentations: [
87+
new DocumentLoad(),
88+
],
8189
});
82-
provider.register();
8390
```
8491

8592
Run `parcel index.html` and open the development webserver (e.g. at `http://localhost:1234`) to see if your code works.
@@ -93,19 +100,26 @@ To export traces, modify `document-load.js` so that it matches the following cod
93100
```javascript
94101
// This is necessary for "parcel" to work OOTB. It is not needed for other build tools.
95102
import 'regenerator-runtime/runtime'
96-
import { LogLevel } from "@opentelemetry/core";
103+
import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
97104
import { WebTracerProvider } from '@opentelemetry/web';
98105
import { DocumentLoad } from '@opentelemetry/plugin-document-load';
99-
import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
106+
import { ZoneContextManager } from '@opentelemetry/context-zone';
107+
import { registerInstrumentations } from '@opentelemetry/instrumentation';
100108

101-
// Minimum required setup - supports only synchronous operations
102-
const provider = new WebTracerProvider({
103-
plugins: [
104-
new DocumentLoad()
105-
]
109+
const provider = new WebTracerProvider();
110+
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
111+
112+
provider.register({
113+
// Changing default contextManager to use ZoneContextManager - supports asynchronous operations - optional
114+
contextManager: new ZoneContextManager(),
115+
});
116+
117+
// Registering instrumentations / plugins
118+
registerInstrumentations({
119+
instrumentations: [
120+
new DocumentLoad(),
121+
],
106122
});
107-
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()))
108-
provider.register();
109123
```
110124

111125
Now, rebuild your application and open the browser again. In the console of the developer toolbar you should see some traces being exporterd:

0 commit comments

Comments
 (0)