 | hslogger-1.0.5: Versatile logging framework | Source code | Contents | Index |
| System.Log.Handler.Syslog |
|
| Contents |
Syslog handler for the Haskell Logging Framework
Written by John Goerzen, jgoerzen@complete.org
This module implements an interface to the Syslog service commonly found in Unix/Linux systems. This interface is primarily of interest to developers of servers, as Syslog does not typically display messages in an interactive fashion.
This module is written in pure Haskell and is capable of logging to a local or remote machine using the Syslog protocol.
You can create a new Syslog LogHandler by calling openlog.
More information on the Haskell Logging Framework can be found at System.Log.Logger. This module can also be used outside of the rest of that framework for those interested in that.
| openlog :: String -> [Option] -> Facility -> Priority -> IO SyslogHandler | |||||||||||||||||||||
| openlog_local :: String -> String -> [Option] -> Facility -> Priority -> IO SyslogHandler | |||||||||||||||||||||
| openlog_remote :: Family -> HostName -> PortNumber -> String -> [Option] -> Facility -> Priority -> IO SyslogHandler | |||||||||||||||||||||
| openlog_generic :: Socket -> SockAddr -> String -> [Option] -> Facility -> Priority -> IO SyslogHandler | |||||||||||||||||||||
| |||||||||||||||||||||
|
| openlog | Source |
| :: String | The name of this program -- will be prepended to every log message |
| -> [Option] | A list of Options. The list [] is perfectly valid. [PID] is probably most common here. |
| -> Facility | The Facility value to pass to the syslog system for every message logged |
| -> Priority | Messages logged below this priority will be ignored. To include every message, set this to DEBUG. |
| -> IO SyslogHandler | Returns the new handler |
Initialize the Syslog system using the local system's default interface, /dev/log. Will return a new LogHandler. On Windows, instead of using /dev/log, this will attempt to send UDP messages to something listening on the syslog port (514) on localhost. Use openlog_remote if you need more control. | |
| openlog_local | Source |
| :: String | Path to FIFO |
| -> String | Program name |
| -> [Option] | Options |
| -> Facility | Facility value |
| -> Priority | Priority limit |
| -> IO SyslogHandler | |
Initialize the Syslog system using an arbitrary Unix socket (FIFO). Not supported under Windows. | |
| openlog_remote | Source |
| :: Family | Usually AF_INET or AF_INET6; see Network.Socket |
| -> HostName | Remote hostname. Some use localhost |
| -> PortNumber | 514 is the default for syslog |
| -> String | Program name |
| -> [Option] | Options |
| -> Facility | Facility value |
| -> Priority | Priority limit |
| -> IO SyslogHandler | |
| Log to a remote server via UDP. | |
| openlog_generic | Source |
| :: Socket | A datagram socket |
| -> SockAddr | Address for transmissions |
| -> String | Program name |
| -> [Option] | Options |
| -> Facility | Facility value |
| -> Priority | Priority limit |
| -> IO SyslogHandler | |
| The most powerful initialization mechanism. Takes an open datagram socket. | |
| data Facility | Source |
| data Option | Source |
| Options for openlog. | ||||
| Constructors | ||||
| ||||
 Instances | ||||