Safe Haskell	Safe-Inferred
Language	Haskell2010

Systemd.Journalctl.Stream

Contents

Journal entry
Streaming
Exceptions

Description

Streaming interface to journalctl. Use entryStream to stream journalctl entries as they are created.

Designed with qualified import in mind. For example, if you import it as Journal, then Entry becomes Journal.Entry, and Exception becomes Journal.Exception.

Synopsis

data Entry = Entry {
- entryPID :: Maybe ProcessID
- entryHostname :: Text
- entryNamespace :: Maybe Text
- entryProcess :: Maybe Text
- entryExecutable :: Maybe FilePath
- entryCursor :: Cursor
- entryTimestamp :: POSIXTime
- entryUnit :: Maybe Text
- entryMessage :: Maybe (Either ByteString Text)
}
data Cursor
data StreamStart
- = StartTime LocalTime
- | Lines Int
- | AtCursor Cursor
- | AfterCursor Cursor
entryStream :: (MonadResource m, MonadThrow m) => StreamStart -> ConduitT i Entry m ()
data Exception

Journal entry

data Entry Source #

A journal entry.

Constructors

Entry

Fields

entryPID :: Maybe ProcessID
Process ID.
entryHostname :: Text
The name of the originating host.
entryNamespace :: Maybe Text
Namespace identifier.
entryProcess :: Maybe Text
Process name.
entryExecutable :: Maybe FilePath
File path to the executable.
entryCursor :: Cursor
The cursor for the entry.
entryTimestamp :: POSIXTime
The time the entry was received by the journal.
entryUnit :: Maybe Text
Unit name, if present.
entryMessage :: Maybe (Either ByteString Text)
Entry message. It may come in binary or textual format.

Instances

Instances details

FromJSON Entry Source #
Instance details Defined in Systemd.Journalctl.Stream Methods parseJSON :: Value -> Parser Entry # parseJSONList :: Value -> Parser [Entry] #
Show Entry Source #
Instance details Defined in Systemd.Journalctl.Stream Methods showsPrec :: Int -> Entry -> ShowS # show :: Entry -> String # showList :: [Entry] -> ShowS #

data Cursor Source #

A cursor is an opaque text string that uniquely describes the position of an entry in the journal and is portable across machines, platforms and journal files.

The Ord instance does not order by time. Given two entries e1 and e2, e1 having an earlier timestamp than e2 doesn't mean that entryCursor e1 < entryCursor e2.

Instances

Instances details

FromJSON Cursor Source #
Instance details Defined in Systemd.Journalctl.Stream Methods parseJSON :: Value -> Parser Cursor # parseJSONList :: Value -> Parser [Cursor] #
ToJSON Cursor Source #
Instance details Defined in Systemd.Journalctl.Stream Methods toJSON :: Cursor -> Value # toEncoding :: Cursor -> Encoding # toJSONList :: [Cursor] -> Value # toEncodingList :: [Cursor] -> Encoding #
Show Cursor Source #
Instance details Defined in Systemd.Journalctl.Stream Methods showsPrec :: Int -> Cursor -> ShowS # show :: Cursor -> String # showList :: [Cursor] -> ShowS #
Eq Cursor Source #
Instance details Defined in Systemd.Journalctl.Stream Methods (==) :: Cursor -> Cursor -> Bool # (/=) :: Cursor -> Cursor -> Bool #
Ord Cursor Source #
Instance details Defined in Systemd.Journalctl.Stream Methods compare :: Cursor -> Cursor -> Ordering # (<) :: Cursor -> Cursor -> Bool # (<=) :: Cursor -> Cursor -> Bool # (>) :: Cursor -> Cursor -> Bool # (>=) :: Cursor -> Cursor -> Bool # max :: Cursor -> Cursor -> Cursor # min :: Cursor -> Cursor -> Cursor #

Streaming

data StreamStart Source #

Where to start a stream.

Constructors

StartTime LocalTime	Start from the given time.
Lines Int	Start from the given number of lines back.
AtCursor Cursor	Start at the given cursor.
AfterCursor Cursor	Start after the given cursor.

entryStream Source #

Arguments

:: (MonadResource m, MonadThrow m)
=> StreamStart	Where to start streaming entries.
-> ConduitT i Entry m ()	Stream of journal entries.

Stream all journal entries starting from the given point.

Exceptions

data Exception Source #

Exception raised while streaming entries from journalctl.

Instances

Instances details

Exception Exception Source #
Instance details Defined in Systemd.Journalctl.Stream Methods toException :: Exception -> SomeException # fromException :: SomeException -> Maybe Exception # displayException :: Exception -> String #
Show Exception Source #
Instance details Defined in Systemd.Journalctl.Stream Methods showsPrec :: Int -> Exception -> ShowS # show :: Exception -> String # showList :: [Exception] -> ShowS #