Safe Haskell	None
Language	Haskell2010

Systemd.Journal

Contents

Writing to the journal
- Standard systemd journal fields
- Custom journal fields
Reading the journal

Synopsis

sendMessage :: Text -> IO ()
sendMessageWith :: Text -> JournalFields -> IO ()
sendJournalFields :: JournalFields -> IO ()
type JournalFields = HashMap JournalField ByteString
message :: Text -> JournalFields
messageId :: UUID -> JournalFields
priority :: Priority -> JournalFields
data Priority
- = Emergency
- | Alert
- | Critical
- | Error
- | Warning
- | Notice
- | Info
- | Debug
codeFile :: FilePath -> JournalFields
codeLine :: Int -> JournalFields
codeFunc :: Text -> JournalFields
errno :: Int -> JournalFields
syslogFacility :: Facility -> JournalFields
syslogIdentifier :: Text -> JournalFields
syslogPid :: CPid -> JournalFields
data JournalField
mkJournalField :: Text -> JournalField
journalField :: JournalField -> Text
openJournal :: MonadSafe m => [JournalFlag] -> Start -> Maybe Filter -> Maybe Integer -> Producer' JournalEntry m ()
data Start
- = FromStart
- | FromEnd Direction
- | FromCursor JournalEntryCursor Direction
data Direction
- = Forwards
- | Backwards
data JournalEntry
type JournalEntryCursor = ByteString
journalEntryFields :: JournalEntry -> JournalFields
journalEntryCursor :: JournalEntry -> JournalEntryCursor
journalEntryRealtime :: JournalEntry -> Word64
data JournalFlag
- = LocalOnly
- | RuntimeOnly
- | SystemOnly
data Filter
- = Match JournalField ByteString
- | And Filter Filter
- | Or Filter Filter

Writing to the journal

sendMessage :: Text -> IO () Source #

Send a message to the systemd journal.

sendMessage t == sendJournalFields (message t)

sendMessageWith :: Text -> JournalFields -> IO () Source #

Send a message and supply extra fields.

Note: The MESSAGE field will be replaced with the first parameter to this function. If you don't want this, use sendJournalFields

sendJournalFields :: JournalFields -> IO () Source #

Send an exact set of fields to the systemd journal.

type JournalFields = HashMap JournalField ByteString Source #

A structured object of all the fields in an entry in the journal. You generally don't construct this yourself, but you use the monoid instance and smart constructors below.

For example,

sendJournalFields (message "Oh god, it burns!" <> priority Emergency)

Standard systemd journal fields

message :: Text -> JournalFields Source #

The human readable message string for this entry. This is supposed to be the primary text shown to the user. It is usually not translated (but might be in some cases), and is not supposed to be parsed for meta data.

messageId :: UUID -> JournalFields Source #

A 128bit message identifier ID for recognizing certain message types, if this is desirable. Developers can generate a new ID for this purpose with journalctl --new-id.

priority :: Priority -> JournalFields Source #

A priority value compatible with syslog's priority concept.

data Priority Source #

Log messages are prioritized with one of the following levels:

>>> [minBound..maxBound] :: [Priority]
[Emergency,Alert,Critical,Error,Warning,Notice,Info,Debug]

The Ord instance for Priority considers the more urgent level lower than less urgent ones:

>>> Emergency < Debug
True
>>> minimum [minBound..maxBound] :: Priority
Emergency
>>> maximum [minBound..maxBound] :: Priority
Debug

Constructors

Emergency	the system is unusable
Alert	action must be taken immediately
Critical	critical conditions
Error	error conditions
Warning	warning conditions
Notice	normal but significant condition
Info	informational
Debug	debug-level messages

Instances

Instances details

