Network.Bugsnag.BeforeNotify

Documentation

type BeforeNotify = BugsnagEvent -> BugsnagEvent

defaultBeforeNotify :: BeforeNotify

Used as bsBeforeNotify the default Settings value

Redacts the following Request headers:

• Authorization
• Cookie
• X-XSRF-TOKEN (CSRF token header used by Yesod)

N.B. If you override the value on BugsnagSettings, you probably want to maintain this as well:

settings { bsBeforeNotify = defaultBeforeNotify . myBeforeNotify }

Modifying the Exception

updateException :: (BugsnagException -> BugsnagException) -> BeforeNotify

Modify just the Exception part of an Event

Technically this will modify all exceptions in the Event, but if you're using this library normally, there will be only one.

This may be used to set more specific information for exception types in scope in your application:

notifyBugsnagWith (updateException forSqlError) settings ex

forSqlError :: BugsnagException -> BugsnagException
forSqlError ex =
    case fromException =<< beOriginalException ex of
        Just SqlError{..} -> ex
            { beErrorClass = "SqlError-" <> sqlErrorCode
            , beMessage = Just sqlErrorMessage
            }
        _ -> ex

filterStackFrames :: (BugsnagStackFrame -> Bool) -> BeforeNotify

Filter out StackFrames matching a predicate

setStackFramesInProject :: (FilePath -> Bool) -> BeforeNotify

Set bsIsInProject using the given predicate, applied to the Filename

setGroupingHash :: Text -> BeforeNotify

Set beGroupingHash

setGroupingHashBy :: (BugsnagEvent -> Maybe Text) -> BeforeNotify

Set beGroupingHash based on the Event

Modifying the Event

updateEventFromSession :: BugsnagSession -> BeforeNotify

Update the Event's Context and User from the Session

updateEventFromWaiRequest :: Request -> BeforeNotify

Set the events BugsnagEvent and BugsnagDevice

Modifying the Request

redactRequestHeaders :: [HeaderName] -> BeforeNotify

Redact the given request headers

Headers like Authorization may contain information you don't want to report to Bugsnag.

redactRequestHeaders ["Authorization", "Cookie"]

Simple setters

setDevice :: BugsnagDevice -> BeforeNotify

Set the Event's Device

See bugsnagDeviceFromWaiRequest

setRequest :: BugsnagRequest -> BeforeNotify

Set the Event's Request

See bugsnagRequestFromWaiRequest

setStacktrace :: [BugsnagStackFrame] -> BeforeNotify

Set the stacktrace on the reported exception

notifyBugsnagWith (setStacktrace [$(currentStackFrame) "myFunc"]) ...

Setting severity

setWarningSeverity :: BeforeNotify

Set to WarningSeverity

setErrorSeverity :: BeforeNotify

Set to ErrorSeverity

setInfoSeverity :: BeforeNotify

Set to InfoSeverity