Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	None
Language	GHC2021

GeniusYield.Types.Logging

Contents

Severity
Verbosity
Namespace
Log contexts
Log environment
Log configuration
Scribe Configuration
Utilities

Description

Synopsis

data GYLogSeverity
- = GYDebug
- | GYInfo
- | GYWarning
- | GYError
logSeverityToKatip :: GYLogSeverity -> Severity
newtype GYLogVerbosity = GYLogVerbosity Verbosity
logVerbosityToKatip :: GYLogVerbosity -> Verbosity
data GYLogNamespace
logNamespaceFromKatip :: Namespace -> GYLogNamespace
logNamespaceToKatip :: GYLogNamespace -> Namespace
data GYLogContexts
logContextsFromKatip :: LogContexts -> GYLogContexts
logContextsToKatip :: GYLogContexts -> LogContexts
addContext :: LogItem i => i -> GYLogContexts -> GYLogContexts
sl :: ToJSON a => Text -> a -> SimpleLogPayload
logContextsToS :: StringConv ByteString a => GYLogContexts -> a
data GYLogEnv
logEnvFromKatip :: LogEnv -> GYLogEnv
logEnvToKatip :: GYLogEnv -> LogEnv
closeScribes :: GYLogEnv -> IO GYLogEnv
data GYLogConfiguration = GYLogConfiguration {
- cfgLogNamespace :: !GYLogNamespace
- cfgLogContexts :: !GYLogContexts
- cfgLogDirector :: !(Either GYLogEnv GYRawLog)
}
data GYRawLog = GYRawLog {
- rawLogRun :: RawLogger
- rawLogCleanUp :: IO ()
}
newtype RawLogger = RawLogger {
- unRawLogger :: GYLogContexts -> GYLogNamespace -> GYLogSeverity -> Text -> IO ()
}
unitRawLogger :: RawLogger
simpleRawLogger :: GYLogSeverity -> (Text -> IO ()) -> RawLogger
cfgAddNamespace :: GYLogNamespace -> GYLogConfiguration -> GYLogConfiguration
cfgAddContext :: LogItem i => i -> GYLogConfiguration -> GYLogConfiguration
logRun :: (HasCallStack, MonadIO m, StringConv a Text) => GYLogConfiguration -> GYLogSeverity -> a -> m ()
data GYLogScribeType
- = GYStdErrScribe
- | GYGCPScribe
- | GYCustomSourceScribe !LogSrc
data GYLogScribeConfig = GYLogScribeConfig {
- cfgLogType :: !GYLogScribeType
- cfgLogSeverity :: !GYLogSeverity
- cfgLogVerbosity :: !GYLogVerbosity
}
newtype LogSrc = LogSrc URI
prettyNamespace :: GYLogNamespace -> String
mkLogEnv :: GYLogNamespace -> [GYLogScribeConfig] -> IO GYLogEnv

Severity

data GYLogSeverity #

>>> LBS8.putStrLn $ Aeson.encode GYDebug
"Debug"

>>> LBS8.putStrLn $ Aeson.encode GYInfo
"Info"

>>> LBS8.putStrLn $ Aeson.encode GYWarning
"Warning"

>>> LBS8.putStrLn $ Aeson.encode GYError
"Error"

Constructors

GYDebug
GYInfo
GYWarning
GYError

Instances

Instances details

