Maintainer	omeragacan@gmail.com
Stability	provisional
Portability	Posix
Safe Haskell	None
Language	Haskell2010

System.Posix.Syslog.TCP

Contents

Haskell API to syslog via TCP
Utilities for constructing SyslogConfig
Protocols for use with SyslogConfig
Syslog TCP packet component datatypes

Description

Log messages to syslog over a network via TCP, with protocols such as RFC 5424 or RFC 3164.

Most of the code adapted from hsyslog-udp.

Synopsis

Haskell API to syslog via TCP

initSyslog :: SyslogConfig -> IO SyslogConn Source #

Connect to the remote syslog server over TCP.

See also documentation for SyslogConn.

type SyslogFn Source #

Arguments

= Facility	facility to log to
-> Severity	severity under which to log
-> Text	message body (should not contain newline)
-> IO ()

data SyslogConn Source #

Constructors

SyslogConn
Fields _syslogConnSend :: SyslogFn Callback for sending logs to the connected remote syslog server. This function re-throws exceptions, blocks when the TCP socket is not ready for writing. _syslogConnClose :: IO () Callback for closing the connection.

data SyslogConfig Source #

Configuration options for connecting and logging to your syslog socket.

Constructors

SyslogConfig

Fields

_appName :: !AppName
see APP-NAME; fetch via getAppName
_hostName :: !HostName
see HOSTNAME; fetch via getHostName
_processId :: !ProcessID
see PROCID; fetch via getProcessId
_severityMask :: !SeverityMask
whitelist of priorities of logs to send
_address :: !AddrInfo
where to send the syslog packets; find via getAddrInfo
_protocol :: !Protocol
protocol for formatting the message, such as rfc5424TCPProtocol or rfc3164TCPProtocol

defaultConfig :: HostName -> ServiceName -> IO (Maybe SyslogConfig) Source #

A helper for constructing a SyslogConfig. Uses rsyslogTCPProtocol. Returns Nothing when getAddrInfo fails.

Utilities for constructing `SyslogConfig`

getAppName :: IO AppName #

getHostName :: IO HostName #

getProcessId :: IO ProcessID #

Protocols for use with `SyslogConfig`

data Protocol Source #

rfc5424TCPProtocol :: Protocol Source #

rfc3164TCPProtocol :: Protocol Source #

rsyslogTCPProtocol :: Protocol Source #

Syslog TCP packet component datatypes

Re-exports from hsyslog

data Priority :: * #

Log messages have a priority attached.

Constructors

Emergency	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

Bounded Priority
Methods minBound :: Priority # maxBound :: Priority #
Enum 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
Methods (==) :: Priority -> Priority -> Bool # (/=) :: Priority -> Priority -> Bool #
Read Priority
Methods readsPrec :: Int -> ReadS Priority # readList :: ReadS [Priority] # readPrec :: ReadPrec Priority # readListPrec :: ReadPrec [Priority] #
Show Priority
Methods showsPrec :: Int -> Priority -> ShowS # show :: Priority -> String # showList :: [Priority] -> ShowS #
Generic Priority
Associated Types type Rep Priority :: * -> * # Methods from :: Priority -> Rep Priority x # to :: Rep Priority x -> Priority #
type Rep Priority
type Rep Priority = D1 (MetaData "Priority" "System.Posix.Syslog" "hsyslog-4-CMAlwHXQD1qFjIKM83acRk" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Emergency" PrefixI False) U1) (C1 (MetaCons "Alert" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Critical" PrefixI False) U1) (C1 (MetaCons "Error" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "Warning" PrefixI False) U1) (C1 (MetaCons "Notice" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Info" PrefixI False) U1) (C1 (MetaCons "Debug" PrefixI False) U1))))

data Facility :: * #

Syslog distinguishes various system facilities. Most applications should log in USER.

Constructors

KERN	kernel messages
USER	user-level messages (default unless set otherwise)
MAIL	mail system
DAEMON	system daemons
AUTH	security/authorization messages
SYSLOG	messages generated internally by syslogd
LPR	line printer subsystem
NEWS	network news subsystem
UUCP	UUCP subsystem
CRON	clock daemon
AUTHPRIV	security/authorization messages (effectively equals `AUTH` on some systems)
FTP	ftp daemon (effectively equals `DAEMON` on some systems)
LOCAL0	reserved for local use
LOCAL1	reserved for local use
LOCAL2	reserved for local use
LOCAL3	reserved for local use
LOCAL4	reserved for local use
LOCAL5	reserved for local use
LOCAL6	reserved for local use
LOCAL7	reserved for local use

Instances

Bounded Facility
Methods minBound :: Facility # maxBound :: Facility #
Enum Facility
Methods succ :: Facility -> Facility # pred :: Facility -> Facility # toEnum :: Int -> Facility # fromEnum :: Facility -> Int # enumFrom :: Facility -> [Facility] # enumFromThen :: Facility -> Facility -> [Facility] # enumFromTo :: Facility -> Facility -> [Facility] # enumFromThenTo :: Facility -> Facility -> Facility -> [Facility] #
Eq Facility
Methods (==) :: Facility -> Facility -> Bool # (/=) :: Facility -> Facility -> Bool #
Read Facility
Methods readsPrec :: Int -> ReadS Facility # readList :: ReadS [Facility] # readPrec :: ReadPrec Facility # readListPrec :: ReadPrec [Facility] #
Show Facility
Methods showsPrec :: Int -> Facility -> ShowS # show :: Facility -> String # showList :: [Facility] -> ShowS #
Generic Facility
Associated Types type Rep Facility :: * -> * # Methods from :: Facility -> Rep Facility x # to :: Rep Facility x -> Facility #
type Rep Facility
type Rep Facility = D1 (MetaData "Facility" "System.Posix.Syslog" "hsyslog-4-CMAlwHXQD1qFjIKM83acRk" False) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "KERN" PrefixI False) U1) (C1 (MetaCons "USER" PrefixI False) U1)) ((:+:) (C1 (MetaCons "MAIL" PrefixI False) U1) ((:+:) (C1 (MetaCons "DAEMON" PrefixI False) U1) (C1 (MetaCons "AUTH" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "SYSLOG" PrefixI False) U1) (C1 (MetaCons "LPR" PrefixI False) U1)) ((:+:) (C1 (MetaCons "NEWS" PrefixI False) U1) ((:+:) (C1 (MetaCons "UUCP" PrefixI False) U1) (C1 (MetaCons "CRON" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "AUTHPRIV" PrefixI False) U1) (C1 (MetaCons "FTP" PrefixI False) U1)) ((:+:) (C1 (MetaCons "LOCAL0" PrefixI False) U1) ((:+:) (C1 (MetaCons "LOCAL1" PrefixI False) U1) (C1 (MetaCons "LOCAL2" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "LOCAL3" PrefixI False) U1) (C1 (MetaCons "LOCAL4" PrefixI False) U1)) ((:+:) (C1 (MetaCons "LOCAL5" PrefixI False) U1) ((:+:) (C1 (MetaCons "LOCAL6" PrefixI False) U1) (C1 (MetaCons "LOCAL7" PrefixI False) U1))))))

