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

docs(README): clarify browser support #4037

Merged
merged 6 commits into from
Aug 7, 2023
Merged

docs(README): clarify browser support #4037

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6e0cf5e
docs(README): clarify browser support, mention logs in intro text
pichlermarc Aug 4, 2023
6a94a34
fix: formatting
pichlermarc Aug 4, 2023
bfe3730
docs: fix checkmarks in supported runtimes table
pichlermarc Aug 7, 2023
5f7a934
apply suggestion
pichlermarc Aug 7, 2023
87ff101
docs: wording
pichlermarc Aug 7, 2023
c57d499
docs: wording
pichlermarc Aug 7, 2023
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
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

## About this project

This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces and metrics from applications.
This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces, metrics and logs from applications.
pichlermarc marked this conversation as resolved.
Show resolved Hide resolved

## Quick Start

Expand Down Expand Up @@ -109,24 +109,29 @@ If you are a library author looking to build OpenTelemetry into your library, pl

## Supported Runtimes

| Platform Version | Supported |
| ------------------- | ----------------------------------------------- |
| Node.JS `v18` | ✅ |
| Node.JS `v16` | ✅ |
| Node.JS `v14` | ✅ |
| Older Node Versions | See [Node Support](#node-support) |
| Web Browsers | ✅ See [Browser Support](#browser-support) below |
| Platform Version | Supported |
|---------------------|-----------------------------------------------|
| Node.JS `v18` | ✅ |
| Node.JS `v16` | ✅ |
| Node.JS `v14` | ✅ |
pichlermarc marked this conversation as resolved.
Show resolved Hide resolved
| Older Node Versions | See [Node Support](#node-support) |
| Web Browsers | See [Browser Support](#browser-support) below |

### Node Support

Only Node.js Active or Maintenance LTS versions are supported.
Previous versions of node *may* work, but they are not tested by OpenTelemetry and they are not guaranteed to work.
Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, because OpenTelemetry Node depends on the `perf_hooks` module introduced in `v8.5.0` and `performance.timeOrigin` that is set correctly starting in `v8.12.0`.
Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, because OpenTelemetry Node depends on the
pichlermarc marked this conversation as resolved.
Show resolved Hide resolved
`perf_hooks` module introduced in `v8.5.0` and `performance.timeOrigin` that is set correctly starting in `v8.12.0`.

### Browser Support

Automated browser tests are run in the latest version of Headless Chrome.
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.
> [!IMPORTANT]
pichlermarc marked this conversation as resolved.
Show resolved Hide resolved
> Client instrumentation for the browser is **experimental** and mostly **unspecified**. If you are interested in
> helping out, get in touch with the [Client Instrumentation SIG][client-instrumentation-sig]
pichlermarc marked this conversation as resolved.
Show resolved Hide resolved

There is currently no list of officially supported browsers. OpenTelemetry is developed using standard web
technologies and aims to work in currently supported versions of major browsers.

## Package Version Compatibility

Expand Down Expand Up @@ -552,6 +557,8 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[up-for-grabs-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs
[good-first-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

[client-instrumentation-sig]: https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit

[docs]: https://open-telemetry.github.io/opentelemetry-js
[compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
[CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
Expand Down