FromJSON GYLogSeverity #	`>>>` `Aeson.eitherDecode @GYLogSeverity "\"Debug\""`Right GYDebug `>>>` `Aeson.eitherDecode @GYLogSeverity "\"Info\""`Right GYInfo `>>>` `Aeson.eitherDecode @GYLogSeverity "\"Warning\""`Right GYWarning `>>>` `Aeson.eitherDecode @GYLogSeverity "\"Error\""`Right GYError `>>>` `Aeson.eitherDecode @GYLogSeverity "\"Fatal\""`Left "Error in $: unknown GYLogSeverity: Fatal"
Instance details Defined in GeniusYield.Types.Logging Methods parseJSON :: Value -> Parser GYLogSeverity # parseJSONList :: Value -> Parser [GYLogSeverity] # omittedField :: Maybe GYLogSeverity #
ToJSON GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods toJSON :: GYLogSeverity -> Value # toEncoding :: GYLogSeverity -> Encoding # toJSONList :: [GYLogSeverity] -> Value # toEncodingList :: [GYLogSeverity] -> Encoding # omitField :: GYLogSeverity -> Bool #
Bounded GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods minBound :: GYLogSeverity # maxBound :: GYLogSeverity #
Enum GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods succ :: GYLogSeverity -> GYLogSeverity # pred :: GYLogSeverity -> GYLogSeverity # toEnum :: Int -> GYLogSeverity # fromEnum :: GYLogSeverity -> Int # enumFrom :: GYLogSeverity -> [GYLogSeverity] # enumFromThen :: GYLogSeverity -> GYLogSeverity -> [GYLogSeverity] # enumFromTo :: GYLogSeverity -> GYLogSeverity -> [GYLogSeverity] # enumFromThenTo :: GYLogSeverity -> GYLogSeverity -> GYLogSeverity -> [GYLogSeverity] #
Read GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods readsPrec :: Int -> ReadS GYLogSeverity # readList :: ReadS [GYLogSeverity] # readPrec :: ReadPrec GYLogSeverity # readListPrec :: ReadPrec [GYLogSeverity] #
Show GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> GYLogSeverity -> ShowS # show :: GYLogSeverity -> String # showList :: [GYLogSeverity] -> ShowS #
Eq GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: GYLogSeverity -> GYLogSeverity -> Bool # (/=) :: GYLogSeverity -> GYLogSeverity -> Bool #
Ord GYLogSeverity #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: GYLogSeverity -> GYLogSeverity -> Ordering # (<) :: GYLogSeverity -> GYLogSeverity -> Bool # (<=) :: GYLogSeverity -> GYLogSeverity -> Bool # (>) :: GYLogSeverity -> GYLogSeverity -> Bool # (>=) :: GYLogSeverity -> GYLogSeverity -> Bool # max :: GYLogSeverity -> GYLogSeverity -> GYLogSeverity # min :: GYLogSeverity -> GYLogSeverity -> GYLogSeverity #

logSeverityToKatip :: GYLogSeverity -> Severity #

Verbosity

newtype GYLogVerbosity #

>>> Aeson.eitherDecode @GYLogVerbosity "\"V0\""
Right (GYLogVerbosity V0)

>>> Aeson.eitherDecode @GYLogVerbosity "\"V1\""
Right (GYLogVerbosity V1)

>>> Aeson.eitherDecode @GYLogVerbosity "\"V2\""
Right (GYLogVerbosity V2)

>>> Aeson.eitherDecode @GYLogVerbosity "\"V3\""
Right (GYLogVerbosity V3)

>>> Aeson.eitherDecode @GYLogVerbosity "\"V4\""
Left "Error in $: Invalid Verbosity V4"

Constructors

GYLogVerbosity Verbosity

Instances

Instances details

FromJSON GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods parseJSON :: Value -> Parser GYLogVerbosity # parseJSONList :: Value -> Parser [GYLogVerbosity] # omittedField :: Maybe GYLogVerbosity #
ToJSON GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods toJSON :: GYLogVerbosity -> Value # toEncoding :: GYLogVerbosity -> Encoding # toJSONList :: [GYLogVerbosity] -> Value # toEncodingList :: [GYLogVerbosity] -> Encoding # omitField :: GYLogVerbosity -> Bool #
Bounded GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods minBound :: GYLogVerbosity # maxBound :: GYLogVerbosity #
Enum GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods succ :: GYLogVerbosity -> GYLogVerbosity # pred :: GYLogVerbosity -> GYLogVerbosity # toEnum :: Int -> GYLogVerbosity # fromEnum :: GYLogVerbosity -> Int # enumFrom :: GYLogVerbosity -> [GYLogVerbosity] # enumFromThen :: GYLogVerbosity -> GYLogVerbosity -> [GYLogVerbosity] # enumFromTo :: GYLogVerbosity -> GYLogVerbosity -> [GYLogVerbosity] # enumFromThenTo :: GYLogVerbosity -> GYLogVerbosity -> GYLogVerbosity -> [GYLogVerbosity] #
Read GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods readsPrec :: Int -> ReadS GYLogVerbosity # readList :: ReadS [GYLogVerbosity] # readPrec :: ReadPrec GYLogVerbosity # readListPrec :: ReadPrec [GYLogVerbosity] #
Show GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> GYLogVerbosity -> ShowS # show :: GYLogVerbosity -> String # showList :: [GYLogVerbosity] -> ShowS #
Eq GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: GYLogVerbosity -> GYLogVerbosity -> Bool # (/=) :: GYLogVerbosity -> GYLogVerbosity -> Bool #
Ord GYLogVerbosity #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: GYLogVerbosity -> GYLogVerbosity -> Ordering # (<) :: GYLogVerbosity -> GYLogVerbosity -> Bool # (<=) :: GYLogVerbosity -> GYLogVerbosity -> Bool # (>) :: GYLogVerbosity -> GYLogVerbosity -> Bool # (>=) :: GYLogVerbosity -> GYLogVerbosity -> Bool # max :: GYLogVerbosity -> GYLogVerbosity -> GYLogVerbosity # min :: GYLogVerbosity -> GYLogVerbosity -> GYLogVerbosity #

logVerbosityToKatip :: GYLogVerbosity -> Verbosity #

Namespace

data GYLogNamespace #

>>> "My" <> "Namespace" :: GYLogNamespace
GYLogNamespace (Namespace {unNamespace = ["My","Namespace"]})

Instances

Instances details

PrintfArg GYLogNamespace #	`>>>` `printf "%s" ("My" <> "Namespace" :: GYLogNamespace)`My.Namespace
Instance details Defined in GeniusYield.Types.Logging Methods formatArg :: GYLogNamespace -> FieldFormatter # parseFormat :: GYLogNamespace -> ModifierParser #
Monoid GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods mempty :: GYLogNamespace # mappend :: GYLogNamespace -> GYLogNamespace -> GYLogNamespace # mconcat :: [GYLogNamespace] -> GYLogNamespace #
Semigroup GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods (<>) :: GYLogNamespace -> GYLogNamespace -> GYLogNamespace # sconcat :: NonEmpty GYLogNamespace -> GYLogNamespace # stimes :: Integral b => b -> GYLogNamespace -> GYLogNamespace #
IsString GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods fromString :: String -> GYLogNamespace #
Read GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods readsPrec :: Int -> ReadS GYLogNamespace # readList :: ReadS [GYLogNamespace] # readPrec :: ReadPrec GYLogNamespace # readListPrec :: ReadPrec [GYLogNamespace] #
Show GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> GYLogNamespace -> ShowS # show :: GYLogNamespace -> String # showList :: [GYLogNamespace] -> ShowS #
Eq GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: GYLogNamespace -> GYLogNamespace -> Bool # (/=) :: GYLogNamespace -> GYLogNamespace -> Bool #
Ord GYLogNamespace #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: GYLogNamespace -> GYLogNamespace -> Ordering # (<) :: GYLogNamespace -> GYLogNamespace -> Bool # (<=) :: GYLogNamespace -> GYLogNamespace -> Bool # (>) :: GYLogNamespace -> GYLogNamespace -> Bool # (>=) :: GYLogNamespace -> GYLogNamespace -> Bool # max :: GYLogNamespace -> GYLogNamespace -> GYLogNamespace # min :: GYLogNamespace -> GYLogNamespace -> GYLogNamespace #

logNamespaceFromKatip :: Namespace -> GYLogNamespace #

logNamespaceToKatip :: GYLogNamespace -> Namespace #

Log contexts

data GYLogContexts #

Instances

Instances details

Monoid GYLogContexts #
Instance details Defined in GeniusYield.Types.Logging Methods mempty :: GYLogContexts # mappend :: GYLogContexts -> GYLogContexts -> GYLogContexts # mconcat :: [GYLogContexts] -> GYLogContexts #
Semigroup GYLogContexts #
Instance details Defined in GeniusYield.Types.Logging Methods (<>) :: GYLogContexts -> GYLogContexts -> GYLogContexts # sconcat :: NonEmpty GYLogContexts -> GYLogContexts # stimes :: Integral b => b -> GYLogContexts -> GYLogContexts #

logContextsFromKatip :: LogContexts -> GYLogContexts #

logContextsToKatip :: GYLogContexts -> LogContexts #

addContext :: LogItem i => i -> GYLogContexts -> GYLogContexts #

Add a context to the log contexts. See sl.

sl :: ToJSON a => Text -> a -> SimpleLogPayload #

Construct a simple log payload.

>>> Aeson.encode $ logContextsToKatip $ addContext (sl "key" "value") mempty
"{\"key\":\"value\"}"

logContextsToS :: StringConv ByteString a => GYLogContexts -> a #

Get textual representation of log contexts.

>>> logContextsToS @Text $ addContext (sl "key" "value") mempty
"{\"key\":\"value\"}"

Log environment

data GYLogEnv #

logEnvFromKatip :: LogEnv -> GYLogEnv #

logEnvToKatip :: GYLogEnv -> LogEnv #

closeScribes :: GYLogEnv -> IO GYLogEnv #

Calls closeScribes from Katip.

Log configuration

data GYLogConfiguration #

Constructors

GYLogConfiguration
Fields cfgLogNamespace :: !GYLogNamespace cfgLogContexts :: !GYLogContexts cfgLogDirector :: !(Either GYLogEnv GYRawLog)

data GYRawLog #

Constructors

GYRawLog
Fields rawLogRun :: RawLogger rawLogCleanUp :: IO ()

newtype RawLogger #

Constructors

RawLogger
Fields unRawLogger :: GYLogContexts -> GYLogNamespace -> GYLogSeverity -> Text -> IO ()

unitRawLogger :: RawLogger #

A logger that does ignores the logs.

simpleRawLogger :: GYLogSeverity -> (Text -> IO ()) -> RawLogger #

A logger that ignores context and namespace and filters messages based on severity.

cfgAddNamespace :: GYLogNamespace -> GYLogConfiguration -> GYLogConfiguration #

cfgAddContext :: LogItem i => i -> GYLogConfiguration -> GYLogConfiguration #

logRun :: (HasCallStack, MonadIO m, StringConv a Text) => GYLogConfiguration -> GYLogSeverity -> a -> m () #

Scribe Configuration

data GYLogScribeType #

Constructors

GYStdErrScribe
GYGCPScribe
GYCustomSourceScribe !LogSrc

Instances

Instances details

FromJSON GYLogScribeType #	`>>>` `Aeson.eitherDecode @GYLogScribeType "{\"tag\":\"stderr\"}"`Right GYStdErrScribe `>>>` `Aeson.eitherDecode @GYLogScribeType "{\"tag\":\"gySource\",\"source\":\"log.txt\"}"`Right (GYCustomSourceScribe (LogSrc log.txt)) `>>>` `Aeson.eitherDecode @GYLogScribeType "{\"tag\":\"gySource\",\"source\":\"https://pub:[email protected]:8443/sentry/example_project\"}"`Right (GYCustomSourceScribe (LogSrc https://pub:[email protected]:8443/sentry/example_project)) `>>>` `Aeson.eitherDecode @GYLogScribeType "{\"tag\":\"fancy-scribe\"}"`Left "Error in $: unknown GYLogScribe tag: fancy-scribe"
Instance details Defined in GeniusYield.Types.Logging Methods parseJSON :: Value -> Parser GYLogScribeType # parseJSONList :: Value -> Parser [GYLogScribeType] # omittedField :: Maybe GYLogScribeType #
ToJSON GYLogScribeType #	`>>>` `LBS8.putStrLn $ Aeson.encode GYStdErrScribe`{"tag":"stderr"} `>>>` `LBS8.putStrLn $ Aeson.encode $ GYCustomSourceScribe "https://pub:[email protected]:8443/sentry/example_project"`{"tag":"gySource","source":"https://pub:[email protected]:8443/sentry/example_project"} `>>>` `LBS8.putStrLn $ Aeson.encode $ GYCustomSourceScribe "log.txt"`{"tag":"gySource","source":"log.txt"}
Instance details Defined in GeniusYield.Types.Logging Methods toJSON :: GYLogScribeType -> Value # toEncoding :: GYLogScribeType -> Encoding # toJSONList :: [GYLogScribeType] -> Value # toEncodingList :: [GYLogScribeType] -> Encoding # omitField :: GYLogScribeType -> Bool #
Show GYLogScribeType #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> GYLogScribeType -> ShowS # show :: GYLogScribeType -> String # showList :: [GYLogScribeType] -> ShowS #
Eq GYLogScribeType #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: GYLogScribeType -> GYLogScribeType -> Bool # (/=) :: GYLogScribeType -> GYLogScribeType -> Bool #
Ord GYLogScribeType #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: GYLogScribeType -> GYLogScribeType -> Ordering # (<) :: GYLogScribeType -> GYLogScribeType -> Bool # (<=) :: GYLogScribeType -> GYLogScribeType -> Bool # (>) :: GYLogScribeType -> GYLogScribeType -> Bool # (>=) :: GYLogScribeType -> GYLogScribeType -> Bool # max :: GYLogScribeType -> GYLogScribeType -> GYLogScribeType # min :: GYLogScribeType -> GYLogScribeType -> GYLogScribeType #

