diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md index 2fbf4716a2..5af78856dc 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md @@ -6,6 +6,8 @@ The OpenTelemetry Resource is an immutable representation of the entity producin [This document][resource-semantic_conventions] defines standard attributes for resources. +Supports OpenTelemetry JS SDK 1.0 + ## Installation ```bash diff --git a/detectors/node/opentelemetry-resource-detector-aws/README.md b/detectors/node/opentelemetry-resource-detector-aws/README.md index 4a75848c11..01b74e1446 100644 --- a/detectors/node/opentelemetry-resource-detector-aws/README.md +++ b/detectors/node/opentelemetry-resource-detector-aws/README.md @@ -9,6 +9,8 @@ Resource detector for Amazon Web Services. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/detectors/node/opentelemetry-resource-detector-gcp/README.md b/detectors/node/opentelemetry-resource-detector-gcp/README.md index 894982b0fa..8f242e64ce 100644 --- a/detectors/node/opentelemetry-resource-detector-gcp/README.md +++ b/detectors/node/opentelemetry-resource-detector-gcp/README.md @@ -7,6 +7,8 @@ Resource detector for Google Cloud Platform. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation The GCP resource detector requires Node.JS 10+ due to a dependency on [`gcp-metadata`][] which uses features only available in Node.JS 10+. diff --git a/detectors/node/opentelemetry-resource-detector-github/README.md b/detectors/node/opentelemetry-resource-detector-github/README.md index 419c1627cd..4c33aa9b6f 100644 --- a/detectors/node/opentelemetry-resource-detector-github/README.md +++ b/detectors/node/opentelemetry-resource-detector-github/README.md @@ -13,6 +13,8 @@ This is useful for collecting telemetry in GitHub Actions-powered CI/CD workflow The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/packages/opentelemetry-browser-extension-autoinjection/README.md b/packages/opentelemetry-browser-extension-autoinjection/README.md index eb4ab7627e..737171c282 100644 --- a/packages/opentelemetry-browser-extension-autoinjection/README.md +++ b/packages/opentelemetry-browser-extension-autoinjection/README.md @@ -2,6 +2,8 @@ This browser extension allows you to inject [OpenTelemetry](https://opentelemetry.io/) instrumentation in any web page. It uses the [Web SDK](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-web) and can export data to Zipkin or an OpenTelemetry Collector. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ![This animated image shows the process of activating the extension and seeing console output in the developer toolbar](./images/inject-opentelemetry.gif) ## Supported Environments diff --git a/packages/opentelemetry-host-metrics/README.md b/packages/opentelemetry-host-metrics/README.md index ede292cb59..0562e4da76 100644 --- a/packages/opentelemetry-host-metrics/README.md +++ b/packages/opentelemetry-host-metrics/README.md @@ -10,6 +10,8 @@ This module provides automatic collection of Host Metrics which includes metrics * Memory * Network +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/packages/opentelemetry-id-generator-aws-xray/README.md b/packages/opentelemetry-id-generator-aws-xray/README.md index f090c0a3e0..f9a9819f9c 100644 --- a/packages/opentelemetry-id-generator-aws-xray/README.md +++ b/packages/opentelemetry-id-generator-aws-xray/README.md @@ -12,6 +12,8 @@ trace followed by a unique identifier consisting of 12 bytes of randomly generat extension point which allows the usage of this custom IdGenerator as opposed to the out-of-the-box random IdGenerator, enabling compatibility with AWS X-Ray. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ### Installation ` diff --git a/packages/opentelemetry-test-utils/README.md b/packages/opentelemetry-test-utils/README.md index fdcb24e1aa..7b31ed3c33 100644 --- a/packages/opentelemetry-test-utils/README.md +++ b/packages/opentelemetry-test-utils/README.md @@ -3,6 +3,8 @@ This is a internal utils package used across the contrib packages. No guarantees are given to uses outside of [open-telemetry/opentelemetry-js-contrib](https://github.com/open-telemetry/opentelemetry-js-contrib/) repository. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Instrumentation Testing This package exports a mocha [root hook plugin](https://mochajs.org/#root-hook-plugins), which implements common boilerplate code a developer probably needs for writing instrumentation unit tests in node. diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md b/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md index fb42e93cef..02f36b656d 100644 --- a/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md @@ -11,6 +11,8 @@ This module provides automatic instrumentation for [`AWS Lambda`](https://docs.a This module is currently under active development and not ready for general use. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/README.md b/plugins/node/opentelemetry-instrumentation-bunyan/README.md index 1052e8ce01..9cf8702f89 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/README.md +++ b/plugins/node/opentelemetry-instrumentation-bunyan/README.md @@ -7,6 +7,8 @@ This module provides automatic instrumentation for injection of trace context to [`bunyan`](https://www.npmjs.com/package/bunyan). +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/README.md b/plugins/node/opentelemetry-instrumentation-cassandra/README.md index 88d8d44beb..eccacc9e38 100644 --- a/plugins/node/opentelemetry-instrumentation-cassandra/README.md +++ b/plugins/node/opentelemetry-instrumentation-cassandra/README.md @@ -7,6 +7,8 @@ This module provides automatic instrumentation for injection of trace context to [`cassandra-driver`](https://www.npmjs.com/package/cassandra-driver). +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-connect/README.md b/plugins/node/opentelemetry-instrumentation-connect/README.md index 3f3cb6ffe3..16bea1cfe3 100644 --- a/plugins/node/opentelemetry-instrumentation-connect/README.md +++ b/plugins/node/opentelemetry-instrumentation-connect/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`connect`](https://github.co For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will have spans that are not connected to each other. diff --git a/plugins/node/opentelemetry-instrumentation-dns/README.md b/plugins/node/opentelemetry-instrumentation-dns/README.md index 825413363d..7eba0bd037 100644 --- a/plugins/node/opentelemetry-instrumentation-dns/README.md +++ b/plugins/node/opentelemetry-instrumentation-dns/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`dns`](http://nodejs.org/dis For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-express/README.md b/plugins/node/opentelemetry-instrumentation-express/README.md index 8df5e93633..ae714434dc 100644 --- a/plugins/node/opentelemetry-instrumentation-express/README.md +++ b/plugins/node/opentelemetry-instrumentation-express/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`express`](https://github.co For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will not see any spans being exported from the instrumentation. diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/README.md b/plugins/node/opentelemetry-instrumentation-generic-pool/README.md index 068d2004c3..89365fc51d 100644 --- a/plugins/node/opentelemetry-instrumentation-generic-pool/README.md +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/README.md @@ -10,6 +10,8 @@ This module provides basic automatic instrumentation for [`generic-pool`](https: For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-graphql/README.md b/plugins/node/opentelemetry-instrumentation-graphql/README.md index 5e24e889a8..9f533c5a65 100644 --- a/plugins/node/opentelemetry-instrumentation-graphql/README.md +++ b/plugins/node/opentelemetry-instrumentation-graphql/README.md @@ -11,6 +11,8 @@ This module provides *automated instrumentation and tracing* for GraphQL in Node Minimum required graphql version is `v14` +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```shell script diff --git a/plugins/node/opentelemetry-instrumentation-hapi/README.md b/plugins/node/opentelemetry-instrumentation-hapi/README.md index 8a72bb9c5c..fd9cbf2798 100644 --- a/plugins/node/opentelemetry-instrumentation-hapi/README.md +++ b/plugins/node/opentelemetry-instrumentation-hapi/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`Hapi`](https://hapi.dev). For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/README.md b/plugins/node/opentelemetry-instrumentation-ioredis/README.md index 04dd668de5..8197424482 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/README.md +++ b/plugins/node/opentelemetry-instrumentation-ioredis/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`ioredis`](https://github.co For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```sh diff --git a/plugins/node/opentelemetry-instrumentation-knex/README.md b/plugins/node/opentelemetry-instrumentation-knex/README.md index 4f31260e14..e853485d1c 100644 --- a/plugins/node/opentelemetry-instrumentation-knex/README.md +++ b/plugins/node/opentelemetry-instrumentation-knex/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`knex`](https://github.com/k For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-koa/README.md b/plugins/node/opentelemetry-instrumentation-koa/README.md index d16905aefa..630901fccf 100644 --- a/plugins/node/opentelemetry-instrumentation-koa/README.md +++ b/plugins/node/opentelemetry-instrumentation-koa/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`Koa`](https://github.com/ko For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-memcached/README.md b/plugins/node/opentelemetry-instrumentation-memcached/README.md index f2f360775b..efaeed448b 100644 --- a/plugins/node/opentelemetry-instrumentation-memcached/README.md +++ b/plugins/node/opentelemetry-instrumentation-memcached/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`memcached@>=2.2.0`][repo-ur For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/README.md b/plugins/node/opentelemetry-instrumentation-mongodb/README.md index 4581bd3340..10128bccb8 100644 --- a/plugins/node/opentelemetry-instrumentation-mongodb/README.md +++ b/plugins/node/opentelemetry-instrumentation-mongodb/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mongodb`](https://github.co For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-mysql/README.md b/plugins/node/opentelemetry-instrumentation-mysql/README.md index b8593d3d3a..04f795a881 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql/README.md +++ b/plugins/node/opentelemetry-instrumentation-mysql/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mysql`](https://www.npmjs.c For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/README.md b/plugins/node/opentelemetry-instrumentation-mysql2/README.md index 0766be0535..291129cc23 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql2/README.md +++ b/plugins/node/opentelemetry-instrumentation-mysql2/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mysql2`](https://github.com For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md index 1d29847d4e..096fed368a 100644 --- a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md +++ b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md @@ -7,6 +7,8 @@ This module provides automatic tracing instrumentation for [Nest framework][pkg-web-url]. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-net/README.md b/plugins/node/opentelemetry-instrumentation-net/README.md index a7287a40d6..21b10220b5 100644 --- a/plugins/node/opentelemetry-instrumentation-net/README.md +++ b/plugins/node/opentelemetry-instrumentation-net/README.md @@ -8,6 +8,8 @@ This module provides instrumentation of outgoing connections for [`net`](http://nodejs.org/dist/latest/docs/api/net.html). Supports both TCP and IPC connections. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-pg/README.md b/plugins/node/opentelemetry-instrumentation-pg/README.md index afef24548c..f99c4574cb 100644 --- a/plugins/node/opentelemetry-instrumentation-pg/README.md +++ b/plugins/node/opentelemetry-instrumentation-pg/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`pg and pg-pool`](https://gi For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-pino/README.md b/plugins/node/opentelemetry-instrumentation-pino/README.md index cf20bddd62..7c30401dcc 100644 --- a/plugins/node/opentelemetry-instrumentation-pino/README.md +++ b/plugins/node/opentelemetry-instrumentation-pino/README.md @@ -7,6 +7,8 @@ This module provides automatic instrumentation for injection of trace context to [`pino`](https://www.npmjs.com/package/pino). +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-redis/README.md b/plugins/node/opentelemetry-instrumentation-redis/README.md index 44a636b95d..0c2cf66eca 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/README.md +++ b/plugins/node/opentelemetry-instrumentation-redis/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`redis@^2.6.0`](https://gith For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-restify/README.md b/plugins/node/opentelemetry-instrumentation-restify/README.md index 6a274e6b39..867ecc27df 100644 --- a/plugins/node/opentelemetry-instrumentation-restify/README.md +++ b/plugins/node/opentelemetry-instrumentation-restify/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`restify`](https://github.co For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-router/README.md b/plugins/node/opentelemetry-instrumentation-router/README.md index 3fbc073b6d..5e42f542f0 100644 --- a/plugins/node/opentelemetry-instrumentation-router/README.md +++ b/plugins/node/opentelemetry-instrumentation-router/README.md @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`router`](https://github.com For automatic instrumentation see the [@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/node/opentelemetry-instrumentation-winston/README.md b/plugins/node/opentelemetry-instrumentation-winston/README.md index 2d8f75c274..16107aa88f 100644 --- a/plugins/node/opentelemetry-instrumentation-winston/README.md +++ b/plugins/node/opentelemetry-instrumentation-winston/README.md @@ -7,6 +7,8 @@ This module provides automatic instrumentation for injection of trace context to [`winston`](https://www.npmjs.com/package/winston). +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/web/opentelemetry-instrumentation-document-load/README.md b/plugins/web/opentelemetry-instrumentation-document-load/README.md index e7d2ff8466..523e1876d5 100644 --- a/plugins/web/opentelemetry-instrumentation-document-load/README.md +++ b/plugins/web/opentelemetry-instrumentation-document-load/README.md @@ -7,6 +7,8 @@ This module provides *automated instrumentation for document load* for Web applications. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/web/opentelemetry-instrumentation-user-interaction/README.md b/plugins/web/opentelemetry-instrumentation-user-interaction/README.md index 6e2788667b..ac960d5b04 100644 --- a/plugins/web/opentelemetry-instrumentation-user-interaction/README.md +++ b/plugins/web/opentelemetry-instrumentation-user-interaction/README.md @@ -11,6 +11,8 @@ With [zone-js] and ZoneContextManager it will fully support the async operations If you use Angular you already have the [zone-js]. It will be the same if you use [@opentelemetry/context-zone]. Without [zone-js] it will still work but with limited support. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/plugins/web/opentelemetry-plugin-react-load/README.md b/plugins/web/opentelemetry-plugin-react-load/README.md index 9aad0172c1..8f0cd85ace 100644 --- a/plugins/web/opentelemetry-plugin-react-load/README.md +++ b/plugins/web/opentelemetry-plugin-react-load/README.md @@ -8,6 +8,8 @@ This module provides *automated instrumentation for React lifecycles* for Web applications. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ## Installation ```bash diff --git a/propagators/opentelemetry-propagator-aws-xray/README.md b/propagators/opentelemetry-propagator-aws-xray/README.md index 063f12dc74..7684ff6335 100644 --- a/propagators/opentelemetry-propagator-aws-xray/README.md +++ b/propagators/opentelemetry-propagator-aws-xray/README.md @@ -11,6 +11,8 @@ The OpenTelemetry Propagator for AWS X-Ray provides HTTP header propagation for This propagator translates the OpenTelemetry SpanContext into the equivalent AWS header format, for use with the OpenTelemetry JS SDK. `TraceState` is currently not propagated. +Compatible with OpenTelemetry JS API and SDK `1.0+`. + ### Installation ```