Skip to content

Commit bdc603c

Browse files
dyladandyladan
authored
Update README (open-telemetry#3369)
1 parent 2cee814 commit bdc603c

File tree

2 files changed

+34
-38
lines changed

2 files changed

+34
-38
lines changed

Diff for: ‎README.md

+33-37
Original file line numberDiff line numberDiff line change
@@ -41,43 +41,15 @@
4141

4242
This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces and metrics from applications.
4343

44-
## Compatibility Matrix
45-
46-
| API Version | Core version | Experimental Packages |
47-
| ----------- | ------------ | --------------------- |
48-
| 1.2.x | 1.7.x | 0.33.x |
49-
| 1.2.x | 1.6.x | 0.32.x |
50-
| 1.1.x | 1.5.x | 0.31.x |
51-
| 1.1.x | 1.4.x | 0.30.x |
52-
| 1.1.x | 1.2.x, 1.3.x | 0.29.x |
53-
| 1.1.x | 1.1.x | 0.28.x |
54-
| 1.0.x | 1.0.x | 0.26.x, 0.27.x |
55-
| 1.0.x | 0.26.x | ----- |
56-
| 1.0.x | 0.25.x | ----- |
57-
| 1.0.x | 0.24.x | ----- |
58-
| 1.0.x | 0.23.x | ----- |
59-
| 1.0.x | 0.22.x | ----- |
60-
| 0.21.x | 0.21.x | ----- |
61-
| 0.20.x | 0.20.x | ----- |
62-
| v1.0.0-rc.3 | 0.19.x | ----- |
63-
| 0.18.x | 0.18.x | ----- |
64-
| | 0.17.x | ----- |
65-
| | 0.16.x | ----- |
66-
| | 0.15.x | ----- |
67-
| | 0.14.x | ----- |
68-
| | 0.13.x | ----- |
69-
| | 0.12.x | ----- |
70-
| | 0.11.x | ----- |
44+
## Quick Start
7145

72-
## Versioning
73-
74-
The current version for each package can be found in the respective `package.json` file for that module. For additional details see the [versioning and stability][spec-versioning] document in the specification.
46+
The following describes how to set up tracing for a basic web application.
47+
For more detailed documentation, see the website at <https://opentelemetry.io/docs/instrumentation/js/>.
7548

76-
## Quick start
49+
### Installation
7750

78-
### Application Owner
79-
80-
#### Install Dependencies
51+
Dependencies with the `latest` tag on NPM should be compatible with each other.
52+
See the [version compatibility matrix](#package-version-compatibility) below for more information.
8153

8254
```shell
8355
npm install --save @opentelemetry/api
@@ -87,7 +59,7 @@ npm install --save @opentelemetry/auto-instrumentations-node
8759

8860
**Note:** `auto-instrumentations-node` is a meta package from [opentelemetry-js-contrib](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node) that provides a simple way to initialize multiple Node.js instrumentations.
8961

90-
#### Instantiate Tracing
62+
### Set up Tracing
9163

9264
```js
9365
// tracing.js
@@ -127,15 +99,15 @@ process.on('SIGTERM', () => {
12799
});
128100
```
129101

130-
#### Run Your Application
102+
### Run Your Application
131103

132104
```shell
133105
node -r ./tracing.js app.js
134106
```
135107

136108
The above example will emit auto-instrumented telemetry about your Node.js application to the console. For a more in-depth example, see the [Getting Started Guide](https://opentelemetry.io/docs/js/getting-started/). For more information about automatic instrumentation see [@opentelemetry/sdk-trace-node][otel-node], which provides auto-instrumentation for Node.js applications. If the automatic instrumentation does not suit your needs, or you would like to create manual traces, see [@opentelemetry/sdk-trace-base][otel-tracing]
137109

138-
### Library Author
110+
## Library Author
139111

140112
If you are a library author looking to build OpenTelemetry into your library, please see [the documentation][docs]. As a library author, it is important that you only depend on properties and methods published on the public API. If you use any properties or methods from the SDK that are not officially a part of the public API, your library may break if an [Application Owner](#application-owner) uses a different SDK implementation.
141113

@@ -160,6 +132,30 @@ Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, becaus
160132
Automated browser tests are run in the latest version of Headless Chrome.
161133
There is currently no list of officially supported browsers, but OpenTelemetry is developed using standard web technologies with wide support and should work in currently supported versions of major browsers.
162134

135+
## Package Version Compatibility
136+
137+
OpenTelemetry is released as a set of distinct packages in 3 categories: API, stable SDK, and experimental.
138+
The API is located at [/api](/api/), the stable SDK packages are in the [/packages](/packages/) directory, and the experimental packages are listed in the [/experimental/packages](/experimental/packages/) directory.
139+
There may also be API packages for experimental signals in the experimental directory.
140+
All stable packages are released with the same version, and all experimental packages are released with the same version.
141+
The below table describes which versions of each set of packages are expected to work together.
142+
143+
| API | Stable Packages | Experimental Packages |
144+
| ----- | --------------- | --------------------- |
145+
| 1.2.x | 1.7.x | 0.33.x |
146+
| 1.2.x | 1.6.x | 0.32.x |
147+
| 1.1.x | 1.5.x | 0.31.x |
148+
| 1.1.x | 1.4.x | 0.30.x |
149+
| 1.1.x | 1.3.x | 0.29.x |
150+
| 1.1.x | 1.2.x | 0.29.x |
151+
| 1.1.x | 1.1.x | 0.28.x |
152+
| 1.0.x | 1.0.x | 0.27.x |
153+
| 1.0.x | 1.0.x | 0.26.x |
154+
155+
## Versioning
156+
157+
The current version for each package can be found in the respective `package.json` file for that module. For additional details see the [versioning and stability][spec-versioning] document in the specification.
158+
163159
## Feature Status
164160

165161
| Signal | API Status | SDK Status |

Diff for: ‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"codecov:browser": "lerna run codecov:browser",
2424
"codecov:webworker": "lerna run codecov:webworker",
2525
"predocs-test": "npm run docs",
26-
"docs": "typedoc && touch docs/.nojekyll",
26+
"docs": "typedoc --readme none && touch docs/.nojekyll",
2727
"docs-deploy": "gh-pages --dotfiles --dist docs",
2828
"docs:test": "linkinator docs --silent --retry && linkinator doc/*.md --silent --retry",
2929
"lint": "lerna run lint",

0 commit comments

Comments
 (0)