error-context: Provides API for enriching errors with contexts

[ bsd3, control, error-handling, library ] [ Propose Tags ]

Please see the README on Github at https://github.com/mtesseract/error-context#readme


[Skip to Readme]
Versions 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.2.0.0, 0.2.0.1
Change log ChangeLog.md
Dependencies aeson, base (>=4.7 && <5), bytestring, exceptions, katip, monad-logger, mtl, resourcet, safe-exceptions, text, unliftio-core, unordered-containers [details]
License BSD-3-Clause
Copyright (c) 2018 Moritz Clasmeier
Author Moritz Clasmeier
Maintainer mtesseract@silverratio.net
Category Control, Error Handling
Home page https://github.com/mtesseract/error-context#readme
Bug tracker https://github.com/mtesseract/error-context/issues
Source repo head: git clone https://github.com/mtesseract/error-context
Uploaded by mtesseract at Tue Apr 10 19:40:46 UTC 2018
Distributions NixOS:0.2.0.1
Downloads 197 total (26 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-04-13 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for error-context-0.2.0.1

[back to package description]

error-context Hackage version Stackage version Build Status

!! This is experimental work-in-progress !!

Welcome to error-context! This is a library providing context-aware error and exception handling for Haskell. It has built-in support for the Katip logging package. This means that in combination with Katip, error-context can transparently use the context (key-value pairs and namespace hierarchy) maintained by KatipContext monads.

What problem does error-context attempt to solve?

Good error handling is hard. In the case of failures it is important to keep as much context as necessary for a proper problem analysis. Call traces sometimes help, but the current solutions in Haskell-land for accessing call traces are rather limited.

The error-context library allows you to easily attach call traces ('error contexts') to errors, in particular to exceptions. Special catch- and try-functions are provided for accessing these contexts.

How to use it?

Add an ErrorContextT layer to your monad transformer stack by adding runErrorContextT to the transformer unwrapping code.

The ErrorContextT transformer provides the context-enriching logic via special implementations of MonadThrow, MonadCatch and MonadIO.

Examples

Consider this IO action:

testExample :: IO ()
testExample = do
  Left errWithCtx <- tryAnyWithContext . runErrorContextT $ do
    withErrorNamespace "middle-earth" $
      withErrorNamespace "mordor" $
      withErrorContext "ring-carrier" ("Frodo" :: Text) $ 
      throwM TestException
  putStrLn . displayException $ errWithCtx

When run, it produces the following output:

Exception: TestException
           ring-carrier: "Frodo"
  caused by: mordor
  caused by: middle-earth

For more examples, see https://github.com/mtesseract/error-context/blob/master/test/Control/Error/Context/Test.hs.

What about "pure" exceptions?

The ErrorContextT transformer implements MonadThrow and MonadIO, therefore exceptions thrown by throwM and via liftIO are automatically context-enriched. On the other hand, exceptional values created via

throw :: Exception e => e -> a

are not context-enriched per se. But there is a workaround for this use-case:

ensureExceptionContext :: (MonadCatch m, MonadErrorContext m) => m a -> m a

This function provides context-aware enriching for any exceptions thrown within some monadic value, including those thrown by evaluating values created by throw.