From 1f15faf5b72990adc2ab216edc775f88d4a40842 Mon Sep 17 00:00:00 2001
From: Nev Wylie <54870357+MSNev@users.noreply.github.com>
Date: Wed, 9 Oct 2024 11:22:04 -0700
Subject: [PATCH] docs: [Browser] Define the support browser runtimes
---
CHANGELOG.md | 2 +
README_NEXT.md | 366 +++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 368 insertions(+)
create mode 100644 README_NEXT.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 93f5f64d0e..0addc4bb6e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -25,6 +25,8 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
### :books: (Refine Doc)
+* docs: [Browser] Define the support browser runtimes [Issue #4168](https://github.com/open-telemetry/opentelemetry-js/issues/4168) PR:[#5059](https://github.com/open-telemetry/opentelemetry-js/pull/5059) @MSNev
+
### :house: (Internal)
* deps: set `@opentelemetry/api` dependency min version to 1.3.0 in `examples`, `experimental/packages`, `integration-tests` and `selenium-tests`
diff --git a/README_NEXT.md b/README_NEXT.md
new file mode 100644
index 0000000000..fe3fdafec0
--- /dev/null
+++ b/README_NEXT.md
@@ -0,0 +1,366 @@
+
+---
+
+
+ Getting Started
+ •
+ API and SDK Reference
+
+
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+ 
+
+ 
+
+
+
+
+ Contributing
+ •
+ Examples
+
+
+
+---
+
+## About this project
+
+This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces, metrics, and logs from applications.
+
+## Quick Start
+
+**Much of OpenTelemetry JS documentation is written assuming the compiled application is run as CommonJS.**
+For more details on ECMAScript Modules vs CommonJS, refer to [esm-support](https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/esm-support.md).
+
+The following describes how to set up tracing for a basic web application.
+For more detailed documentation, see the website at .
+
+### Installation
+
+Dependencies with the `latest` tag on NPM should be compatible with each other.
+See the [version compatibility matrix](#package-version-compatibility) below for more information.
+
+```shell
+npm install --save @opentelemetry/api
+npm install --save @opentelemetry/sdk-node
+npm install --save @opentelemetry/auto-instrumentations-node
+```
+
+**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.
+
+### Set up Tracing
+
+```js
+// tracing.js
+
+'use strict'
+
+const process = require('process');
+const opentelemetry = require('@opentelemetry/sdk-node');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-base');
+const { Resource } = require('@opentelemetry/resources');
+const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
+
+// configure the SDK to export telemetry data to the console
+// enable all auto-instrumentations from the meta package
+const traceExporter = new ConsoleSpanExporter();
+const sdk = new opentelemetry.NodeSDK({
+ resource: new Resource({
+ [SEMRESATTRS_SERVICE_NAME]: 'my-service',
+ }),
+ traceExporter,
+ instrumentations: [getNodeAutoInstrumentations()]
+});
+
+// initialize the SDK and register with the OpenTelemetry API
+// this enables the API to record telemetry
+sdk.start();
+
+// gracefully shut down the SDK on process exit
+process.on('SIGTERM', () => {
+ sdk.shutdown()
+ .then(() => console.log('Tracing terminated'))
+ .catch((error) => console.log('Error terminating tracing', error))
+ .finally(() => process.exit(0));
+});
+```
+
+### Run Your Application
+
+```shell
+node -r ./tracing.js app.js
+```
+
+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/languages/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]
+
+## Library Author
+
+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 uses a different SDK implementation.
+
+## Supported Runtimes
+
+| Platform Version | Supported |
+| ------------------- | --------------------------------------------- |
+| Node.JS `v22` | :heavy_check_mark: |
+| Node.JS `v20` | :heavy_check_mark: |
+| 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 |
+
+### 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.
+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
+
+> [!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].
+
+Rather that define versions of specific browsers / runtimes, OpenTelemetry sets the minimum supported version based on the
+underlying Language features used.
+
+The current minumum language feature support is set as [ECMAScript 2020](https://262.ecma-international.org/11.0/) that are available
+in all modern browsers / runtimes.
+
+This means that if you are targeting or your end-users are using a browser / runtime that does not support ES2020, you will need
+to transpile the code and provide any necessary polyfill's for the missing features to ensure compatibility with your target
+environments. Any support issues that arise from using a browser or runtime that does not support ES2020 will be closed as "won't fix".
+
+This minimum support level is subject to change as the project evolves and as the underlying language features evolve.
+
+## Package Version Compatibility
+
+OpenTelemetry is released as a set of distinct packages in 3 categories: API, stable SDK, and experimental.
+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.
+There may also be API packages for experimental signals in the experimental directory.
+All stable packages are released with the same version, and all experimental packages are released with the same version.
+The below table describes which versions of each set of packages are expected to work together.
+
+| Stable Packages | Experimental Packages |
+| --------------- | --------------------- |
+| 1.21.x | 0.48.x |
+| 1.20.x | 0.47.x |
+| 1.19.x | 0.46.x |
+| 1.18.x | 0.45.x |
+| 1.17.x | 0.44.x |
+
+
+Older version compatibility matrix
+
+
+| Stable Packages | Experimental Packages |
|---|
+| 1.16.x | 0.42.x |
+| 1.15.x | 0.41.x |
+| 1.14.x | 0.40.x |
+| 1.13.x | 0.39.x |
+| 1.12.x | 0.38.x |
+| 1.11.x | 0.37.x |
+| 1.10.x | 0.36.x |
+| 1.9.x | 0.35.x |
+| 1.8.x (this and later versions require API >=1.3.0 for metrics) | 0.34.x |
+| 1.7.x | 0.33.x |
+| 1.6.x | 0.32.x |
+| 1.5.x | 0.31.x |
+| 1.4.x | 0.30.x |
+| 1.3.x | 0.29.x |
+| 1.2.x | 0.29.x |
+| 1.1.x | 0.28.x |
+| 1.0.x | 0.27.x |
+| 1.0.x (this and later versions require API >=1.0.0 for traces) | 0.26.x |
+
+
+
+
+## Versioning
+
+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.
+
+## Feature Status
+
+| Signal | API Status | SDK Status |
+| ------- | ----------- | ----------- |
+| Tracing | Stable | Stable |
+| Metrics | Stable | Stable |
+| Logs | Development | Development |
+
+For a more detailed breakdown of feature support see the [specification compliance matrix][compliance-matrix].
+
+## Contributing
+
+We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and
+[good first issue][good-first-issues] to get started with the project. For
+instructions to build and make changes to this project, see the
+[CONTRIBUTING][CONTRIBUTING] guide.
+
+We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#javascript-sdk) for meeting details and notes.
+
+### Community members
+
+#### Maintainers ([@open-telemetry/javascript-maintainers](https://github.com/orgs/open-telemetry/teams/javascript-maintainers))
+
+- [Amir Blum](https://github.com/blumamir), Odigos
+- [Chengzhong Wu](https://github.com/legendecas), Bloomberg
+- [Daniel Dyla](https://github.com/dyladan), Dynatrace
+- [Jamie Danielson](https://github.com/JamieDanielson), Honeycomb
+- [Marc Pichler](https://github.com/pichlermarc), Dynatrace
+- [Trent Mick](https://github.com/trentm), Elastic
+
+*Find more about the maintainer role in the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).*
+
+#### Approvers ([@open-telemetry/javascript-approvers](https://github.com/orgs/open-telemetry/teams/javascript-approvers))
+
+- [David Luna](https://github.com/david-luna), Elastic
+- [Hector Hernandez](https://github.com/hectorhdzg), Microsoft
+- [Martin Kuba](https://github.com/martinkuba), Lightstep
+- [Matthew Wear](https://github.com/mwear), LightStep
+- [Naseem K. Ullah](https://github.com/naseemkullah), Transit
+- [Neville Wylie](https://github.com/MSNev), Microsoft
+- [Purvi Kanal](https://github.com/pkanal), Honeycomb
+- [Svetlana Brennan](https://github.com/svetlanabrennan), New Relic
+
+*Find more about the approver role in the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver).*
+
+#### Triager ([@open-telemetry/javascript-triagers](https://github.com/orgs/open-telemetry/teams/javascript-triagers))
+
+- [Marylia Gutierrez](https://github.com/maryliag), Grafana Labs
+
+*Find more about the triager role in the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#triager).*
+
+#### Emeriti
+
+- [Bartlomiej Obecny](https://github.com/obecny), LightStep, Maintainer
+- [Daniel Khan](https://github.com/dkhan), Dynatrace, Maintainer
+- [Mayur Kale](https://github.com/mayurkale22), Google, Maintainer
+- [Rauno Viskus](https://github.com/rauno56), Maintainer
+- [Valentin Marchaud](https://github.com/vmarchaud), Maintainer
+- [Brandon Gonzalez](https://github.com/bg451), LightStep, Approver
+- [Roch Devost](https://github.com/rochdev), DataDog, Approver
+- [John Bley](https://github.com/johnbley), Splunk, Approver
+- [Mark Wolff](https://github.com/markwolff), Microsoft, Approver
+- [Olivier Albertini](https://github.com/OlivierAlbertini), Ville de Montréal, Approver
+- [Gerhard Stöbich](https://github.com/Flarna), Dynatrace, Approver
+- [Haddas Bronfman](https://github.com/haddasbronfman), Cisco, Approver
+
+*Find more about the emeritus role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#emeritus-maintainerapprovertriager).*
+
+#### Thanks to all the people who already contributed
+
+
+ 
+
+
+## Packages
+
+### API
+
+| Package | Description |
+| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [@opentelemetry/api][otel-api] | This package provides TypeScript interfaces, enums and no-op implementations for the OpenTelemetry core trace and metrics model. It is intended for use both on the server and in the browser. |
+| [@opentelemetry/core][otel-core] | This package provides default and no-op implementations of the OpenTelemetry api for trace and metrics. It's intended for use both on the server and in the browser. |
+
+### Implementation / SDKs
+
+| Package | Description |
+| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [@opentelemetry/sdk-trace-base][otel-tracing] | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation by default. It is intended for use both on the server and in the browser. |
+| [@opentelemetry/sdk-metrics][otel-metrics] | This module provides instruments and meters for reporting of time series data. |
+| [@opentelemetry/sdk-trace-node][otel-node] | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
+| [@opentelemetry/sdk-trace-web][otel-web] | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only. |
+
+### Compatible Exporters
+
+OpenTelemetry is vendor-agnostic and can upload data to any backend with various exporter implementations. Even though, OpenTelemetry provides support for many backends, vendors/users can also implement their own exporters for proprietary and unofficially supported backends.
+
+See the [OpenTelemetry registry](https://opentelemetry.io/registry/?language=js&component=exporter#) for a list of exporters available.
+
+### Instrumentations
+
+OpenTelemetry can collect tracing data automatically using instrumentations.
+
+To request automatic tracing support for a module not on this list, please [file an issue](https://github.com/open-telemetry/opentelemetry-js/issues). Alternatively, Vendor/Users can [write an instrumentation yourself](https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/instrumentation-guide.md).
+
+Currently, OpenTelemetry supports automatic tracing for:
+
+#### Node Instrumentations
+
+##### Core
+
+- [@opentelemetry/instrumentation-grpc][otel-instrumentation-grpc]
+- [@opentelemetry/instrumentation-http][otel-instrumentation-http]
+
+##### Contrib
+
+These instrumentations are hosted at
+
+#### Web Instrumentations
+
+##### Core
+
+- [@opentelemetry/instrumentation-xml-http-request][otel-instrumentation-xml-http-request]
+- [@opentelemetry/instrumentation-fetch][otel-instrumentation-fetch]
+
+##### Contrib
+
+These instrumentations are hosted at
+
+### Shims
+
+| Package | Description |
+| -------------------------------------------------------- | --------------------------------------------------------------------------------------- |
+| [@opentelemetry/shim-opentracing][otel-shim-opentracing] | OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry |
+
+## Useful links
+
+- Upgrade guidelines: [Upgrade Guide](./doc/upgrade-guide.md)
+- For more information on OpenTelemetry, visit:
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
+[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
+[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
+
+[otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/sdk-metrics
+[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
+
+[otel-instrumentation-fetch]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-fetch
+[otel-instrumentation-grpc]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-grpc
+[otel-instrumentation-http]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http
+[otel-instrumentation-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-xml-http-request
+
+[otel-shim-opentracing]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-shim-opentracing
+[otel-tracing]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-base
+[otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web
+[otel-api]: https://github.com/open-telemetry/opentelemetry-js/tree/main/api
+[otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core
+
+[spec-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md