BugSnag automatically captures a variety of data to help you debug your errors. You may wish to avoid capturing some types of data, particularly if there are privacy implications for your users.
Information about the application can be useful to identify if an error occurs in certain versions.
Data | Default value | Preventing collection |
---|---|---|
Type | The primary app framework | Override the app_type property during BugSnag configuration |
Information about the device can be useful to identify if an error is only occurring on some devices.
Data | Default value | Preventing collection |
---|---|---|
Hostname | The hostname of the server | Override the hostname property during BugSnag configuration |
Runtime versions | The version of Ruby and supported frameworks in use | Modify metadata.device in a callback |
BugSnag automatically captures data about the running task, on a sidekiq
metadata tab.
This tab can be removed in its entirety using the clear_metadata
method within a middleware or callback.
Data | Default value | Preventing collection |
---|---|---|
Message | The Sidekiq task’s message | Filter msg using redacted_keys |
Queue | The queue the task is running under | Filter queue using redacted_keys |
Modifying error information may affect error grouping.
Data | Default value | Preventing collection |
---|---|---|
Error class | The exception’s class name | Override the error data within an event using a callback and the exceptions method |
Error message | The exception’s message | Override the error data within an event using a callback and the exceptions method |
Stack trace | A stack trace derived from the exception, containing code, filenames, methods and line numbers | Override the error data within an event using a callback and the exceptions method |
Context | The Sidekiq message class and queue | Override the event’s context using a callback or custom middleware |
Breadcrumbs contain information that can help you track down the root cause of errors.
BugSnag will automatically add a subscriber if the Mongo ruby driver gem is detected, allowing breadcrumbs to be captured with each transaction.
All breadcrumbs can be filtered as described in the discarding and amending breadcrumbs section.
A full list of the Mongo breadcrumbs and data captured can be found in the table below.
event id | breadcrumb message | type | captured metaData |
---|---|---|---|
succeeded |
Mongo query succeeded | PROCESS |
command_name , database_name , operation_id , request_id , duration , collection , filters |
failed |
Mongo query failed | PROCESS |
command_name , database_name , operation_id , request_id , duration , message , collection , filters |
The filters
metadata captured in a breadcrumb will only ever contain keys
used in a query, never values
.