diff --git a/CHANGELOG.md b/CHANGELOG.md index f0e4adb66..cfd7fa39c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## Unreleased + +### Miscellaneous + +- Warn users about `config.async`'s deprecation [#1803](https://github.com/getsentry/sentry-ruby/pull/1803) + ## 5.3.0 ### Features diff --git a/sentry-ruby/lib/sentry/configuration.rb b/sentry-ruby/lib/sentry/configuration.rb index 05c5f1f05..5cbc08355 100644 --- a/sentry-ruby/lib/sentry/configuration.rb +++ b/sentry-ruby/lib/sentry/configuration.rb @@ -290,6 +290,16 @@ def dsn=(value) def async=(value) check_callable!("async", value) + log_warn <<~MSG + + sentry-ruby now sends events asynchronously by default with its background worker (supported since 4.1.0). + The `config.async` callback has become redundant while continuing to cause issues. + (The problems of `async` are detailed in https://github.com/getsentry/sentry-ruby/issues/1522) + + Therefore, we encourage you to remove it and let the background worker take care of async job sending. + It's deprecation is planned in the next major release (6.0), which is scheduled around the 3rd quarter of 2022. + MSG + @async = value end