Control.Monad.Log.Extra.File

Getting Started

logging-effect-extra-file supplements logging-effect with TH splices that capture file information.

Quickstart using file info and severity

testAppFileAndSeverity :: MonadLog (WithSeverity (WithFile Doc)) m => m ()
testAppFileAndSeverity = do
  $(logEmergencyTH) "GAH! All systems are down!!!"
  $(logAlertTH) "Red alert!"
  $(logCriticalTH) "Critical hit!"
  $(logErrorTH) "Errors abound!"
  $(logWarningTH) "Cargo number 2331 has commandeered the vessel"
  $(logNoticeTH) "Heads up, but it's no biggie."
  $(logInformationalTH) "Does anyone read these?"
  $(logDebugTH) "Sleuthing with log messages..."

Quickstart using only file info

testAppFileOnly :: MonadLog (WithFile Doc) m => m ()
testAppFileOnly = $(logMessageTH) "Heyo!!!"

Convenience logging combinators (TH)

logging-effect-extra-file provides combinators for:

• adding file info to messages (module name and line number)
• adding both file info and severity to messages

In the former case, WithFile will be at the outer-most level of your log message stack. In the latter case, WithSeverity will be at the outer-most level of your log message stack, wrapping WithFile.

The package makes no assumptions on what is inside your log messages though. There is a logXTH combinator for each level in Severity.

With severity

logEmergencyTH :: Q Exp

Generates a function that logs an Emergency message with info from the source file.

$(logEmergencyTH) "GAH! All systems are down!!!"

logAlertTH :: Q Exp

Generates a function that logs an Alert message with info from the source file.

$(logAlertTH) "Red alert!"

logCriticalTH :: Q Exp

Generates a function that logs a Critical message with info from the source file.

$(logCriticalTH) "Critical hit!"

logErrorTH :: Q Exp

Generates a function that logs an Error message with info from the source file.

$(logErrorTH) "Errors abound!"

logWarningTH :: Q Exp

Generates a function that logs a Warning message with info from the source file.

$(logWarningTH) "Cargo number 2331 has commandeered the vessel"

logNoticeTH :: Q Exp

Generates a function that logs a Notice message with info from the source file.

$(logNoticeTH) "Heads up, but it's no biggie."

logInfoTH :: Q Exp

Generates a function that logs an Informational message with info from the source file.

$(logInfoTH) "Does anyone read these?"

logInformationalTH :: Q Exp

Deprecated: logInformationalTH is deprecated in favor of logInfoTH.

Generates a function that logs an Informational message with info from the source file.

$(logInformationalTH) "Does anyone read these?"

logDebugTH :: Q Exp

Generates a function that logs a Debug message with info from the source file.

$(logDebugTH) "Sleuthing with log messages..."

Without severity

logMessageTH :: Q Exp

Generates a function that logs a message with info from the source file.

$(logMessageTH) "Burn after reading."

Message transformers

File info

data WithFile a

Add "File" information to a log message.

Constructors

WithFile

Fields

• msgLoc :: Loc

  Retrieve the file location info.

• discardFile :: a

  View the underlying message.

Instances

Functor WithFile

Methods

fmap :: (a -> b) -> WithFile a -> WithFile b

(<$) :: a -> WithFile b -> WithFile a

Foldable WithFile

Methods

fold :: Monoid m => WithFile m -> m

foldMap :: Monoid m => (a -> m) -> WithFile a -> m

foldr :: (a -> b -> b) -> b -> WithFile a -> b

foldr' :: (a -> b -> b) -> b -> WithFile a -> b

foldl :: (b -> a -> b) -> b -> WithFile a -> b

foldl' :: (b -> a -> b) -> b -> WithFile a -> b

foldr1 :: (a -> a -> a) -> WithFile a -> a

foldl1 :: (a -> a -> a) -> WithFile a -> a

toList :: WithFile a -> [a]

null :: WithFile a -> Bool