Bounded Priority
Instance details Defined in System.Posix.Syslog.Priority Methods minBound :: Priority # maxBound :: Priority #
Enum Priority
Instance details Defined in System.Posix.Syslog.Priority Methods succ :: Priority -> Priority # pred :: Priority -> Priority # toEnum :: Int -> Priority # fromEnum :: Priority -> Int # enumFrom :: Priority -> [Priority] # enumFromThen :: Priority -> Priority -> [Priority] # enumFromTo :: Priority -> Priority -> [Priority] # enumFromThenTo :: Priority -> Priority -> Priority -> [Priority] #
Eq Priority
Instance details Defined in System.Posix.Syslog.Priority Methods (==) :: Priority -> Priority -> Bool # (/=) :: Priority -> Priority -> Bool #
Ord Priority
Instance details Defined in System.Posix.Syslog.Priority Methods compare :: Priority -> Priority -> Ordering # (<) :: Priority -> Priority -> Bool # (<=) :: Priority -> Priority -> Bool # (>) :: Priority -> Priority -> Bool # (>=) :: Priority -> Priority -> Bool # max :: Priority -> Priority -> Priority # min :: Priority -> Priority -> Priority #
Read Priority
Instance details Defined in System.Posix.Syslog.Priority Methods readsPrec :: Int -> ReadS Priority # readList :: ReadS [Priority] # readPrec :: ReadPrec Priority # readListPrec :: ReadPrec [Priority] #
Show Priority
Instance details Defined in System.Posix.Syslog.Priority Methods showsPrec :: Int -> Priority -> ShowS # show :: Priority -> String # showList :: [Priority] -> ShowS #
Generic Priority
Instance details Defined in System.Posix.Syslog.Priority Associated Types type Rep Priority :: Type -> Type # Methods from :: Priority -> Rep Priority x # to :: Rep Priority x -> Priority #
type Rep Priority
Instance details Defined in System.Posix.Syslog.Priority type Rep Priority = D1 ('MetaData "Priority" "System.Posix.Syslog.Priority" "hsyslog-5.0.2-Kh2FdjZv05J9bQ41ZXzIYi" 'False) (((C1 ('MetaCons "Emergency" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Alert" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Critical" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Warning" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Notice" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type))))

codeFile :: FilePath -> JournalFields Source #

The source code file generating this message.

codeLine :: Int -> JournalFields Source #

The source code line number generating this message.

codeFunc :: Text -> JournalFields Source #

The source code function name generating this message.

errno :: Int -> JournalFields Source #

The low-level Unix error number causing this entry, if any. Contains the numeric value of errno(3).

syslogFacility :: Facility -> JournalFields Source #

Syslog compatibility field.

syslogIdentifier :: Text -> JournalFields Source #

Syslog compatibility field.

syslogPid :: CPid -> JournalFields Source #

Syslog compatibility field.

Custom journal fields

data JournalField Source #

Instances

Instances details

Eq JournalField Source #
Instance details Defined in Systemd.Journal Methods (==) :: JournalField -> JournalField -> Bool # (/=) :: JournalField -> JournalField -> Bool #
Data JournalField Source #
Instance details Defined in Systemd.Journal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JournalField -> c JournalField # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JournalField # toConstr :: JournalField -> Constr # dataTypeOf :: JournalField -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JournalField) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JournalField) # gmapT :: (forall b. Data b => b -> b) -> JournalField -> JournalField # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JournalField -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JournalField -> r # gmapQ :: (forall d. Data d => d -> u) -> JournalField -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JournalField -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JournalField -> m JournalField # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JournalField -> m JournalField # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JournalField -> m JournalField #
Ord JournalField Source #
Instance details Defined in Systemd.Journal Methods compare :: JournalField -> JournalField -> Ordering # (<) :: JournalField -> JournalField -> Bool # (<=) :: JournalField -> JournalField -> Bool # (>) :: JournalField -> JournalField -> Bool # (>=) :: JournalField -> JournalField -> Bool # max :: JournalField -> JournalField -> JournalField # min :: JournalField -> JournalField -> JournalField #
Read JournalField Source #
Instance details Defined in Systemd.Journal Methods readsPrec :: Int -> ReadS JournalField # readList :: ReadS [JournalField] # readPrec :: ReadPrec JournalField # readListPrec :: ReadPrec [JournalField] #
Show JournalField Source #
Instance details Defined in Systemd.Journal Methods showsPrec :: Int -> JournalField -> ShowS # show :: JournalField -> String # showList :: [JournalField] -> ShowS #
IsString JournalField Source #
Instance details Defined in Systemd.Journal Methods fromString :: String -> JournalField #
Semigroup JournalField Source #
Instance details Defined in Systemd.Journal Methods (<>) :: JournalField -> JournalField -> JournalField # sconcat :: NonEmpty JournalField -> JournalField # stimes :: Integral b => b -> JournalField -> JournalField #
Monoid JournalField Source #
Instance details Defined in Systemd.Journal Methods mempty :: JournalField # mappend :: JournalField -> JournalField -> JournalField # mconcat :: [JournalField] -> JournalField #
Hashable JournalField Source #
Instance details Defined in Systemd.Journal Methods hashWithSalt :: Int -> JournalField -> Int Source # hash :: JournalField -> Int Source #

mkJournalField :: Text -> JournalField Source #

Construct a JournalField by converting to uppercase, as required by the journal.

journalField :: JournalField -> Text Source #

Extract the name of a JournalField.

Reading the journal

openJournal Source #

Arguments

:: MonadSafe m
=> [JournalFlag]	A list of flags taken under logical disjunction (or) to specify which journal files to open.
-> Start	Where to begin reading journal entries from.
-> Maybe Filter	An optional filter to apply the journal. Only entries satisfying the filter will be emitted.
-> Maybe Integer	The data field size threshold, or Nothing for no field size limit
-> Producer' JournalEntry m ()

Opens the journal for reading, optionally filtering the journal entries. Filters are defined as arbitrary binary expression trees, which are then rewritten to be in conjunctive normal form before filtering with systemd to comply with systemd's rule system.

data Start Source #

Where to begin reading the journal from.

Constructors

FromStart	Begin reading from the start of the journal.
FromEnd Direction	Begin reading from the end of the journal.
FromCursor JournalEntryCursor Direction	From a `JournalEntryCursor`.

data Direction Source #

In which direction to read the journal.

Constructors

Forwards	Read towards the end.
Backwards	Read towards the beginning.

Instances

Instances details

Eq Direction Source #
Instance details Defined in Systemd.Journal Methods (==) :: Direction -> Direction -> Bool # (/=) :: Direction -> Direction -> Bool #

data JournalEntry Source #

An entry that has been read from the systemd journal.

Instances

Instances details

Eq JournalEntry Source #
Instance details Defined in Systemd.Journal Methods (==) :: JournalEntry -> JournalEntry -> Bool # (/=) :: JournalEntry -> JournalEntry -> Bool #
Show JournalEntry Source #
Instance details Defined in Systemd.Journal Methods showsPrec :: Int -> JournalEntry -> ShowS # show :: JournalEntry -> String # showList :: [JournalEntry] -> ShowS #

type JournalEntryCursor = ByteString Source #

journalEntryFields :: JournalEntry -> JournalFields Source #

A map of each JournalField to its value.

journalEntryCursor :: JournalEntry -> JournalEntryCursor Source #

A JournalCursor can be used as marker into the journal stream. This can be used to re-open the journal at a specific point in the future, and JournalCursors can be serialized to disk.

journalEntryRealtime :: JournalEntry -> Word64 Source #

The time (in microseconds since the epoch) when this journal entry was received by the systemd journal.

data JournalFlag Source #

Flags to specify which journal entries to read.

Constructors

LocalOnly	Only journal files generated on the local machine will be opened.
RuntimeOnly	Only volatile journal files will be opened, excluding those which are stored on persistent storage.
SystemOnly	Only journal files of system services and the kernel (in opposition to user session processes) will be opened.

Instances

Instances details

Bounded JournalFlag Source #
Instance details Defined in Systemd.Journal Methods minBound :: JournalFlag # maxBound :: JournalFlag #
Enum JournalFlag Source #
Instance details Defined in Systemd.Journal Methods succ :: JournalFlag -> JournalFlag # pred :: JournalFlag -> JournalFlag # toEnum :: Int -> JournalFlag # fromEnum :: JournalFlag -> Int # enumFrom :: JournalFlag -> [JournalFlag] # enumFromThen :: JournalFlag -> JournalFlag -> [JournalFlag] # enumFromTo :: JournalFlag -> JournalFlag -> [JournalFlag] # enumFromThenTo :: JournalFlag -> JournalFlag -> JournalFlag -> [JournalFlag] #
Eq JournalFlag Source #
Instance details Defined in Systemd.Journal Methods (==) :: JournalFlag -> JournalFlag -> Bool # (/=) :: JournalFlag -> JournalFlag -> Bool #
Ord JournalFlag Source #
Instance details Defined in Systemd.Journal Methods compare :: JournalFlag -> JournalFlag -> Ordering # (<) :: JournalFlag -> JournalFlag -> Bool # (<=) :: JournalFlag -> JournalFlag -> Bool # (>) :: JournalFlag -> JournalFlag -> Bool # (>=) :: JournalFlag -> JournalFlag -> Bool # max :: JournalFlag -> JournalFlag -> JournalFlag # min :: JournalFlag -> JournalFlag -> JournalFlag #

data Filter Source #

A logical expression to filter journal entries when reading the journal.

Constructors

Match JournalField ByteString	A binary exact match on a given `JournalField`.
And Filter Filter	Logical conjunction of two filters. Will only show journal entries that satisfy both conditions.
Or Filter Filter	Logical disjunction of two filters. Will show journal entries that satisfy either condition.

Instances

Instances details

Eq Filter Source #
Instance details Defined in Systemd.Journal Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Data Filter Source #
Instance details Defined in Systemd.Journal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Filter -> c Filter # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Filter # toConstr :: Filter -> Constr # dataTypeOf :: Filter -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Filter) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Filter) # gmapT :: (forall b. Data b => b -> b) -> Filter -> Filter # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQ :: (forall d. Data d => d -> u) -> Filter -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Filter -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter #
Show Filter Source #
Instance details Defined in Systemd.Journal Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #