Knit.Effect.Logger

Polysemy logger effect, using pretty-printing and severity based on logging-effect. Adds a Prefixing effect so that it's easy to wrap entire functions, etc. in logging prefixes and thus to distinguish where things are being logged from more easily. Also allows filtering by severity.

Logging Types

data LogSeverity

Severity of message. Based on monad-logger.

Constructors

Diagnostic

Info

Warning

Error

Instances

Bounded LogSeverity

Defined in Knit.Effect.Logger

Methods

minBound :: LogSeverity

maxBound :: LogSeverity

Enum LogSeverity

Defined in Knit.Effect.Logger

Methods

succ :: LogSeverity -> LogSeverity

pred :: LogSeverity -> LogSeverity

toEnum :: Int -> LogSeverity

fromEnum :: LogSeverity -> Int

enumFrom :: LogSeverity -> [LogSeverity]

enumFromThen :: LogSeverity -> LogSeverity -> [LogSeverity]

enumFromTo :: LogSeverity -> LogSeverity -> [LogSeverity]

enumFromThenTo :: LogSeverity -> LogSeverity -> LogSeverity -> [LogSeverity]

Eq LogSeverity

Defined in Knit.Effect.Logger

Methods

(==) :: LogSeverity -> LogSeverity -> Bool

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

Ord LogSeverity

Defined in Knit.Effect.Logger

Methods

compare :: LogSeverity -> LogSeverity -> Ordering

(<) :: LogSeverity -> LogSeverity -> Bool

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

(>) :: LogSeverity -> LogSeverity -> Bool

(>=) :: LogSeverity -> LogSeverity -> Bool

max :: LogSeverity -> LogSeverity -> LogSeverity

min :: LogSeverity -> LogSeverity -> LogSeverity

Show LogSeverity

Defined in Knit.Effect.Logger

Methods

showsPrec :: Int -> LogSeverity -> ShowS

show :: LogSeverity -> String

showList :: [LogSeverity] -> ShowS

data LogEntry

A basic LogEntry with a severity and a (Text) message

Constructors

LogEntry

Fields

• severity :: LogSeverity
• message :: Text

Effects

data Logger a m r where

The Logger effect

Constructors

Log :: a -> Logger a m ()

data PrefixLog m r

Prefix Effect

Actions

log :: Member (Logger a) effs => a -> Sem effs ()

Add one log entry of arbitrary type. If you want to log with another type besides @LogEntry.

logLE :: Member (Logger LogEntry) effs => LogSeverity -> Text -> Sem effs ()

Add one log-entry of the LogEntry type.

wrapPrefix :: Member PrefixLog effs => Text -> Sem effs a -> Sem effs a

Add a prefix for the block of code.

Interpreters

filteredLogEntriesToIO :: MonadIO (Sem effs) => [LogSeverity] -> Sem (Logger LogEntry ': (PrefixLog ': effs)) x -> Sem effs x

Run the Logger and PrefixLog effects using the preferred handler and filter output in any Polysemy monad with IO in the union.

Subsets for filtering

logAll :: [LogSeverity]

LogSeverity list used in order to output everything.

nonDiagnostic :: [LogSeverity]

LogSeverity list used to output all but Diagnostic. Diagnostic messages are sometimes useful for debugging but can get noisy depending on how you use it.

Constraints for convenience

type LogWithPrefixes a effs = (Member PrefixLog effs, Member (Logger a) effs)

Constraint helper for logging with prefixes

type LogWithPrefixesLE effs = LogWithPrefixes LogEntry effs

Constraint helper for LogEntry type with prefixes

Re-Exports

data Sem (r :: [(Type -> Type) -> Type -> Type]) a

Instances

Monad (Sem f)

Defined in Polysemy.Internal

Methods

(>>=) :: Sem f a -> (a -> Sem f b) -> Sem f b

(>>) :: Sem f a -> Sem f b -> Sem f b

return :: a -> Sem f a

fail :: String -> Sem f a

Functor (Sem f)

Defined in Polysemy.Internal

Methods

fmap :: (a -> b) -> Sem f a -> Sem f b

(<$) :: a -> Sem f b -> Sem f a

Member Fixpoint r => MonadFix (Sem r)

Defined in Polysemy.Internal

Methods

mfix :: (a -> Sem r a) -> Sem r a

Member NonDet r => MonadFail (Sem r)

Defined in Polysemy.Internal

Methods

fail :: String -> Sem r a

Applicative (Sem f)

Defined in Polysemy.Internal

Methods

pure :: a -> Sem f a

(<*>) :: Sem f (a -> b) -> Sem f a -> Sem f b

liftA2 :: (a -> b -> c) -> Sem f a -> Sem f b -> Sem f c

(*>) :: Sem f a -> Sem f b -> Sem f b

(<*) :: Sem f a -> Sem f b -> Sem f a

Member (Lift IO) r => MonadIO (Sem r)

Defined in Polysemy.Internal

Methods

liftIO :: IO a -> Sem r a

Member NonDet r => Alternative (Sem r)

Defined in Polysemy.Internal

Methods

empty :: Sem r a

(<|>) :: Sem r a -> Sem r a -> Sem r a

some :: Sem r a -> Sem r [a]

many :: Sem r a -> Sem r [a]

Member NonDet r => MonadPlus (Sem r)

Defined in Polysemy.Internal

Methods

mzero :: Sem r a

mplus :: Sem r a -> Sem r a -> Sem r a

type Member (e :: (Type -> Type) -> Type -> Type) (r :: [(Type -> Type) -> Type -> Type]) = Member' e r

type Handler (m :: Type -> Type) message = message -> m ()