Control.Eff.Log.Message

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

Log Message Data Type

data LogMessage

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

Constructors

MkLogMessage

Fields

• _lmFacility :: !Facility
• _lmSeverity :: !Severity
• _lmTimestamp :: Maybe UTCTime
• _lmHostname :: Maybe Text
• _lmAppName :: Maybe Text
• _lmProcessId :: Maybe Text
• _lmMessageId :: Maybe Text
• _lmStructuredData :: [StructuredDataElement]
• _lmThreadId :: Maybe ThreadId
• _lmSrcLoc :: Maybe SrcLoc
• _lmMessage :: Text

Instances

Eq LogMessage

Defined in Control.Eff.Log.Message

Methods

(==) :: LogMessage -> LogMessage -> Bool

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

Show LogMessage

This instance is only supposed to be used for unit tests and debugging.

Defined in Control.Eff.Log.Message

Methods

showsPrec :: Int -> LogMessage -> ShowS

show :: LogMessage -> String

showList :: [LogMessage] -> ShowS

IsString LogMessage

Defined in Control.Eff.Log.Message

Methods

fromString :: String -> LogMessage

Generic LogMessage

Defined in Control.Eff.Log.Message

Associated Types

type Rep LogMessage :: Type -> Type

Methods

from :: LogMessage -> Rep LogMessage x

to :: Rep LogMessage x -> LogMessage

Default LogMessage

Defined in Control.Eff.Log.Message

Methods

def :: LogMessage

NFData LogMessage

Defined in Control.Eff.Log.Message

Methods

rnf :: LogMessage -> ()

ToLogMessage LogMessage

Defined in Control.Eff.Log.Message

Methods

toLogMessage :: LogMessage -> LogMessage

Handle Logs e a (LogPredicate -> k)

Defined in Control.Eff.Log.Handler

Methods

handle :: (Eff e a -> LogPredicate -> k) -> Arrs e v a -> Logs v -> LogPredicate -> k

handle_relay :: (e ~ (Logs ': r'), Relay (LogPredicate -> k) r') => (a -> LogPredicate -> k) -> (Eff e a -> LogPredicate -> k) -> Eff e a -> LogPredicate -> k

respond_relay :: (a -> LogPredicate -> k) -> (Eff e a -> LogPredicate -> k) -> Eff e a -> LogPredicate -> k

type Rep LogMessage

Defined in Control.Eff.Log.Message

type Rep LogMessage = D1 (MetaData "LogMessage" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.32.0-GimAdtHOovq4dulPgeQPe9" False) (C1 (MetaCons "MkLogMessage" PrefixI True) (((S1 (MetaSel (Just "_lmFacility") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Facility) :*: S1 (MetaSel (Just "_lmSeverity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Severity)) :*: (S1 (MetaSel (Just "_lmTimestamp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)) :*: (S1 (MetaSel (Just "_lmHostname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lmAppName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_lmProcessId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lmMessageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: 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 Text))))))

Field Accessors

lmFacility :: Functor f => (Facility -> f Facility) -> LogMessage -> f LogMessage

A lens for the Facility of a LogMessage

lmSeverity :: Functor f => (Severity -> f Severity) -> LogMessage -> f LogMessage

A lens for the Severity of a LogMessage

lmTimestamp :: Functor f => (Maybe UTCTime -> f (Maybe UTCTime)) -> LogMessage -> f LogMessage

A lens for the UTC time of a LogMessage The function setLogMessageTimestamp can be used to set the field.

lmHostname :: Functor f => (Maybe Text -> f (Maybe Text)) -> LogMessage -> f LogMessage

A lens for the hostname of a LogMessage The function setLogMessageHostname can be used to set the field.

lmAppName :: Functor f => (Maybe Text -> f (Maybe Text)) -> LogMessage -> f LogMessage

A lens for the RFC 5424 application name of a LogMessage

One useful pattern for using this field, is to implement log filters that allow info and debug message from the application itself while only allowing warning and error messages from third party libraries:

debugLogsForAppName myAppName lm =
  view lmAppName lm == Just myAppName || lmSeverityIsAtLeast warningSeverity lm

This concept is also implemented in discriminateByAppName.

lmProcessId :: Functor f => (Maybe Text -> f (Maybe Text)) -> LogMessage -> f LogMessage

A lens for a user defined of process id of a LogMessage

lmMessageId :: Functor f => (Maybe Text -> f (Maybe Text)) -> LogMessage -> f LogMessage

A lens for a user defined message id of a LogMessage

lmStructuredData :: Functor f => ([StructuredDataElement] -> f [StructuredDataElement]) -> LogMessage -> f LogMessage

A lens for the StructuredDataElement of a LogMessage

lmSrcLoc :: Functor f => (Maybe SrcLoc -> f (Maybe SrcLoc)) -> LogMessage -> f LogMessage

A lens for the SrcLoc of a LogMessage

lmThreadId :: Functor f => (Maybe ThreadId -> f (Maybe ThreadId)) -> LogMessage -> f LogMessage

A lens for the ThreadId of a LogMessage The function setLogMessageThreadId can be used to set the field.

lmMessage :: Functor f => (Text -> f Text) -> LogMessage -> f LogMessage

A lens for the user defined textual message of a LogMessage

IO Based LogMessage Modification

setCallStack :: CallStack -> LogMessage -> LogMessage

Put the source location of the given callstack in lmSrcLoc

prefixLogMessagesWith :: Text -> LogMessage -> LogMessage

Prefix the lmMessage.

setLogMessageTimestamp :: LogMessage -> IO LogMessage

An IO action that sets the current UTC time in lmTimestamp.

setLogMessageThreadId :: LogMessage -> IO LogMessage

An IO action appends the the ThreadId of the calling process (see myThreadId) to lmMessage.

setLogMessageHostname :: LogMessage -> IO LogMessage

An IO action that sets the current hosts fully qualified hostname in lmHostname.

Log Message Construction

errorMessage :: HasCallStack => Text -> LogMessage

Construct a LogMessage with errorSeverity

infoMessage :: HasCallStack => Text -> LogMessage

Construct a LogMessage with informationalSeverity

debugMessage :: HasCallStack => Text -> LogMessage

Construct a LogMessage with debugSeverity

Type Class for Conversion to LogMessage

class ToLogMessage a where

Things that can become a LogMessage

Methods

toLogMessage :: a -> LogMessage

Convert the value to a LogMessage

Instances

ToLogMessage Text

Defined in Control.Eff.Log.Message

Methods

toLogMessage :: Text -> LogMessage

ToLogMessage LogMessage

Defined in Control.Eff.Log.Message

Methods

toLogMessage :: LogMessage -> LogMessage

IO Based Constructor

errorMessageIO :: (HasCallStack, MonadIO m) => Text -> m LogMessage

Construct a LogMessage with errorSeverity

infoMessageIO :: (HasCallStack, MonadIO m) => Text -> m LogMessage

Construct a LogMessage with informationalSeverity

debugMessageIO :: (HasCallStack, MonadIO m) => Text -> m LogMessage

Construct a LogMessage with debugSeverity

LogMessage Predicates

Log Message Predicates

These are the predefined LogPredicates:

• allLogMessages
• noLogMessages
• lmSeverityIsAtLeast
• lmSeverityIs
• lmMessageStartsWith
• discriminateByAppName

To find out how to use these predicates, goto Control.Eff.Log

type LogPredicate = LogMessage -> Bool

The filter predicate for message that shall be logged.

See Control.Eff.Log

allLogMessages :: LogPredicate

All messages.

See Control.Eff.Log.Message for more predicates.

noLogMessages :: LogPredicate

No messages.

See Control.Eff.Log.Message for more predicates.

lmSeverityIs :: Severity -> LogPredicate

Match LogMessages that have exactly the given severity. See lmSeverityIsAtLeast.

See Control.Eff.Log.Message for more predicates.

lmSeverityIsAtLeast :: Severity -> LogPredicate

Match LogMessages that have the given severity or worse. See lmSeverityIs.

See Control.Eff.Log.Message for more predicates.

lmMessageStartsWith :: Text -> LogPredicate

Match LogMessages whose lmMessage starts with the given string.

See Control.Eff.Log.Message for more predicates.

discriminateByAppName :: Text -> LogPredicate -> LogPredicate -> LogPredicate

Apply a LogPredicate based on the lmAppName and delegate to one of two LogPredicates.

One useful application for this is to allow info and debug message from one application, e.g. the current application itself, while at the same time allowing only warning and error messages from third party libraries.

See Control.Eff.Log.Message for more predicates.

RFC-5424 Structured Data

data StructuredDataElement

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

Constructors

SdElement

Fields

• _sdElementId :: !Text
• _sdElementParameters :: ![SdParameter]

Instances

Eq StructuredDataElement

Defined in Control.Eff.Log.Message

Methods

(==) :: StructuredDataElement -> StructuredDataElement -> Bool

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

Ord StructuredDataElement

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

Defined in Control.Eff.Log.Message

Methods

showsPrec :: Int -> StructuredDataElement -> ShowS

show :: StructuredDataElement -> String

showList :: [StructuredDataElement] -> ShowS

Generic StructuredDataElement

Defined in Control.Eff.Log.Message

Associated Types

type Rep StructuredDataElement :: Type -> Type

Methods

from :: StructuredDataElement -> Rep StructuredDataElement x

to :: Rep StructuredDataElement x -> StructuredDataElement

NFData StructuredDataElement

Defined in Control.Eff.Log.Message

Methods

rnf :: StructuredDataElement -> ()

type Rep StructuredDataElement

Defined in Control.Eff.Log.Message

type Rep StructuredDataElement = D1 (MetaData "StructuredDataElement" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.32.0-GimAdtHOovq4dulPgeQPe9" False) (C1 (MetaCons "SdElement" PrefixI True) (S1 (MetaSel (Just "_sdElementId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sdElementParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [SdParameter])))

data SdParameter

Component of an RFC-5424 StructuredDataElement

Constructors

MkSdParameter !Text !Text

Instances

Eq SdParameter

Defined in Control.Eff.Log.Message

Methods

(==) :: SdParameter -> SdParameter -> Bool

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

Ord SdParameter

Defined in Control.Eff.Log.Message

Methods

compare :: SdParameter -> SdParameter -> Ordering

(<) :: SdParameter -> SdParameter -> Bool

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

(>) :: SdParameter -> SdParameter -> Bool

(>=) :: SdParameter -> SdParameter -> Bool

max :: SdParameter -> SdParameter -> SdParameter

min :: SdParameter -> SdParameter -> SdParameter

Show SdParameter

Defined in Control.Eff.Log.Message

Methods

showsPrec :: Int -> SdParameter -> ShowS

show :: SdParameter -> String

showList :: [SdParameter] -> ShowS

Generic SdParameter

Defined in Control.Eff.Log.Message

Associated Types

type Rep SdParameter :: Type -> Type

Methods

from :: SdParameter -> Rep SdParameter x

to :: Rep SdParameter x -> SdParameter

NFData SdParameter

Defined in Control.Eff.Log.Message

Methods

rnf :: SdParameter -> ()

type Rep SdParameter

Defined in Control.Eff.Log.Message

type Rep SdParameter = D1 (MetaData "SdParameter" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.32.0-GimAdtHOovq4dulPgeQPe9" False) (C1 (MetaCons "MkSdParameter" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

sdElementId :: Functor f => (Text -> f Text) -> StructuredDataElement -> f StructuredDataElement

A lens for the key or ID of a group of RFC 5424 key-value pairs.

sdElementParameters :: Functor f => ([SdParameter] -> f [SdParameter]) -> StructuredDataElement -> f StructuredDataElement

A lens for SdParameters

RFC 5424 Severity

data Severity

An rfc 5424 severity

Instances

Eq Severity

Defined in Control.Eff.Log.Message

Methods

(==) :: Severity -> Severity -> Bool

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

Ord Severity

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

Defined in Control.Eff.Log.Message

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

Generic Severity

Defined in Control.Eff.Log.Message

Associated Types

type Rep Severity :: Type -> Type

Methods

from :: Severity -> Rep Severity x

to :: Rep Severity x -> Severity

Default Severity

Defined in Control.Eff.Log.Message

Methods

def :: Severity

NFData Severity

Defined in Control.Eff.Log.Message

Methods

rnf :: Severity -> ()

type Rep Severity

Defined in Control.Eff.Log.Message

type Rep Severity = D1 (MetaData "Severity" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.32.0-GimAdtHOovq4dulPgeQPe9" True) (C1 (MetaCons "Severity" PrefixI True) (S1 (MetaSel (Just "fromSeverity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

emergencySeverity :: Severity

Smart constructor for the RFC-5424 emergency LogMessage Severity. This corresponds to the severity value 0. See lmSeverity.

alertSeverity :: Severity

Smart constructor for the RFC-5424 alert LogMessage Severity. This corresponds to the severity value 1. See lmSeverity.

criticalSeverity :: Severity

Smart constructor for the RFC-5424 critical LogMessage Severity. This corresponds to the severity value 2. See lmSeverity.

errorSeverity :: Severity

Smart constructor for the RFC-5424 error LogMessage Severity. This corresponds to the severity value 3. See lmSeverity.

warningSeverity :: Severity

Smart constructor for the RFC-5424 warning LogMessage Severity. This corresponds to the severity value 4. See lmSeverity.

noticeSeverity :: Severity

Smart constructor for the RFC-5424 notice LogMessage Severity. This corresponds to the severity value 5. See lmSeverity.

informationalSeverity :: Severity

Smart constructor for the RFC-5424 informational LogMessage Severity. This corresponds to the severity value 6. See lmSeverity.

debugSeverity :: Severity

Smart constructor for the RFC-5424 debug LogMessage Severity. This corresponds to the severity value 7. See lmSeverity.

RFC 5424 Facility

newtype Facility

An rfc 5424 facility

Constructors

Facility

Fields

• fromFacility :: Int

Instances

Eq Facility

Defined in Control.Eff.Log.Message

Methods

(==) :: Facility -> Facility -> Bool

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

Ord Facility

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

Defined in Control.Eff.Log.Message

Methods

showsPrec :: Int -> Facility -> ShowS

show :: Facility -> String

showList :: [Facility] -> ShowS

Generic Facility

Defined in Control.Eff.Log.Message

Associated Types

type Rep Facility :: Type -> Type

Methods

from :: Facility -> Rep Facility x

to :: Rep Facility x -> Facility

Default Facility

Defined in Control.Eff.Log.Message

Methods

def :: Facility

NFData Facility

Defined in Control.Eff.Log.Message

Methods

rnf :: Facility -> ()

type Rep Facility

Defined in Control.Eff.Log.Message

type Rep Facility = D1 (MetaData "Facility" "Control.Eff.Log.Message" "extensible-effects-concurrent-0.32.0-GimAdtHOovq4dulPgeQPe9" True) (C1 (MetaCons "Facility" PrefixI True) (S1 (MetaSel (Just "fromFacility") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Facility Constructors

kernelMessages :: Facility

Smart constructor for the RFC-5424 LogMessage facility kernelMessages. See lmFacility.

userLevelMessages :: Facility

Smart constructor for the RFC-5424 LogMessage facility userLevelMessages. See lmFacility.

mailSystem :: Facility

Smart constructor for the RFC-5424 LogMessage facility mailSystem. See lmFacility.

systemDaemons :: Facility

Smart constructor for the RFC-5424 LogMessage facility systemDaemons. See lmFacility.

securityAuthorizationMessages4 :: Facility

Smart constructor for the RFC-5424 LogMessage facility securityAuthorizationMessages4. See lmFacility.

linePrinterSubsystem :: Facility

Smart constructor for the RFC-5424 LogMessage facility linePrinterSubsystem. See lmFacility.

networkNewsSubsystem :: Facility

Smart constructor for the RFC-5424 LogMessage facility networkNewsSubsystem. See lmFacility.

uucpSubsystem :: Facility

Smart constructor for the RFC-5424 LogMessage facility uucpSubsystem. See lmFacility.

clockDaemon :: Facility

Smart constructor for the RFC-5424 LogMessage facility clockDaemon. See lmFacility.

securityAuthorizationMessages10 :: Facility

Smart constructor for the RFC-5424 LogMessage facility securityAuthorizationMessages10. See lmFacility.

ftpDaemon :: Facility

Smart constructor for the RFC-5424 LogMessage facility ftpDaemon. See lmFacility.

ntpSubsystem :: Facility

Smart constructor for the RFC-5424 LogMessage facility ntpSubsystem. See lmFacility.

logAuditFacility :: Facility

Smart constructor for the RFC-5424 LogMessage facility logAuditFacility. See lmFacility.

logAlertFacility :: Facility

Smart constructor for the RFC-5424 LogMessage facility logAlertFacility. See lmFacility.

clockDaemon2 :: Facility

Smart constructor for the RFC-5424 LogMessage facility clockDaemon2. See lmFacility.

local0 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local0. See lmFacility.

local1 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local1. See lmFacility.

local2 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local2. See lmFacility.

local3 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local3. See lmFacility.

local4 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local4. See lmFacility.

local5 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local5. See lmFacility.

local6 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local6. See lmFacility.

local7 :: Facility

Smart constructor for the RFC-5424 LogMessage facility local7. See lmFacility.