Network.Bugsnag.BeforeNotify

Documentation

data BeforeNotify

A function from Event to Event that is applied before notifying

The wrapped function also accepts the original exception, for cases in which that's useful -- but it's often not. Most BeforeNotifys use updateEvent, which discards it.

BeforeNotify implements Semigroup and Monoid, which means the /do nothing/ BeforeNotify is mempty and two BeforeNotifys doThis then doThat can be implemented as doThat <> doThis.

Instances

Monoid BeforeNotify

Defined in Network.Bugsnag.BeforeNotify

Methods

mempty :: BeforeNotify

mappend :: BeforeNotify -> BeforeNotify -> BeforeNotify

mconcat :: [BeforeNotify] -> BeforeNotify

Semigroup BeforeNotify

Defined in Network.Bugsnag.BeforeNotify

Methods

(<>) :: BeforeNotify -> BeforeNotify -> BeforeNotify

sconcat :: NonEmpty BeforeNotify -> BeforeNotify

stimes :: Integral b => b -> BeforeNotify -> BeforeNotify

beforeNotify :: (forall e. Exception e => e -> Event -> Event) -> BeforeNotify

runBeforeNotify :: Exception e => BeforeNotify -> e -> Event -> Event

Modifying the underlying Exceptions

updateExceptions :: (Exception -> Exception) -> BeforeNotify

filterExceptions :: (Exception -> Bool) -> BeforeNotify

updateStackFrames :: (StackFrame -> StackFrame) -> BeforeNotify

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

setStackFramesCode :: CodeIndex -> BeforeNotify

setStackFramesInProject :: Bool -> BeforeNotify

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

setStackFramesInProjectBy :: (StackFrame -> Bool) -> BeforeNotify

Modifying the Event

updateEvent :: (Event -> Event) -> BeforeNotify

updateEventFromOriginalException :: forall e. Exception e => (e -> BeforeNotify) -> BeforeNotify

Update the Event based on the original exception

This allows updating the Event after casting to an exception type that this library doesn't know about (e.g. SqlError). Because the result of your function is itself a BeforeNotify, you can (and should) use other helpers:

myBeforeNotify =
    defaultBeforeNotify
        <> updateEventFromOriginalException asSqlError
        <> updateEventFromOriginalException asHttpError
        <> -- ...

asSqlError :: SqlError -> BeforeNotify
asSqlError SqlError{..} =
    setGroupingHash sqlErrorCode <> updateException (e -> e
        { exception_errorClass = sqlErrorCode
        , exception_message = Just sqlErrorMessage
        })

If the cast fails, the event is unchanged.

The cast will match either e or AnnotatedException e.

setGroupingHash :: Text -> BeforeNotify

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

setDevice :: Device -> BeforeNotify

Set the Event's Device

See bugsnagDeviceFromWaiRequest

setContext :: Text -> BeforeNotify

Set the Event's Context

setRequest :: Request -> BeforeNotify

Set the Event's Request

See bugsnagRequestFromWaiRequest

setWarningSeverity :: BeforeNotify

Set to WarningSeverity

setErrorSeverity :: BeforeNotify

Set to ErrorSeverity

setInfoSeverity :: BeforeNotify

Set to InfoSeverity