data GYLogScribeConfig #

Constructors

GYLogScribeConfig
Fields cfgLogType :: !GYLogScribeType cfgLogSeverity :: !GYLogSeverity cfgLogVerbosity :: !GYLogVerbosity

Instances

Instances details

FromJSON GYLogScribeConfig #	`>>>` `Aeson.decode @GYLogScribeConfig "{\"severity\":\"Warning\",\"verbosity\":\"V1\",\"type\":{\"tag\":\"gySource\",\"source\":\"log.txt\"}}"`Just (GYLogScribeConfig {cfgLogType = GYCustomSourceScribe (LogSrc log.txt), cfgLogSeverity = GYWarning, cfgLogVerbosity = GYLogVerbosity V1})
Instance details Defined in GeniusYield.Types.Logging Methods parseJSON :: Value -> Parser GYLogScribeConfig # parseJSONList :: Value -> Parser [GYLogScribeConfig] # omittedField :: Maybe GYLogScribeConfig #
ToJSON GYLogScribeConfig #	`>>>` `LBS8.putStrLn $ Aeson.encode $ GYLogScribeConfig (GYCustomSourceScribe "log.txt") GYWarning (read "GYLogVerbosity V1")`{"type":{"tag":"gySource","source":"log.txt"},"severity":"Warning","verbosity":"V1"}
Instance details Defined in GeniusYield.Types.Logging Methods toJSON :: GYLogScribeConfig -> Value # toEncoding :: GYLogScribeConfig -> Encoding # toJSONList :: [GYLogScribeConfig] -> Value # toEncodingList :: [GYLogScribeConfig] -> Encoding # omitField :: GYLogScribeConfig -> Bool #
Show GYLogScribeConfig #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> GYLogScribeConfig -> ShowS # show :: GYLogScribeConfig -> String # showList :: [GYLogScribeConfig] -> ShowS #
Eq GYLogScribeConfig #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool # (/=) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool #
Ord GYLogScribeConfig #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: GYLogScribeConfig -> GYLogScribeConfig -> Ordering # (<) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool # (<=) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool # (>) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool # (>=) :: GYLogScribeConfig -> GYLogScribeConfig -> Bool # max :: GYLogScribeConfig -> GYLogScribeConfig -> GYLogScribeConfig # min :: GYLogScribeConfig -> GYLogScribeConfig -> GYLogScribeConfig #

newtype LogSrc #

Constructors

LogSrc URI

Instances

Instances details

FromJSON LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods parseJSON :: Value -> Parser LogSrc # parseJSONList :: Value -> Parser [LogSrc] # omittedField :: Maybe LogSrc #
ToJSON LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods toJSON :: LogSrc -> Value # toEncoding :: LogSrc -> Encoding # toJSONList :: [LogSrc] -> Value # toEncodingList :: [LogSrc] -> Encoding # omitField :: LogSrc -> Bool #
IsString LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods fromString :: String -> LogSrc #
Show LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods showsPrec :: Int -> LogSrc -> ShowS # show :: LogSrc -> String # showList :: [LogSrc] -> ShowS #
Eq LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods (==) :: LogSrc -> LogSrc -> Bool # (/=) :: LogSrc -> LogSrc -> Bool #
Ord LogSrc #
Instance details Defined in GeniusYield.Types.Logging Methods compare :: LogSrc -> LogSrc -> Ordering # (<) :: LogSrc -> LogSrc -> Bool # (<=) :: LogSrc -> LogSrc -> Bool # (>) :: LogSrc -> LogSrc -> Bool # (>=) :: LogSrc -> LogSrc -> Bool # max :: LogSrc -> LogSrc -> LogSrc # min :: LogSrc -> LogSrc -> LogSrc #

Utilities

prettyNamespace :: GYLogNamespace -> String #

mkLogEnv :: GYLogNamespace -> [GYLogScribeConfig] -> IO GYLogEnv #