Airbrake

Utilities for notifying Airbrake of errors. An Error type is provided; you can convert any instance of Exception to an Error using toError, which uses the exception's Typeable instance.

Airbrake requires a stack trace for any reported exception, but stack trace information isn't readily available for Haskell exceptions. notifyQ and notifyReqQ are provided for the purpose of providing the current file position as the stack trace.

Notifying

notify :: (MonadBaseControl IO m, MonadIO m, MonadThrow m) => AirbrakeConf -> Error -> Locations -> m ()

Notify Airbrake of an exception.

notifyReq :: (MonadBaseControl IO m, MonadIO m, MonadThrow m, WebRequest req) => AirbrakeConf -> req -> Error -> Locations -> m ()

Notify Airbrake of an exception, providing request metadata along with it.

notifyQ :: Q Exp

notify, fetching the current file location using Template Haskell.

 $notifyQ :: (MonadBaseControl IO m, MonadThrow m, MonadIO m)
          => AirbrakeConf -> Error -> m ()

notifyReqQ :: Q Exp

notifyReq, fetching the current file location using Template Haskell.

 $notifyReqQ :: (MonadBaseControl IO m, MonadThrow m, MonadIO m, WebRequest req)
             => AirbrakeConf -> req -> Error -> m ()

Notification metadata

Location lists

data NonEmpty a

Constructors

a :| [a]

Instances

Monad NonEmpty

Functor NonEmpty

Typeable1 NonEmpty

Applicative NonEmpty

Foldable NonEmpty

Traversable NonEmpty

Eq a => Eq (NonEmpty a)

Data a => Data (NonEmpty a)

Ord a => Ord (NonEmpty a)

Read a => Read (NonEmpty a)

Show a => Show (NonEmpty a)

Generic (NonEmpty a)

Hashable a => Hashable (NonEmpty a)

type Location = (FilePath, Int)

A (filename, line) pair.

type Locations = NonEmpty Location

Wrapping errors

toError :: Exception e => e -> Error

Convert any Exception to an Error.

data Error

Constructors

Error

Fields

errorType :: Text

errorDescription :: Text

Configuration building

type APIKey = String

type Environment = String

airbrakeConf :: APIKey -> Environment -> AirbrakeConf

defaultApiEndpoint :: String

http://api.airbrake.io/notifier_api/v2/notices

data AirbrakeConf

Information to use when communicating with Airbrake.

Constructors

AirbrakeConf

Fields

acApiEndpoint :: String

acApiKey :: APIKey

acServer :: Server

data Server

Metadata about the server.

Constructors

Server

Fields

serverEnvironment :: Environment

serverAppVersion :: Maybe Version

serverRoot :: Maybe FilePath

Convenience exports

module Airbrake.Credentials