Automatically captured data

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.

Application information

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

Device information

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

User information

User information is used to show you which errors are impacting the most users. Set your own user identifiers if you want to be able to find errors affecting individual users.

Default user data

Data Default value Preventing collection
Id The remote_ip of the incoming request Override the report’s user using a callback or custom middleware

Warden and Clearance user data

This data will only be collected if a Warden or Clearance plugin is being used with your Rails server. The same data is collected from both Warden and Clearance, so overriding methods noted below will work with either plugin.

Data Default value Preventing collection
Email The user’s email address Override the report’s user using a callback or custom middleware
Name The user’s username Override the report’s user using a callback or custom middleware
First name The user’s first name Override the report’s user using a callback or custom middleware
Last name The user’s last name Override the report’s user using a callback or custom middleware
Created at The time the user was created Override the report’s user using a callback or custom middleware
Id The Warden or Clearance user ID Override the report’s user using a callback or custom middleware

Request information

Details about the request can be helpful to reproduce errors.

This tab can be removed in its entirety using the remove_tab method within a middleware or callback.

Data Default value Preventing collection
URL The requested URL in full Filter url using meta_data_filters
HTTP Method The method used by the request Filter httpMethod using meta_data_filters
Referer The HTTP referer that originally accessed the resource Filter referer using meta_data_filters
Headers Any headers provided by the request Filter headers using meta_data_filters
Rails action The controller name and action Filter railsAction using meta_data_filters
Params The parameters or body supplied by the request Filter params using meta_data_filters
Client IP The remote_ip of the incoming request Filter clientIp using meta_data_filters
Request ID The uuid generated at the beginning of a request Filter requestId using meta_data_filters

Environment information

Information about the environment can be useful for finding platform or device issues.

Data Default value Preventing collection
Rails Version The version of Rails currently running Ensure the send_environment configuration option is false

In addition, the environment tab will be populated with all environment data provided by Rack. The tab will only be collected if the configuration option send_environment is set to true.

Error information

Modifying error information may affect error grouping.

Data Default value Preventing collection
Error class The exception’s class name Override the error data within a report using a callback and the exceptions method
Error message The exception’s message Override the error data within a report 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 a report using a callback and the exceptions method
Context The controller name and action Override the report’s context using a callback or custom middleware

ActiveSupport breadcrumbs

Breadcrumbs contain information that can help you track down the root cause of errors.

Bugsnag automatically adds a subscriber to certain ActiveSupport events, creating a breadcrumb for each.

While sensitive data, such as SQL queries or ActiveMailer messages, will not be captured, all breadcrumbs can be filtered as described in the filtering breadcrumbs section.

A full list of the ActiveSupport breadcrumbs and data captured can be found in the table below.

event id breadcrumb name type captured metaData
perform_action.action_cable Perform ActionCable PROCESS_BREADCRUMB_TYPE channel_class, action
perform.active_job Perform ActiveJob PROCESS_BREADCRUMB_TYPE
cache_read.active_support Read cache PROCESS_BREADCRUMB_TYPE key, hit, super_operation
cache_fetch_hit.active_support Fetch cache hit PROCESS_BREADCRUMB_TYPE key
sql.active_record ActiveRecord SQL query PROCESS_BREADCRUMB_TYPE name, connection_id, cached, binds
start_processing.action_controller Controller started processing REQUEST_BREADCRUMB_TYPE controller, action, method, path
process_action.action_controller Controller action processed REQUEST_BREADCRUMB_TYPE controller, action, method, status, view_runtime, db_runtime
redirect_to.action_controller Controller redirect REQUEST_BREADCRUMB_TYPE status, location
halted_callback.action_controller Controller halted via callback REQUEST_BREADCRUMB_TYPE filter
render_template.action_view ActionView template rendered REQUEST_BREADCRUMB_TYPE identifier, layout
render_partial.action_view ActionView partial rendered REQUEST_BREADCRUMB_TYPE identifier
deliver.action_mailer ActionMail delivered REQUEST_BREADCRUMB_TYPE mailer, message_id, from, date, perform_deliveries

Bindings data

The binds meta data captured in a breadcrumb will only ever contain keys used in a query, never values.

Mongo breadcrumbs

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 filtering breadcrumbs section.

A full list of the Mongo breadcrumbs and data captured can be found in the table below.

event id breadcrumb name type captured metaData
succeeded Mongo query succeeded PROCESS_BREADCRUMB_TYPE command_name, database_name, operation_id, request_id, duration, collection, filters
failed Mongo query failed PROCESS_BREADCRUMB_TYPE command_name, database_name, operation_id, request_id, duration, message, collection, filters

Filter Data

The filters meta data captured in a breadcrumb will only ever contain keys used in a query, never values.