Commit ddb32e102859ffed10b1a51a08383981dfdffa7b

Authored by Stephen Crosby
1 parent 7352a1ce
Exists in master and in 1 other branch production

document configurable notice fingerprinting

Showing 2 changed files with 14 additions and 0 deletions   Show diff stats
@@ -20,3 +20,4 @@ bundle @@ -20,3 +20,4 @@ bundle
20 coverage 20 coverage
21 *# 21 *#
22 .ruby-version 22 .ruby-version
  23 +NOTES
@@ -88,6 +88,19 @@ Deployment @@ -88,6 +88,19 @@ Deployment
88 ---------- 88 ----------
89 See [notes on deployment](docs/deployment.md) 89 See [notes on deployment](docs/deployment.md)
90 90
  91 +Notice Grouping
  92 +---------------
  93 +The way Errbit arranges notices into error groups is configurable. By default,
  94 +Errbit uses the notice's error class, error message, complete backtrace,
  95 +component (or controller), action and environment name to generate a unique
  96 +fingerprint for every notice. Notices with identical fingerprints appear in the
  97 +UI as different occurences of the same error and notices with differing
  98 +fingerprints are displayed as separate errors.
  99 +
  100 +Changing the fingerprinter (under the 'config' menu) applies to all apps and
  101 +the change affects only notices that arrive after the change. If you want to
  102 +refingerprint old notices, you can run `rake errbit:notice_refingerprint`.
  103 +
91 Authentication 104 Authentication
92 -------------- 105 --------------
93 ### Configuring GitHub authentication: 106 ### Configuring GitHub authentication: