syslog-message 0.0.1 · OCaml Package

Module for parsing RFC 3164 Syslog messages

type facility =

| Kernel_Message
| User_Level_Messages
| Mail_System
| System_Daemons
| Security_Authorization_Messages
| Messages_Generated_Internally_By_Syslogd
| Line_Printer_Subsystem
| Network_News_Subsystem
| UUCP_subsystem
| Clock_Daemon
| Security_Authorization_Messages_10
| Ftp_Daemon
| Ntp_Subsystem
| Log_Audit
| Log_Alert
| Clock_Daemon_15
| Local0
| Local1
| Local2
| Local3
| Local4
| Local5
| Local6
| Local7
| Invalid_Facility

The type for Facilities

val int_of_facility : facility -> int

Convert a facility into an integer

val facility_of_int : int -> facility

Converts an integer into a facility

val string_of_facility : facility -> string

Converts a facility into a string

type severity =

| Emergency
| Alert
| Critical
| Error
| Warning
| Notice
| Informational
| Debug
| Invalid_Severity

The type for Severity levels

val int_of_severity : severity -> int

Converts a severity into an integer

val severity_of_int : int -> severity

Converts an integer into a severity

val string_of_severity : severity -> string

Converts a severity into a string

val string_of_timestamp : Ptime.t -> string

string_of_timestamp Converts a timestamp into a string

type ctx = {

timestamp : Ptime.t;
hostname : string;
set_hostname : bool;

}

ctx provides additional information to the parse function in case one of the sub-parsers fails.

timestamp: A timestamp
hostname: Hostname, IPv4 or IPv6 address of the sender. "-" if unknown.
set_hostname: If true, the parse function will skip its hostname sub-parser and use the hostname from ctx instead.

set_hostname is automatically set by the timestamp sub-parser when it fails, because at this point it is no longer possible to determine the hostname from the input string.

val ctx_hostname : ctx -> string -> ctx

ctx_hostname sets a new hostname in ctx

val ctx_set_hostname : ctx -> ctx

ctx_set_hostname

type t = {

facility : facility;
severity : severity;
timestamp : Ptime.t;
hostname : string;
message : string;

}

The type for Syslog messages

val pp_string : t -> string

pp_string returns a pretty-printed string of t

val pp : t -> unit

pp pretty-prints a t using print_string

val parse : ctx:ctx -> string -> t option

parses a string containing a Syslog message and returns an option t

val to_string : ?len:int -> t -> string

to_string returns a Syslog message of type t as string. The output string is truncated to 1024 bytes, which is the default of len. Setting len to 0, leaves the output string unmodified.

package syslog-message