Removal Sinatra 1.x Appraisal (open-telemetry#715)

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. Co-authored-by: Ariel Valentin <arielvalentin@users.noreply.github.com>
tools-aoeur · Nov 19, 2023 · 02799c8 · 02799c8
1 parent c8e2f70
commit 02799c8
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git 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, "<version>"
+```
+
+| 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
@@ -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
@@ -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, "<version>"
+```
+
+| 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: