From e337e79cdc952e7b6e67e4259bc62106819bc90b Mon Sep 17 00:00:00 2001 From: Zachery Hostens Date: Wed, 8 Nov 2023 15:35:41 -0600 Subject: [PATCH] fix: Removal Sinatra 1.x Appraisal Rack 1.x is not directly supported anymore. Sinatra 1.x in turn "is not". Removal appraisal and add a compatibility note to both Sinatra and Rack for proper instrumentation version usage. --- instrumentation/rack/README.md | 13 +++++++++++++ instrumentation/sinatra/Appraisals | 4 ---- instrumentation/sinatra/README.md | 14 ++++++++++++++ 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/instrumentation/rack/README.md b/instrumentation/rack/README.md index e63fc02bc..f154e504f 100644 --- a/instrumentation/rack/README.md +++ b/instrumentation/rack/README.md @@ -12,6 +12,19 @@ gem install opentelemetry-instrumentation-rack Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-rack` in your `Gemfile`. +### Version Compatibility + +Older versions of Rack are not supported by the latest version of this instrumentation. If you are using an older version of Rack and need an earlier version of this instrumentation, then consider installing and pinning the compatible gem version, e.g.: + +```console +gem opentelemetry-instrumentation-rack, "" +``` + +| Rack Version | Instrumentation Version | +| ------------ | ----------------------- | +| `< 2.0` | `= 0.22.1` | +| `>= 2.0` | `~> 0.23` | + ## Usage To use the instrumentation, call `use` with the name of the instrumentation: diff --git a/instrumentation/sinatra/Appraisals b/instrumentation/sinatra/Appraisals index 77bc21d6f..f4ebf5e8a 100644 --- a/instrumentation/sinatra/Appraisals +++ b/instrumentation/sinatra/Appraisals @@ -11,7 +11,3 @@ end appraise 'sinatra-2.x' do gem 'sinatra', '~> 2.1' end - -appraise 'sinatra-1.x' do - gem 'sinatra', '~> 1.4' -end diff --git a/instrumentation/sinatra/README.md b/instrumentation/sinatra/README.md index 69a77984a..ddbad1f95 100644 --- a/instrumentation/sinatra/README.md +++ b/instrumentation/sinatra/README.md @@ -10,8 +10,22 @@ Install the gem using: gem install opentelemetry-instrumentation-sinatra ``` + Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-sinatra` to your `Gemfile`. +### Version Compatibility + +Older versions of Sinatra depend on older version of Rack, which are not supported by the latest version of Rack instrumentation. If you are using an older version of Sinatra and need an earlier version of Rack instrumentation, then consider installing and pinning the compatible gem version, e.g.: + +```console +gem opentelemetry-instrumentation-rack, "" +``` + +| Sinatra Version | Rack Instrumentation Version | +| --------------- | ---------------------------- | +| `< 2.0` | `= 0.22.1` | +| `>= 2.0` | `~> 0.22` | + ## Usage To install the instrumentation, add the gem to your Gemfile: