From 51f1670b3ea74211ff688ddd66d0de9497f6c9ff Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Sat, 11 May 2024 14:22:55 +0300 Subject: [PATCH 1/3] docs: align all supported versions to a common format --- .../packages/opentelemetry-instrumentation-grpc/README.md | 4 ++++ .../opentelemetry-instrumentation-grpc/src/instrumentation.ts | 2 +- .../packages/opentelemetry-instrumentation-http/README.md | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/README.md b/experimental/packages/opentelemetry-instrumentation-grpc/README.md index 8916054eb4..e02ad10dd3 100644 --- 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 index ae0ac8f7a4..12467065f1 100644 --- a/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts +++ b/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts @@ -100,7 +100,7 @@ export class GrpcInstrumentation extends InstrumentationBase { if (isWrapped(moduleExports.Server.prototype.register)) { this._unwrap(moduleExports.Server.prototype, 'register'); diff --git a/experimental/packages/opentelemetry-instrumentation-http/README.md b/experimental/packages/opentelemetry-instrumentation-http/README.md index 3be82a4e19..8af619928f 100644 --- 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. From 5e5ae33da86ba82ce1b2a2555a78898681e1ef14 Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Sat, 11 May 2024 14:26:28 +0300 Subject: [PATCH 2/3] chore: CHANGELOG --- experimental/CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md index 20e3fbfdab..f020321dfb 100644 --- a/experimental/CHANGELOG.md +++ b/experimental/CHANGELOG.md @@ -29,6 +29,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 From 72b3e5864ea9e08d0a86676ff7b05f324d0dcbc6 Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Sat, 11 May 2024 14:43:31 +0300 Subject: [PATCH 3/3] docs: make markdown list --- .../packages/opentelemetry-instrumentation-grpc/README.md | 2 +- .../packages/opentelemetry-instrumentation-http/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/README.md b/experimental/packages/opentelemetry-instrumentation-grpc/README.md index e02ad10dd3..e887ef2e42 100644 --- a/experimental/packages/opentelemetry-instrumentation-grpc/README.md +++ b/experimental/packages/opentelemetry-instrumentation-grpc/README.md @@ -18,7 +18,7 @@ npm install --save @opentelemetry/instrumentation-grpc ## Supported Versions -[`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) versions `^1.0.0` +- [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) versions `^1.0.0` ## Usage diff --git a/experimental/packages/opentelemetry-instrumentation-http/README.md b/experimental/packages/opentelemetry-instrumentation-http/README.md index 8af619928f..cfed66b460 100644 --- a/experimental/packages/opentelemetry-instrumentation-http/README.md +++ b/experimental/packages/opentelemetry-instrumentation-http/README.md @@ -18,7 +18,7 @@ npm install --save @opentelemetry/instrumentation-http ## Supported Versions -Nodejs `>=14` +- Nodejs `>=14` ## Usage