Skip to content

docs(ruby): Correct excluded_exceptions defaults #20245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sentry-junior wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(ruby): Correct excluded_exceptions defaults #20245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/platforms/ruby/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,15 +240,15 @@ config.enabled_environments = %w[production]

</SdkOption>

<SdkOption name="excluded_exceptions" type="Array" defaultValue="Sentry::Configuration::IGNORE_DEFAULT">
<SdkOption name="excluded_exceptions" type="Array" defaultValue="Sentry::Configuration::IGNORE_DEFAULT + Sentry::Configuration::PUMA_IGNORE_DEFAULT">

You can use this option to stop getting notifications about certain exceptions. In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
You can use this option to stop getting notifications about certain exceptions. In the example below, `MyApp::IgnorableError` will be suppressed.

```ruby
config.excluded_exceptions += ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
config.excluded_exceptions += ['MyApp::IgnorableError']
```

You can find the list of exceptions that are excluded by default in `Sentry::Configuration::IGNORE_DEFAULT`. It is suggested that you append to these defaults rather than overwrite them with `=`.
You can find the list of exceptions that are excluded by default in `Sentry::Configuration::IGNORE_DEFAULT` and `Sentry::Configuration::PUMA_IGNORE_DEFAULT`. Integrations add their own defaults too: `sentry-rails` excludes `Sentry::Rails::IGNORE_DEFAULT` (including `ActionController::RoutingError` and `ActiveRecord::RecordNotFound`), and `sentry-sidekiq` excludes `Sentry::Sidekiq::IGNORE_DEFAULT`. It is suggested that you append to these defaults rather than overwrite them with `=`.

</SdkOption>

Expand Down
Loading