Deprecated

In favour of
bugsnag, bugsnag-wai, bugsnag-yesod

bugsnag-haskell

Bugsnag error reporter for Haskell

https://github.com/pbrisbin/bugsnag-haskell#readme

LTS Haskell 22.42:0.0.4.4
Stackage Nightly 2023-12-26:0.0.4.4
Latest on Hackage:0.0.4.4

See all snapshots bugsnag-haskell appears in

MIT licensed by Patrick Brisbin
Maintained by [email protected]
This version can be pinned in stack with:bugsnag-haskell-0.0.4.4@sha256:8564478f73f06b973b723ef3baedb7667de84247b54a402f85f5b93145eb1cb7,7598

Module documentation for 0.0.4.4

Used by 1 package in lts-22.42(full list with versions):
bugsnag-haskell

Bugsnag error reporter for Haskell

CI Stackage nightly

Catch and report exceptions in your Haskell code.

Configuration

settings <- newBugsnagSettings "BUGSNAG_API_KEY"

See Network.Bugsnag.Settings.

Reporting an Error

notifyBugsnag settings $ toException
    $ bugsnagException "Error" "message"
        [ $(currentStackFrame) "myFunction"
        ]

See Network.Bugsnag.Notify.

Throwing & Catching

Throw a BugsnagException yourself:

throw
    $ bugsnagException "Error" "message" [$(currentStackFrame) "myFunction"]

Catch any exceptions, notify, and re-throw it:

myFunction `catch` \ex -> do
    notifyBugsnag settings ex
    throw ex

Examples

Examples can be built locally with:

stack build --flag bugsnag-haskell:examples

Contributing

See CONTRIBUTING.

CHANGELOG | LICENSE

Changes

Unreleased

  • None

v0.0.4.4

  • Remove the orphan instance ToJSON ByteString

v0.0.4.3

  • Include package.yaml in release tarball

    We read default-extensions out of it for doctests.

v0.0.4.2

  • Support Aeson 2.0

v0.0.4.1

  • Fix invalid URLs in Request tab (missing leading /s in paths)

v0.0.4.0

  • Fixed serialization of headers in BugsnagRequest

    Previously, headers were a list of:

    [(CI ByteString, ByteString)]

    So they serialized as an array, but Bugsnag only accepts objects for headers.

    To solve this, the newtype BugsnagRequestHeaders wraps the headers and has a correct ToJSON instance.

v0.0.3.1

  • Tag SomeException with the underlying exception class

v0.0.3.0

  • Fix sensitive request header redacting
  • Remove defaultBeforeNotify

v0.0.2.2

Packaging changes only.

v0.0.2.1

  • Set StackFrame as in-project based on the CodeIndex when present
  • Correctly parse throwString exceptions with newlines in the message

v0.0.2.0

  • Add CodeIndex support

    Adds a Template Haskell function to read your project source into an in-memory Map structure to be set on your BugsnagSettings value. Then, as part of notification, we can attach lines of source context to the StackFrames we have. NOTE: This has memory-footprint implications, so is entirely opt-in.

    See https://github.com/pbrisbin/bugsnag-haskell/pull/39

v0.0.1.3

  • Redact sensitive request headers by default #31

    NOTE: this wasn’t actually working at this point. It is actually fixed in v0.0.3.0.

  • Deprecate Settings that should be BeforeNotify values #32

  • bugsnagShouldNotify operates after any BeforeNotify changes

v0.0.1.2

  • Make App Version an opaque Text, not a structured Version (@MaxGabriel)

v0.0.1.1

First (pre-) released version.