From 6e0cf5e2c07c7efac61c20352fec34e5ec94ed64 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Fri, 4 Aug 2023 09:56:52 +0200 Subject: [PATCH 1/6] docs(README): clarify browser support, mention logs in intro text --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ca72796747..f3fca3ee93 100644 --- a/README.md +++ b/README.md @@ -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. ## Quick Start @@ -109,24 +109,30 @@ 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` | ✅ | +| 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 +`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] +> 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] + +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 @@ -552,6 +558,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 From 6a94a34939cd6b887f216011c62ccbace85f14b8 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Fri, 4 Aug 2023 10:20:45 +0200 Subject: [PATCH 2/6] fix: formatting --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f3fca3ee93..226d11a034 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,6 @@ If you are a library author looking to build OpenTelemetry into your library, pl ## Supported Runtimes - | Platform Version | Supported | |---------------------|-----------------------------------------------| | Node.JS `v18` | ✅ | From bfe37301cf18363d090e6ecf23ef4130e7023365 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Mon, 7 Aug 2023 11:23:28 +0200 Subject: [PATCH 3/6] docs: fix checkmarks in supported runtimes table --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 226d11a034..4b643d0645 100644 --- a/README.md +++ b/README.md @@ -111,9 +111,9 @@ If you are a library author looking to build OpenTelemetry into your library, pl | Platform Version | Supported | |---------------------|-----------------------------------------------| -| Node.JS `v18` | ✅ | -| Node.JS `v16` | ✅ | -| Node.JS `v14` | ✅ | +| Node.JS `v18` | :heavy_check_mark: | +| Node.JS `v16` | :heavy_check_mark: | +| Node.JS `v14` | :heavy_check_mark: | | Older Node Versions | See [Node Support](#node-support) | | Web Browsers | See [Browser Support](#browser-support) below | From 5f7a93497dcc762bb5b0f147ce20cfd04cf69759 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Mon, 7 Aug 2023 11:35:34 +0200 Subject: [PATCH 4/6] apply suggestion Co-authored-by: Patrice Chalin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b643d0645..1314640731 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, becaus > [!IMPORTANT] > 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] +> helping out, get in touch with the [Client Instrumentation SIG][client-instrumentation-sig]. 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. From 87ff1015afe50fd8f2650e85f12fac18ee0da6aa Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Mon, 7 Aug 2023 11:35:56 +0200 Subject: [PATCH 5/6] docs: wording Co-authored-by: Patrice Chalin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1314640731..ee5dce99a6 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ If you are a library author looking to build OpenTelemetry into your library, pl 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 +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`. ### Browser Support From c57d4994b990bcb6f77fc1ae84ad29d99dd95e19 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Mon, 7 Aug 2023 11:36:14 +0200 Subject: [PATCH 6/6] docs: wording Co-authored-by: Patrice Chalin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee5dce99a6..370dfb17d9 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ ## About this project -This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces, metrics and logs from applications. +This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces, metrics, and logs from applications. ## Quick Start