data PriorityMask :: * #

withSyslog options for the priority mask.

Constructors

NoMask	allow all messages thru
Mask [Priority]	allow only messages with the priorities listed
UpTo Priority	allow only messages down to and including the specified priority

Instances

Eq PriorityMask
Methods (==) :: PriorityMask -> PriorityMask -> Bool # (/=) :: PriorityMask -> PriorityMask -> Bool #
Read PriorityMask
Methods readsPrec :: Int -> ReadS PriorityMask # readList :: ReadS [PriorityMask] # readPrec :: ReadPrec PriorityMask # readListPrec :: ReadPrec [PriorityMask] #
Show PriorityMask
Methods showsPrec :: Int -> PriorityMask -> ShowS # show :: PriorityMask -> String # showList :: [PriorityMask] -> ShowS #
Generic PriorityMask
Associated Types type Rep PriorityMask :: * -> * # Methods from :: PriorityMask -> Rep PriorityMask x # to :: Rep PriorityMask x -> PriorityMask #
type Rep PriorityMask
type Rep PriorityMask = D1 (MetaData "PriorityMask" "System.Posix.Syslog" "hsyslog-4-CMAlwHXQD1qFjIKM83acRk" False) ((:+:) (C1 (MetaCons "NoMask" PrefixI False) U1) ((:+:) (C1 (MetaCons "Mask" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Priority]))) (C1 (MetaCons "UpTo" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Priority)))))

Newtypes for various String/Int values

Refer to RFC 5424 section 6.2 as to the purpose of each.

newtype AppName :: * #

Constructors

AppName ByteString

see APP-NAME

Instances

Eq AppName
Methods (==) :: AppName -> AppName -> Bool # (/=) :: AppName -> AppName -> Bool #
Show AppName
Methods showsPrec :: Int -> AppName -> ShowS # show :: AppName -> String # showList :: [AppName] -> ShowS #

newtype HostName :: * #

Constructors

HostName ByteString

see HOSTNAME; fetch via getHostName

Instances

Eq HostName
Methods (==) :: HostName -> HostName -> Bool # (/=) :: HostName -> HostName -> Bool #
Show HostName
Methods showsPrec :: Int -> HostName -> ShowS # show :: HostName -> String # showList :: [HostName] -> ShowS #

newtype ProcessID :: * #

Constructors

ProcessID ByteString

see PROCID; fetch via getProcessId

Instances

Eq ProcessID
Methods (==) :: ProcessID -> ProcessID -> Bool # (/=) :: ProcessID -> ProcessID -> Bool #
Show ProcessID
Methods showsPrec :: Int -> ProcessID -> ShowS # show :: ProcessID -> String # showList :: [ProcessID] -> ShowS #

newtype MessageID :: * #

Constructors

MessageID ByteString

see MSGID

Instances

Eq MessageID
Methods (==) :: MessageID -> MessageID -> Bool # (/=) :: MessageID -> MessageID -> Bool #
Show MessageID
Methods showsPrec :: Int -> MessageID -> ShowS # show :: MessageID -> String # showList :: [MessageID] -> ShowS #

Type aliases

What syslog refers to as Priority, RFC 5424 calls Severity.

type Severity = Priority #

type SeverityMask = PriorityMask #

Haskell API to syslog via TCP

Utilities for constructing SyslogConfig

Protocols for use with SyslogConfig

Syslog TCP packet component datatypes

Re-exports from hsyslog

Newtypes for various String/Int values

Type aliases

Utilities for constructing `SyslogConfig`

Protocols for use with `SyslogConfig`