chore: update the website getting started docs (#2306)

open-telemetry · Jun 30, 2021 · b09ee6f · b09ee6f
1 parent 2276e4f
commit b09ee6f
Show file tree

Hide file tree

Showing 4 changed files with 181 additions and 236 deletions.
diff --git a/getting-started/README.md b/getting-started/README.md
@@ -58,7 +58,7 @@ To create traces on NodeJS, you need `@opentelemetry/node`, `@opentelemetry/core
 
 ```sh
 $ npm install \
-  @opentelemetry/core \
+  @opentelemetry/api \
   @opentelemetry/node \
   @opentelemetry/instrumentation-http \
   @opentelemetry/instrumentation-express \

diff --git a/website_docs/_index.md b/website_docs/_index.md
@@ -12,9 +12,10 @@ export data.
 
 ## Status and Releases
 
-| Tracing | Metrics |
-| ------- | ------- |
-| Beta    | Alpha   |
+|       | Tracing | Metrics |
+| ----- | ------- | ------- |
+| API   | GA      | Alpha   |
+| SDK   | Beta    | Alpha   |
 
 You can find release information [here](https://github.com/open-telemetry/opentelemetry-js/releases)
 

diff --git a/website_docs/getting_started/browser.md b/website_docs/getting_started/browser.md
@@ -69,17 +69,24 @@ Add the following code to the `document-load.js` to create a tracer provider, wh
 ```javascript
  // This is necessary for "parcel" to work OOTB. It is not needed for other build tools.
 import 'regenerator-runtime/runtime'
-import { LogLevel } from "@opentelemetry/core";
 import { WebTracerProvider } from '@opentelemetry/web';
 import { DocumentLoad } from '@opentelemetry/plugin-document-load';
+import { ZoneContextManager } from '@opentelemetry/context-zone';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
 
-// Minimum required setup - supports only synchronous operations
-const provider = new WebTracerProvider({
-  plugins: [
-    new DocumentLoad()
-  ]
+const provider = new WebTracerProvider();
+
+provider.register({
+  // Changing default contextManager to use ZoneContextManager - supports asynchronous operations - optional
+  contextManager: new ZoneContextManager(),
+});
+
+// Registering instrumentations / plugins
+registerInstrumentations({
+  instrumentations: [
+    new DocumentLoad(),
+  ],
 });
-provider.register();
 ```
 
 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
 ```javascript
  // This is necessary for "parcel" to work OOTB. It is not needed for other build tools.
 import 'regenerator-runtime/runtime'
-import { LogLevel } from "@opentelemetry/core";
+import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracerProvider } from '@opentelemetry/web';
 import { DocumentLoad } from '@opentelemetry/plugin-document-load';
-import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
+import { ZoneContextManager } from '@opentelemetry/context-zone';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
 
-// Minimum required setup - supports only synchronous operations
-const provider = new WebTracerProvider({
-  plugins: [
-    new DocumentLoad()
-  ]
+const provider = new WebTracerProvider();
+provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+
+provider.register({
+  // Changing default contextManager to use ZoneContextManager - supports asynchronous operations - optional
+  contextManager: new ZoneContextManager(),
+});
+
+// Registering instrumentations / plugins
+registerInstrumentations({
+  instrumentations: [
+    new DocumentLoad(),
+  ],
 });
-provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()))
-provider.register();
 ```
 
 Now, rebuild your application and open the browser again. In the console of the developer toolbar you should see some traces being exporterd: