docs: align all supported versions to a common format (#4696)

* docs: align all supported versions to a common format * chore: CHANGELOG * docs: make markdown list --------- Co-authored-by: Marc Pichler <[email protected]>
open-telemetry · May 13, 2024 · 15b3526 · 15b3526
1 parent 3ca2f5b
commit 15b3526
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -30,6 +30,8 @@ All notable changes to experimental packages in this project will be documented
 
 ### :books: (Refine Doc)
 
+* docs: align all supported versions to a common format [#4696](https://github.com/open-telemetry/opentelemetry-js/pull/4696) @blumamir
+
 ### :house: (Internal)
 
 ## 0.51.0

diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/README.md b/experimental/packages/opentelemetry-instrumentation-grpc/README.md
@@ -16,6 +16,10 @@ For automatic instrumentation see the
 npm install --save @opentelemetry/instrumentation-grpc
 ```
 
+## Supported Versions
+
+- [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) versions `^1.0.0`
+
 ## Usage
 
 OpenTelemetry gRPC Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with ([grpc-js](https://www.npmjs.com/package/@grpc/grpc-js)).

diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts b/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts
@@ -99,7 +99,7 @@ export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentation
     return [
       new InstrumentationNodeModuleDefinition(
         '@grpc/grpc-js',
-        ['1.*'],
+        ['^1.0.0'],
         moduleExports => {
           // Patch Server methods
           this._wrap(

diff --git a/experimental/packages/opentelemetry-instrumentation-http/README.md b/experimental/packages/opentelemetry-instrumentation-http/README.md
@@ -16,6 +16,10 @@ For automatic instrumentation see the
 npm install --save @opentelemetry/instrumentation-http
 ```
 
+## Supported Versions
+
+- Nodejs `>=14`
+
 ## Usage
 
 OpenTelemetry HTTP Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.