length :: WithFile a -> Int

elem :: Eq a => a -> WithFile a -> Bool

maximum :: Ord a => WithFile a -> a

minimum :: Ord a => WithFile a -> a

sum :: Num a => WithFile a -> a

product :: Num a => WithFile a -> a

Traversable WithFile

Methods

traverse :: Applicative f => (a -> f b) -> WithFile a -> f (WithFile b)

sequenceA :: Applicative f => WithFile (f a) -> f (WithFile a)

mapM :: Monad m => (a -> m b) -> WithFile a -> m (WithFile b)

sequence :: Monad m => WithFile (m a) -> m (WithFile a)

Eq a => Eq (WithFile a)

Methods

(==) :: WithFile a -> WithFile a -> Bool

(/=) :: WithFile a -> WithFile a -> Bool

Ord a => Ord (WithFile a)

Methods

compare :: WithFile a -> WithFile a -> Ordering

(<) :: WithFile a -> WithFile a -> Bool

(<=) :: WithFile a -> WithFile a -> Bool

(>) :: WithFile a -> WithFile a -> Bool

(>=) :: WithFile a -> WithFile a -> Bool

max :: WithFile a -> WithFile a -> WithFile a

min :: WithFile a -> WithFile a -> WithFile a

Show a => Show (WithFile a)

Methods

showsPrec :: Int -> WithFile a -> ShowS

show :: WithFile a -> String

showList :: [WithFile a] -> ShowS

renderWithFile :: (a -> Doc) -> WithFile a -> Doc

Given a way to render the underlying message a, render a message with its file info.

>>> let loc = Loc "SomeFile.hs" "some-package" "SomeModule" (1, 1) (1, 1)
>>> renderWithFile id (WithFile loc "Some message")
[SomeModule:1] Some message

Utilities

logSeverityMessageTH :: Severity -> Q Exp

Generates a function that logs a message with the given Severity and info from the source file.

liftLoc :: Loc -> Q Exp

Lift a location into an Exp.

Re-exports

data Loc :: *

Constructors

Loc

Fields

• loc_filename :: String
• loc_package :: String
• loc_module :: String
• loc_start :: CharPos
• loc_end :: CharPos

Instances

Eq Loc

Methods

(==) :: Loc -> Loc -> Bool

(/=) :: Loc -> Loc -> Bool

Data Loc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Loc -> c Loc

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Loc

toConstr :: Loc -> Constr

dataTypeOf :: Loc -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Loc)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Loc)

gmapT :: (forall b. Data b => b -> b) -> Loc -> Loc

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Loc -> r

gmapQ :: (forall d. Data d => d -> u) -> Loc -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Loc -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Loc -> m Loc

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Loc -> m Loc

Ord Loc

Methods

compare :: Loc -> Loc -> Ordering

(<) :: Loc -> Loc -> Bool

(<=) :: Loc -> Loc -> Bool

(>) :: Loc -> Loc -> Bool

(>=) :: Loc -> Loc -> Bool

max :: Loc -> Loc -> Loc

min :: Loc -> Loc -> Loc

Show Loc

Methods

showsPrec :: Int -> Loc -> ShowS

show :: Loc -> String

showList :: [Loc] -> ShowS

Generic Loc

Associated Types

type Rep Loc :: * -> *

Methods

from :: Loc -> Rep Loc x

to :: Rep Loc x -> Loc

type Rep Loc

type Rep Loc = D1 (MetaData "Loc" "Language.Haskell.TH.Syntax" "template-haskell" False) (C1 (MetaCons "Loc" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "loc_filename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "loc_package") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) ((:*:) (S1 (MetaSel (Just Symbol "loc_module") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) ((:*:) (S1 (MetaSel (Just Symbol "loc_start") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CharPos)) (S1 (MetaSel (Just Symbol "loc_end") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CharPos))))))

Orphan instances

Lift Severity

Methods

lift :: Severity -> Q Exp