README.md in sentry-raven-3.1.1 vs README.md in sentry-raven-3.1.2
- old
+ new
@@ -5,18 +5,30 @@
<br>
</p>
# Raven-Ruby, the Ruby Client for Sentry
-### 🚧 We're restructuring this SDK for the [version 4.0](https://github.com/getsentry/raven-ruby/issues/1029) 🚧
+### 🚧 Migrating To The New SDK 🚧
+We've released our new Ruby SDK, [sentry-ruby](https://github.com/getsentry/sentry-ruby/tree/master/sentry-ruby). Here are the benefits of migrating to it:
+
+- **Unified Interfaces With Other SDKs:** The design of `sentry-raven` is outdated compared with our modern Sentry SDKs. If you also use other Sentry SDKs, such as Sentry's JavaScript SDK for your frontend application, you'll notice that their interfaces are quite different from the one provided for `sentry-raven`. The new `sentry-ruby` SDK provides a more consistent user experience across all different platforms.
+
+- **Performance Monitoring:** The Sentry Ruby SDK includes [performance monitoring](https://docs.sentry.io/product/performance/), which you can enable if you haven't already as ([discussed here](https://docs.sentry.io/platforms/ruby/performance/)).
+
+- **Future Support:** `sentry-raven` has entered maintenance mode, which means it won't receive any new feature supports or aggressive bug fixes.
+
+- **Better Extensibility:** Unlike `sentry-raven`, `sentry-ruby` is built with extensibility in mind and will allow the community to build extensions for different integrations/features.
+
+If you're interested in the migration, please also read our [migration guide](https://docs.sentry.io/platforms/ruby/migration/) for more information.
+
---
[](https://rubygems.org/gems/sentry-raven)
-[](https://codecov.io/gh/getsentry/raven-ruby/branch/master)
+[](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
[](https://rubygems.org/gems/sentry-raven/)
[](https://dependabot.com/compatibility-score.html?dependency-name=sentry-raven&package-manager=bundler&version-scheme=semver)
[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/raven-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
@@ -53,15 +65,15 @@
### Raven doesn't report some kinds of data by default
**Raven ignores some exceptions by default** - most of these are related to 404s or controller actions not being found. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb).
-Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.sentry.io/platforms/ruby/config/)
+Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.sentry.io/platforms/ruby/configuration/options/)
### Usage
-**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.sentry.io/platforms/ruby/integrations/) for more details on other gems Sentry integrates with automatically.
+**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.sentry.io/platforms/ruby/configuration/integrations/) for more details on other gems Sentry integrates with automatically.
Otherwise, Raven supports two methods of capturing exceptions:
```ruby
Raven.capture do
@@ -121,13 +133,13 @@
Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events:
```ruby
Raven.user_context email: 'foo@example.com'
-Raven.tags.merge!(interesting: 'yes')
+Raven.tags_context interesting: 'yes'
-Raven.extra.merge!(additional_info: 'foo')
+Raven.extra_context additional_info: 'foo'
```
You can also use `tags_context` and `extra_context` to provide scoped information:
```ruby
@@ -140,10 +152,10 @@
# same as above, the `additional_info` will only present in this request
Raven.capture_exception(exception)
end
```
-For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).
+For more information, see [Context](https://docs.sentry.io/platforms/ruby/enriching-events/context/).
## More Information
* [Documentation](https://docs.sentry.io/clients/ruby/)
* [Bug Tracker](https://github.com/getsentry/raven-ruby/issues)