From 15b35260dfa6f24f612d22c63ab44cdf73c975a7 Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Mon, 13 May 2024 12:08:38 +0300 Subject: [PATCH] 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 --- experimental/CHANGELOG.md | 2 ++ .../packages/opentelemetry-instrumentation-grpc/README.md | 4 ++++ .../opentelemetry-instrumentation-grpc/src/instrumentation.ts | 2 +- .../packages/opentelemetry-instrumentation-http/README.md | 4 ++++ 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md index aaac3b52f8..2e6ac3fbc6 100644 --- 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 index 8916054eb4..e887ef2e42 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 c035b256ee..6216de0765 100644 --- 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 { // Patch Server methods this._wrap( diff --git a/experimental/packages/opentelemetry-instrumentation-http/README.md b/experimental/packages/opentelemetry-instrumentation-http/README.md index 3be82a4e19..cfed66b460 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.