Skip to content

Commit

Permalink
fix: Removal Sinatra 1.x Appraisal
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
zacheryph authored and Zachery Hostens committed Nov 13, 2023
1 parent 3f44472 commit e337e79
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
13 changes: 13 additions & 0 deletions instrumentation/rack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 0 additions & 4 deletions instrumentation/sinatra/Appraisals
Original file line number Diff line number Diff line change
Expand Up @@ -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
14 changes: 14 additions & 0 deletions instrumentation/sinatra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit e337e79

Please sign in to comment.