Blammo.Logging.Logger

Documentation

data Logger

Instances

HasLogger Logger

Defined in Blammo.Logging.Internal.Logger

Methods

loggerL :: Lens' Logger Logger

class HasLogger env where

Methods

loggerL :: Lens' env Logger

Instances

HasLogger Logger

Defined in Blammo.Logging.Internal.Logger

Methods

loggerL :: Lens' Logger Logger

withLogger :: MonadUnliftIO m => LogSettings -> (Logger -> m a) -> m a

Initialize logging, pass a Logger to the callback, and clean up at the end

Applications should avoid calling this more than once in their lifecycle.

newLogger :: MonadIO m => LogSettings -> m Logger

flushLogger :: (MonadIO m, MonadReader env m, HasLogger env) => m ()

pushLogger :: (MonadIO m, MonadReader env m, HasLogger env) => Text -> m ()

pushLoggerLn :: (MonadIO m, MonadReader env m, HasLogger env) => Text -> m ()

getLoggerLogSettings :: Logger -> LogSettings

getLoggerReformat :: Logger -> LogLevel -> ByteString -> ByteString

getLoggerShouldLog :: Logger -> LogSource -> LogLevel -> Bool

getLoggerShouldColor :: Logger -> Bool

pushLogStrLn :: MonadIO m => Logger -> LogStr -> m ()

flushLogStr :: MonadIO m => Logger -> m ()

runLogAction :: (MonadIO m, ToLogStr msg) => Logger -> Loc -> LogSource -> LogLevel -> msg -> m ()

Write a message to the Logger, unless the logger's filter options reject it based on its LogSource and LogLevel

Testing

newTestLogger :: MonadIO m => LogSettings -> m Logger

Create a Logger that will capture log messages instead of logging them

See Blammo.Logging.LoggedMessages for more details.

data LoggedMessage

This type is the Haskell representation of each JSON log message produced by this library.

While we never interact with this type directly when logging messages with monad-logger-aeson, we may wish to use this type if we are parsing/processing log files generated by this library.

Since: monad-logger-aeson-0.1.0.0

Constructors

LoggedMessage

Fields

• loggedMessageTimestamp :: UTCTime
• loggedMessageLevel :: LogLevel
• loggedMessageLoc :: Maybe Loc
• loggedMessageLogSource :: Maybe LogSource
• loggedMessageThreadContext :: KeyMap Value
• loggedMessageText :: Text
• loggedMessageMeta :: KeyMap Value

Instances

FromJSON LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Methods

parseJSON :: Value -> Parser LoggedMessage

parseJSONList :: Value -> Parser [LoggedMessage]

omittedField :: Maybe LoggedMessage

ToJSON LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Methods

toJSON :: LoggedMessage -> Value

toEncoding :: LoggedMessage -> Encoding

toJSONList :: [LoggedMessage] -> Value

toEncodingList :: [LoggedMessage] -> Encoding

omitField :: LoggedMessage -> Bool

Generic LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Associated Types

type Rep LoggedMessage :: Type -> Type

Methods

from :: LoggedMessage -> Rep LoggedMessage x

to :: Rep LoggedMessage x -> LoggedMessage

Show LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Methods

showsPrec :: Int -> LoggedMessage -> ShowS

show :: LoggedMessage -> String

showList :: [LoggedMessage] -> ShowS

Eq LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Methods

(==) :: LoggedMessage -> LoggedMessage -> Bool

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

Ord LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

Methods

compare :: LoggedMessage -> LoggedMessage -> Ordering

(<) :: LoggedMessage -> LoggedMessage -> Bool

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

(>) :: LoggedMessage -> LoggedMessage -> Bool

(>=) :: LoggedMessage -> LoggedMessage -> Bool

max :: LoggedMessage -> LoggedMessage -> LoggedMessage

min :: LoggedMessage -> LoggedMessage -> LoggedMessage

type Rep LoggedMessage

Defined in Control.Monad.Logger.Aeson.Internal

type Rep LoggedMessage = D1 ('MetaData "LoggedMessage" "Control.Monad.Logger.Aeson.Internal" "monad-logger-aeson-0.4.1.3-DYn2yN3dBt5IT4MuM2CCww" 'False) (C1 ('MetaCons "LoggedMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loggedMessageTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "loggedMessageLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "loggedMessageLoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Loc)))) :*: ((S1 ('MetaSel ('Just "loggedMessageLogSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogSource)) :*: S1 ('MetaSel ('Just "loggedMessageThreadContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (KeyMap Value))) :*: (S1 ('MetaSel ('Just "loggedMessageText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "loggedMessageMeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (KeyMap Value))))))

getLoggedMessages :: (MonadIO m, MonadReader env m, HasLogger env) => m [Either String LoggedMessage]

Return the logged messages if newTestLogger was used

If not, the empty list is returned.

getLoggedMessagesLenient :: (MonadIO m, MonadReader env m, HasLogger env) => m [LoggedMessage]

getLoggedMessages but ignore any messages that fail to parse

getLoggedMessagesUnsafe :: (HasCallStack, MonadIO m, MonadReader env m, HasLogger env) => m [LoggedMessage]

getLoggedMessages but throwString if any messages failed to parse