Skip to content

Commit fa56bc9

Browse files
committed
Update changelog
1 parent dab6b6d commit fa56bc9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22

33
### Breaking Change - Goodbye `faraday` 👋
44

5+
**TL;DR: If you are already on version `4.9` and do not use `config.transport.http_adapter` and `config.transport.faraday_builder`, you don't need to change anything.**
6+
57
This version removes the dependency of [faraday](https://github.com/lostisland/faraday) and replaces related implementation with the `Net::HTTP` standard library.
68

7-
(If you didn't notice it, the SDK previously used `faraday` as the HTTP client to send events to Sentry. You can find the implementation in [HTTPTransport](https://github.com/getsentry/sentry-ruby/blob/v4-9/sentry-ruby/lib/sentry/transport/http_transport.rb).)
89

9-
#### Why
10+
#### Why?
1011

11-
Since the old `sentry-raven` SDK, we've been using `faraday` as the SDKs' HTTP client for years. It's an amazing tool and saved us many work, allowing us to focus on SDK features.
12+
Since the old `sentry-raven` SDK, we've been using `faraday` as the HTTP client for years (see [HTTPTransport](https://github.com/getsentry/sentry-ruby/blob/4-9/sentry-ruby/lib/sentry/transport/http_transport.rb)). It's an amazing tool that saved us many work and allowed us to focus on SDK features.
1213

13-
But because many users also use `faraday` in their own apps and have their own version requirements, managing this dependency has become harder and harder over the past few years. Just to list a few related issues:
14+
But because many users also use `faraday` themselves and have their own version requirements, managing this dependency has become harder over the past few years. Just to list a few related issues:
1415

1516
- [#944](https://github.com/getsentry/sentry-ruby/issues/944)
1617
- [#1424](https://github.com/getsentry/sentry-ruby/issues/1424)
1718
- [#1524](https://github.com/getsentry/sentry-ruby/issues/1524)
1819

19-
And with the release of [faraday 2.0](https://github.com/lostisland/faraday/releases/tag/v2.0.0), we could only imagine it gets even more difficult (which it kinda did, see [#1663](https://github.com/getsentry/sentry-ruby/issues/1663)).
20+
And with the release of [faraday 2.0](https://github.com/lostisland/faraday/releases/tag/v2.0.0), we could only imagine it getting even more difficult (which it kind of did, see [#1663](https://github.com/getsentry/sentry-ruby/issues/1663)).
2021

21-
So we decided to officially say goodbye to it with this release.
22+
So we think it's time to say goodbye to it with this release.
2223

2324

2425
#### What's changed?
@@ -31,7 +32,7 @@ The only noticeable changes are the removal of 2 faraday-specific transport conf
3132
- `config.transport.http_adapter`
3233
- `config.transport.faraday_builder`
3334

34-
**If you are already on version `4.9.x` and do not use those configuration options, it'll be as simple as `bundle update`.**
35+
**If you are already on version `4.9` and do not use those configuration options, it'll be as simple as `bundle update`.**
3536

3637
#### What if I still want to use `faraday` to send my events?
3738

@@ -125,7 +126,7 @@ end
125126
2. Set `config.transport.transport = FaradayTransport`
126127

127128

128-
**Please keep in mind that this may not work in the future when the SDK changes its transport implementation.**
129+
**Please keep in mind that this may not work in the future when the SDK changes its `HTTPTransport` implementation.**
129130

130131
## 4.9.2
131132

0 commit comments

Comments
 (0)