Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.System.Logging

Synopsis

data LogLevel
- = DEBUG
- | INFO
- | NOTICE
- | WARNING
- | ERROR
- | CRITICAL
- | ALERT
- | EMERGENCY
class HasLogger m where
- data Logger m :: Type
- type LogInitParams m :: Type
- type LogPayload m :: Type
- initLogger :: LogInitParams m -> forall m1. MonadIO m1 => m1 (Logger m)
- destroyLogger :: Logger m -> forall m1. MonadIO m1 => m1 ()
- logMsg :: Logger m -> LogLevel -> LogPayload m -> m ()
- logTxt :: Logger m -> LogLevel -> Text -> m ()
class HasLogger m => MonadLogger m where
- getLogger :: m (Logger m)
logM :: (Monad m, MonadLogger m) => LogLevel -> Text -> m ()
logLocM :: ExpQ
logLoc :: ExpQ
withLogger :: (MonadBaseControl IO m, MonadIO m, HasLogger m) => LogInitParams m -> (Logger m -> m a) -> m a
withLoggerHoisted :: (MonadBaseControl IO m, HasLogger m) => LogInitParams m -> (Logger m -> IO a) -> IO a

Documentation

data LogLevel #

Constructors

DEBUG	Debug messages
INFO	Information
NOTICE	Normal runtime conditions
WARNING	General Warnings
ERROR	General Errors
CRITICAL	Severe situations
ALERT	Take immediate action
EMERGENCY	System is unusable

Instances

Instances details

Bounded LogLevel #
Instance details Defined in Gargantext.System.Logging Methods minBound :: LogLevel # maxBound :: LogLevel #
Enum LogLevel #
Instance details Defined in Gargantext.System.Logging Methods succ :: LogLevel -> LogLevel # pred :: LogLevel -> LogLevel # toEnum :: Int -> LogLevel # fromEnum :: LogLevel -> Int # enumFrom :: LogLevel -> [LogLevel] # enumFromThen :: LogLevel -> LogLevel -> [LogLevel] # enumFromTo :: LogLevel -> LogLevel -> [LogLevel] # enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel] #
Show LogLevel #
Instance details Defined in Gargantext.System.Logging Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Eq LogLevel #
Instance details Defined in Gargantext.System.Logging Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel #
Instance details Defined in Gargantext.System.Logging 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 #

class HasLogger m where #

This is a barebore logging interface which we can extend to plug a proper logging library, without the details of the logger cropping up everywhere in the rest of the codebase.

Associated Types

data Logger m :: Type #

type LogInitParams m :: Type #

type LogPayload m :: Type #

Methods

initLogger :: LogInitParams m -> forall m1. MonadIO m1 => m1 (Logger m) #

destroyLogger :: Logger m -> forall m1. MonadIO m1 => m1 () #

logMsg :: Logger m -> LogLevel -> LogPayload m -> m () #

logTxt :: Logger m -> LogLevel -> Text -> m () #

Instances

Instances details

HasLogger IO #	A plain logger in the IO monad, waiting for more serious logging solutions like the one described in https://gitlab.iscpif.fr/gargantext/haskell-gargantext/issues/229
Instance details Defined in Gargantext.System.Logging Associated Types data Logger IO # type LogInitParams IO # type LogPayload IO # Methods initLogger :: LogInitParams IO -> forall (m1 :: Type -> Type). MonadIO m1 => m1 (Logger IO) # destroyLogger :: Logger IO -> forall (m1 :: Type -> Type). MonadIO m1 => m1 () # logMsg :: Logger IO -> LogLevel -> LogPayload IO -> IO () # logTxt :: Logger IO -> LogLevel -> Text -> IO () #
HasLogger (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types data Logger (GargM DevEnv BackendInternalError) # type LogInitParams (GargM DevEnv BackendInternalError) # type LogPayload (GargM DevEnv BackendInternalError) # Methods initLogger :: LogInitParams (GargM DevEnv BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 (Logger (GargM DevEnv BackendInternalError)) # destroyLogger :: Logger (GargM DevEnv BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 () # logMsg :: Logger (GargM DevEnv BackendInternalError) -> LogLevel -> LogPayload (GargM DevEnv BackendInternalError) -> GargM DevEnv BackendInternalError () # logTxt :: Logger (GargM DevEnv BackendInternalError) -> LogLevel -> Text -> GargM DevEnv BackendInternalError () #
HasLogger (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Associated Types data Logger (GargM Env BackendInternalError) # type LogInitParams (GargM Env BackendInternalError) # type LogPayload (GargM Env BackendInternalError) # Methods initLogger :: LogInitParams (GargM Env BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 (Logger (GargM Env BackendInternalError)) # destroyLogger :: Logger (GargM Env BackendInternalError) -> forall (m1 :: Type -> Type). MonadIO m1 => m1 () # logMsg :: Logger (GargM Env BackendInternalError) -> LogLevel -> LogPayload (GargM Env BackendInternalError) -> GargM Env BackendInternalError () # logTxt :: Logger (GargM Env BackendInternalError) -> LogLevel -> Text -> GargM Env BackendInternalError () #

class HasLogger m => MonadLogger m where #

Separate typeclass to get hold of a Logger from within a monad. We keey HasLogger and MonadLogger separate to enforce compositionality, i.e. we can still give instances to HasLogger for things like IO without having to force actually acquiring a logger for those monads.

Methods

getLogger :: m (Logger m) #

Instances

Instances details

MonadLogger (GargM DevEnv BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getLogger :: GargM DevEnv BackendInternalError (Logger (GargM DevEnv BackendInternalError)) #
MonadLogger (GargM Env BackendInternalError) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getLogger :: GargM Env BackendInternalError (Logger (GargM Env BackendInternalError)) #

logM :: (Monad m, MonadLogger m) => LogLevel -> Text -> m () #

A variant of logTxt that doesn't require passing an explicit Logger.

logLocM :: ExpQ #

Like logM, but it automatically adds the file and line number to the output log.

logLoc :: ExpQ #

withLogger :: (MonadBaseControl IO m, MonadIO m, HasLogger m) => LogInitParams m -> (Logger m -> m a) -> m a #

exception-safe combinator that creates and destroys a logger. Think about it like a bracket function from Exception.

withLoggerHoisted :: (MonadBaseControl IO m, HasLogger m) => LogInitParams m -> (Logger m -> IO a) -> IO a #

Like withLogger, but it allows creating a Logger that can run in a different monad from within an IO action.