Download as
Browse Code »

Commit 1be055a8031244ecca791813782752d028691edc

Authored by Nathan Broadbent
1 parent b10ef30e
Exists in master and in 1 other branch production

Added section to README about using airbrake_user_attributes gem to provide user… 

… information in error reports
Showing 1 changed file with 20 additions and 0 deletions   Show diff stats
README.md
  Diff comments   View file @1be055a
... ... @@ -170,6 +170,26 @@ rake db:migrate
170 170 If we change the way that data is stored, this will run any migrations to bring your database up to date.
171 171  
172 172  
  173 +User information in error reports
  174 +-----------------------------
  175 +
  176 +Errbit can display information about the user who experienced the error,
  177 +which gives you the ability to ask your users for more information,
  178 +or notify them when the bug is fixed.
  179 +
  180 +If you would like to include information about the current user in your error reports,
  181 +you can replace the `airbrake` gem in your `Gemfile` with the `airbrake_user_attributes` gem.
  182 +This gem is a wrapper around the `airbrake` gem. It will inject information about the current user into the error report,
  183 +if your Rails app's controller responds to a `#current_user` method.
  184 +The user attributes are filtered, so that no authentication-related fields are included.
  185 +
  186 +Whenever user information is received with an error report, it will displayed under the **User Details** tab:
  187 +
  188 +![User details tab](http://i.imgur.com/J3aOa.png)
  189 +
  190 +(This tab will be hidden if no user information is available.)
  191 +
  192 +
173 193 Issue Trackers
174 194 --------------
175 195  
... ...