Tonatona.Logger

Documentation

data Config

Constructors

Config

Fields

• mode :: DeployMode
• verbose :: Verbose
• logOptions :: LogOptions
• logFunc :: LogFunc

Instances

HasParser Config

Defined in Tonatona.Logger

Methods

parser :: Parser Config

data DeployMode

Constructors

Development

Production

Staging

Test

Instances

Bounded DeployMode

Defined in Tonatona.Logger

Methods

minBound :: DeployMode

maxBound :: DeployMode

Enum DeployMode

Defined in Tonatona.Logger

Methods

succ :: DeployMode -> DeployMode

pred :: DeployMode -> DeployMode

toEnum :: Int -> DeployMode

fromEnum :: DeployMode -> Int

enumFrom :: DeployMode -> [DeployMode]

enumFromThen :: DeployMode -> DeployMode -> [DeployMode]

enumFromTo :: DeployMode -> DeployMode -> [DeployMode]

enumFromThenTo :: DeployMode -> DeployMode -> DeployMode -> [DeployMode]

Eq DeployMode

Defined in Tonatona.Logger

Methods

(==) :: DeployMode -> DeployMode -> Bool

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

Read DeployMode

Defined in Tonatona.Logger

Methods

readsPrec :: Int -> ReadS DeployMode

readList :: ReadS [DeployMode]

readPrec :: ReadPrec DeployMode

readListPrec :: ReadPrec [DeployMode]

Show DeployMode

Defined in Tonatona.Logger

Methods

showsPrec :: Int -> DeployMode -> ShowS

show :: DeployMode -> String

showList :: [DeployMode] -> ShowS

Generic DeployMode

Defined in Tonatona.Logger

Associated Types

type Rep DeployMode :: Type -> Type

Methods

from :: DeployMode -> Rep DeployMode x

to :: Rep DeployMode x -> DeployMode

Var DeployMode

Defined in Tonatona.Logger

Methods

toVar :: DeployMode -> String

fromVar :: String -> Maybe DeployMode

HasParser DeployMode

Defined in Tonatona.Logger

Methods

parser :: Parser DeployMode

type Rep DeployMode

Defined in Tonatona.Logger

type Rep DeployMode = D1 ('MetaData "DeployMode" "Tonatona.Logger" "tonatona-logger-0.2.0.2-2EI9IU8Pw2172WiomJ6KIH" 'False) ((C1 ('MetaCons "Development" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Production" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Staging" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Test" 'PrefixI 'False) (U1 :: Type -> Type)))

newtype Verbose

Constructors

Verbose

Fields

• unVerbose :: Bool

Instances

Eq Verbose

Defined in Tonatona.Logger

Methods

(==) :: Verbose -> Verbose -> Bool

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

Read Verbose

Defined in Tonatona.Logger

Methods

readsPrec :: Int -> ReadS Verbose

readList :: ReadS [Verbose]

readPrec :: ReadPrec Verbose

readListPrec :: ReadPrec [Verbose]

Show Verbose

Defined in Tonatona.Logger

Methods

showsPrec :: Int -> Verbose -> ShowS

show :: Verbose -> String

showList :: [Verbose] -> ShowS

HasParser Verbose

Defined in Tonatona.Logger

Methods

parser :: Parser Verbose

defaultVerbosity :: DeployMode -> Verbose -> Bool

Default setting for verbosity.

Standard logging functions

logDebug :: HasConfig env Config => Utf8Builder -> RIO env ()

Log a debug level message with no source.

logInfo :: HasConfig env Config => Utf8Builder -> RIO env ()

Log an info level message with no source.

logWarn :: HasConfig env Config => Utf8Builder -> RIO env ()

Log a warn level message with no source.

logError :: HasConfig env Config => Utf8Builder -> RIO env ()

Log an error level message with no source.

logOther

Arguments

:: HasConfig env Config

=> Text

level

-> Utf8Builder

-> RIO env ()

Log a message with the specified textual level and no source.

Advanced logging functions

Sticky logging

logSticky :: HasConfig env Config => Utf8Builder -> RIO env ()

Write a "sticky" line to the terminal. Any subsequent lines will overwrite this one, and that same line will be repeated below again. In other words, the line sticks at the bottom of the output forever. Running this function again will replace the sticky line with a new sticky line. When you want to get rid of the sticky line, run logStickyDone.

Note that not all LogFunc implementations will support sticky messages as described. However, the withLogFunc implementation provided by this module does.

logStickyDone :: HasConfig env Config => Utf8Builder -> RIO env ()

This will print out the given message with a newline and disable any further stickiness of the line until a new call to logSticky happens.

With source

logDebugS :: HasConfig env Config => LogSource -> Utf8Builder -> RIO env ()

Log a debug level message with the given source.

logInfoS :: HasConfig env Config => LogSource -> Utf8Builder -> RIO env ()

Log an info level message with the given source.

logWarnS :: HasConfig env Config => LogSource -> Utf8Builder -> RIO env ()

Log a warn level message with the given source.

logErrorS :: HasConfig env Config => LogSource -> Utf8Builder -> RIO env ()

Log an error level message with the given source.

logOtherS

Arguments

:: HasConfig env Config

=> Text

level

-> LogSource

-> Utf8Builder

-> RIO env ()

Log a message with the specified textual level and the given source.

Generic log function

logGeneric :: HasConfig env Config => LogSource -> LogLevel -> Utf8Builder -> RIO env ()

Generic, basic function for creating other logging functions.

Data types

data LogLevel

The log level of a message.

Since: rio-0.0.0.0

Constructors

LevelDebug

LevelInfo

LevelWarn

LevelError

LevelOther !Text

Instances

Eq LogLevel

Defined in RIO.Prelude.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Defined in RIO.Prelude.Logger

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

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

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Defined in RIO.Prelude.Logger

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in RIO.Prelude.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

type LogSource = Text

Where in the application a log message came from. Used for display purposes only.

Since: rio-0.0.0.0