Safe Haskell	None
Language	Haskell2010

Control.Eff.Log.Message

Description

An RFC 5434 inspired log message and convenience functions for logging them.

Synopsis

data LogMessage = LogMessage {
- _lmFacility :: Facility
- _lmSeverity :: Severity
- _lmTimestamp :: Maybe UTCTime
- _lmHostname :: Maybe String
- _lmAppname :: Maybe String
- _lmProcessId :: Maybe String
- _lmMessageId :: Maybe String
- _lmStructuredData :: [StructuredDataElement]
- _lmThreadId :: Maybe ThreadId
- _lmSrcLoc :: Maybe SrcLoc
- _lmMessage :: String
}
renderRFC5424 :: LogMessage -> String
printLogMessage :: LogMessage -> IO ()
relogAsDebugMessages :: Member (Logs LogMessage) e => Eff (Logs String ': e) a -> Eff e a
logWithSeverity :: Member (Logs LogMessage) e => Severity -> String -> Eff e ()
logEmergency :: Member (Logs LogMessage) e => String -> Eff e ()
logAlert :: Member (Logs LogMessage) e => String -> Eff e ()
logCritical :: Member (Logs LogMessage) e => String -> Eff e ()
logError :: Member (Logs LogMessage) e => String -> Eff e ()
logWarning :: Member (Logs LogMessage) e => String -> Eff e ()
logNotice :: Member (Logs LogMessage) e => String -> Eff e ()
logInfo :: Member (Logs LogMessage) e => String -> Eff e ()
logDebug :: Member (Logs LogMessage) e => String -> Eff e ()
errorMessage :: String -> LogMessage
infoMessage :: String -> LogMessage
debugMessage :: String -> LogMessage
errorMessageIO :: MonadIO m => String -> m LogMessage
infoMessageIO :: MonadIO m => String -> m LogMessage
debugMessageIO :: MonadIO m => String -> m LogMessage
data Severity
emergencySeverity :: Severity
alertSeverity :: Severity
criticalSeverity :: Severity
errorSeverity :: Severity
warningSeverity :: Severity
noticeSeverity :: Severity
informationalSeverity :: Severity
debugSeverity :: Severity
data Facility
kernelMessages :: Facility
userLevelMessages :: Facility
mailSystem :: Facility
systemDaemons :: Facility
securityAuthorizationMessages4 :: Facility
linePrinterSubsystem :: Facility
networkNewsSubsystem :: Facility
uucpSubsystem :: Facility
clockDaemon :: Facility
securityAuthorizationMessages10 :: Facility
ftpDaemon :: Facility
ntpSubsystem :: Facility
logAuditFacility :: Facility
logAlertFacility :: Facility
clockDaemon2 :: Facility
local0 :: Facility
local1 :: Facility
local2 :: Facility
local3 :: Facility
local4 :: Facility
local5 :: Facility
local6 :: Facility
local7 :: Facility
lmFacility :: Lens' LogMessage Facility
lmSeverity :: Lens' LogMessage Severity
lmTimestamp :: Lens' LogMessage (Maybe UTCTime)
lmHostname :: Lens' LogMessage (Maybe String)
lmAppname :: Lens' LogMessage (Maybe String)
lmProcessId :: Lens' LogMessage (Maybe String)
lmMessageId :: Lens' LogMessage (Maybe String)
lmStructuredData :: Lens' LogMessage [StructuredDataElement]
lmSrcLoc :: Lens' LogMessage (Maybe SrcLoc)
lmThreadId :: Lens' LogMessage (Maybe ThreadId)
lmMessage :: Lens' LogMessage String
setCallStack :: CallStack -> LogMessage -> LogMessage
data StructuredDataElement = SdElement {
- _sdElementId :: String
- _sdElementParameters :: [SdParameter]
}
sdElementId :: Lens' StructuredDataElement String
sdElementParameters :: Lens' StructuredDataElement [SdParameter]

Documentation

data LogMessage Source #

A message data type inspired by the RFC-5424 Syslog Protocol

Constructors

LogMessage
Fields _lmFacility :: Facility _lmSeverity :: Severity _lmTimestamp :: Maybe UTCTime _lmHostname :: Maybe String _lmAppname :: Maybe String _lmProcessId :: Maybe String _lmMessageId :: Maybe String _lmStructuredData :: [StructuredDataElement] _lmThreadId :: Maybe ThreadId _lmSrcLoc :: Maybe SrcLoc _lmMessage :: String

Instances

Eq LogMessage Source #
Instance details Defined in Control.Eff.Log.Message Methods (==) :: LogMessage -> LogMessage -> Bool # (/=) :: LogMessage -> LogMessage -> Bool #
IsString LogMessage Source #
Instance details Defined in Control.Eff.Log.Message Methods fromString :: String -> LogMessage #
Generic LogMessage Source #
Instance details Defined in Control.Eff.Log.Message Associated Types type Rep LogMessage :: * -> * # Methods from :: LogMessage -> Rep LogMessage x # to :: Rep LogMessage x -> LogMessage #
Default LogMessage Source #
Instance details Defined in Control.Eff.Log.Message Methods def :: LogMessage #
NFData LogMessage Source #
Instance details Defined in Control.Eff.Log.Message Methods rnf :: LogMessage -> () #
type Rep LogMessage Source #
Instance details Defined in Control.Eff.Log.Message type Rep LogMessage = D1 (MetaData "LogMessage" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.6.2-Dn0edfhM7NrCsGRg2jlKcC" False) (C1 (MetaCons "LogMessage" PrefixI True) (((S1 (MetaSel (Just "_lmFacility") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Facility) :: S1 (MetaSel (Just "_lmSeverity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Severity)) :: (S1 (MetaSel (Just "_lmTimestamp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)) :: (S1 (MetaSel (Just "_lmHostname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "_lmAppname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))))) :: ((S1 (MetaSel (Just "_lmProcessId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: (S1 (MetaSel (Just "_lmMessageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "_lmStructuredData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [StructuredDataElement]))) :: (S1 (MetaSel (Just "_lmThreadId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ThreadId)) :: (S1 (MetaSel (Just "_lmSrcLoc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SrcLoc)) :: S1 (MetaSel (Just "_lmMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

renderRFC5424 :: LogMessage -> String Source #

Render a LogMessage according to the rules in the given RFC, except for the rules concerning unicode and ascii

printLogMessage :: LogMessage -> IO () Source #

Render a LogMessage but set the timestamp and thread id fields.

relogAsDebugMessages :: Member (Logs LogMessage) e => Eff (Logs String ': e) a -> Eff e a Source #

Handle a Logs effect for String messages by re-logging the messages as LogMessages with debugSeverity.

logWithSeverity :: Member (Logs LogMessage) e => Severity -> String -> Eff e () Source #

Log a String as LogMessage with a given Severity.

logEmergency :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a String as emergencySeverity.

logAlert :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a message with alertSeverity.

logCritical :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a criticalSeverity message.

logError :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a errorSeverity message.

logWarning :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a warningSeverity message.

logNotice :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a noticeSeverity message.

logInfo :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a informationalSeverity message.

logDebug :: Member (Logs LogMessage) e => String -> Eff e () Source #

Log a debugSeverity message.

errorMessage :: String -> LogMessage Source #

Construct a LogMessage with errorSeverity

infoMessage :: String -> LogMessage Source #

Construct a LogMessage with informationalSeverity

debugMessage :: String -> LogMessage Source #

Construct a LogMessage with debugSeverity

errorMessageIO :: MonadIO m => String -> m LogMessage Source #

Construct a LogMessage with errorSeverity

infoMessageIO :: MonadIO m => String -> m LogMessage Source #

Construct a LogMessage with informationalSeverity

debugMessageIO :: MonadIO m => String -> m LogMessage Source #

Construct a LogMessage with debugSeverity

data Severity Source #

An rfc 5424 severity

Instances

Eq Severity Source #
Instance details Defined in Control.Eff.Log.Message Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Ord Severity Source #
Instance details Defined in Control.Eff.Log.Message Methods compare :: Severity -> Severity -> Ordering # (<) :: Severity -> Severity -> Bool # (<=) :: Severity -> Severity -> Bool # (>) :: Severity -> Severity -> Bool # (>=) :: Severity -> Severity -> Bool # max :: Severity -> Severity -> Severity # min :: Severity -> Severity -> Severity #
Show Severity Source #
Instance details Defined in Control.Eff.Log.Message Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #
Generic Severity Source #
Instance details Defined in Control.Eff.Log.Message Associated Types type Rep Severity :: * -> * # Methods from :: Severity -> Rep Severity x # to :: Rep Severity x -> Severity #
Default Severity Source #
Instance details Defined in Control.Eff.Log.Message Methods def :: Severity #
NFData Severity Source #
Instance details Defined in Control.Eff.Log.Message Methods rnf :: Severity -> () #
type Rep Severity Source #
Instance details Defined in Control.Eff.Log.Message type Rep Severity = D1 (MetaData "Severity" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.6.2-Dn0edfhM7NrCsGRg2jlKcC" True) (C1 (MetaCons "Severity" PrefixI True) (S1 (MetaSel (Just "fromSeverity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

emergencySeverity :: Severity Source #

alertSeverity :: Severity Source #

criticalSeverity :: Severity Source #

errorSeverity :: Severity Source #

warningSeverity :: Severity Source #

noticeSeverity :: Severity Source #

informationalSeverity :: Severity Source #

debugSeverity :: Severity Source #

data Facility Source #

An rfc 5424 facility

Instances

Eq Facility Source #
Instance details Defined in Control.Eff.Log.Message Methods (==) :: Facility -> Facility -> Bool # (/=) :: Facility -> Facility -> Bool #
Ord Facility Source #
Instance details Defined in Control.Eff.Log.Message Methods compare :: Facility -> Facility -> Ordering # (<) :: Facility -> Facility -> Bool # (<=) :: Facility -> Facility -> Bool # (>) :: Facility -> Facility -> Bool # (>=) :: Facility -> Facility -> Bool # max :: Facility -> Facility -> Facility # min :: Facility -> Facility -> Facility #
Show Facility Source #
Instance details Defined in Control.Eff.Log.Message Methods showsPrec :: Int -> Facility -> ShowS # show :: Facility -> String # showList :: [Facility] -> ShowS #
Generic Facility Source #
Instance details Defined in Control.Eff.Log.Message Associated Types type Rep Facility :: * -> * # Methods from :: Facility -> Rep Facility x # to :: Rep Facility x -> Facility #
Default Facility Source #
Instance details Defined in Control.Eff.Log.Message Methods def :: Facility #
NFData Facility Source #
Instance details Defined in Control.Eff.Log.Message Methods rnf :: Facility -> () #
type Rep Facility Source #
Instance details Defined in Control.Eff.Log.Message type Rep Facility = D1 (MetaData "Facility" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.6.2-Dn0edfhM7NrCsGRg2jlKcC" True) (C1 (MetaCons "Facility" PrefixI True) (S1 (MetaSel (Just "fromFacility") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

kernelMessages :: Facility Source #

userLevelMessages :: Facility Source #

mailSystem :: Facility Source #

systemDaemons :: Facility Source #

securityAuthorizationMessages4 :: Facility Source #

linePrinterSubsystem :: Facility Source #

networkNewsSubsystem :: Facility Source #

uucpSubsystem :: Facility Source #

clockDaemon :: Facility Source #

securityAuthorizationMessages10 :: Facility Source #

ftpDaemon :: Facility Source #

ntpSubsystem :: Facility Source #

logAuditFacility :: Facility Source #

logAlertFacility :: Facility Source #

clockDaemon2 :: Facility Source #

local0 :: Facility Source #

local1 :: Facility Source #

local2 :: Facility Source #

local3 :: Facility Source #

local4 :: Facility Source #

local5 :: Facility Source #

local6 :: Facility Source #

local7 :: Facility Source #

lmFacility :: Lens' LogMessage Facility Source #

lmSeverity :: Lens' LogMessage Severity Source #

lmTimestamp :: Lens' LogMessage (Maybe UTCTime) Source #

lmHostname :: Lens' LogMessage (Maybe String) Source #

lmAppname :: Lens' LogMessage (Maybe String) Source #

lmProcessId :: Lens' LogMessage (Maybe String) Source #

lmMessageId :: Lens' LogMessage (Maybe String) Source #

lmStructuredData :: Lens' LogMessage [StructuredDataElement] Source #

lmSrcLoc :: Lens' LogMessage (Maybe SrcLoc) Source #

lmThreadId :: Lens' LogMessage (Maybe ThreadId) Source #

lmMessage :: Lens' LogMessage String Source #

setCallStack :: CallStack -> LogMessage -> LogMessage Source #

Put the source location of the given callstack in lmSrcLoc

data StructuredDataElement Source #

RFC-5424 defines how structured data can be included in a log message.

Constructors

SdElement
Fields _sdElementId :: String _sdElementParameters :: [SdParameter]

Instances

Eq StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message Methods (==) :: StructuredDataElement -> StructuredDataElement -> Bool # (/=) :: StructuredDataElement -> StructuredDataElement -> Bool #
Ord StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message Methods compare :: StructuredDataElement -> StructuredDataElement -> Ordering # (<) :: StructuredDataElement -> StructuredDataElement -> Bool # (<=) :: StructuredDataElement -> StructuredDataElement -> Bool # (>) :: StructuredDataElement -> StructuredDataElement -> Bool # (>=) :: StructuredDataElement -> StructuredDataElement -> Bool # max :: StructuredDataElement -> StructuredDataElement -> StructuredDataElement # min :: StructuredDataElement -> StructuredDataElement -> StructuredDataElement #
Show StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message Methods showsPrec :: Int -> StructuredDataElement -> ShowS # show :: StructuredDataElement -> String # showList :: [StructuredDataElement] -> ShowS #
Generic StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message Associated Types type Rep StructuredDataElement :: * -> * # Methods from :: StructuredDataElement -> Rep StructuredDataElement x # to :: Rep StructuredDataElement x -> StructuredDataElement #
NFData StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message Methods rnf :: StructuredDataElement -> () #
type Rep StructuredDataElement Source #
Instance details Defined in Control.Eff.Log.Message type Rep StructuredDataElement

sdElementId :: Lens' StructuredDataElement String Source #

sdElementParameters :: Lens' StructuredDataElement [SdParameter] Source #