package logs-syslog

  1. Overview
  2. Docs
On This Page
  1. Example usage
package logs-syslog
Legend:
Library
Module
Module type
Parameter
Class
Class type

Logs reporter via syslog using Unix

Please read Logs_syslog first.

val udp_reporter : ?hostname:string -> Unix.inet_addr -> ?port:int -> ?truncate:int -> unit -> Logs.reporter

udp_reporter ~hostname remote_ip ~port ~truncate () is reporter, which sends log message to remote_ip, port via UDP. Each message is truncated to truncate bytes (defaults to 65535). The hostname is part of each syslog message, and defaults to Unix.gethostname (), the port defaults to 514.

val tcp_reporter : ?hostname:string -> Unix.inet_addr -> ?port:int -> ?truncate:int -> ?framing:Logs_syslog.framing -> unit -> (Logs.reporter, string) Stdlib.result

tcp_reporter ~hostname remote_ip ~port ~truncate ~framing () is Ok reporter or Error msg. The reporter sends each log message via syslog to remote_ip, port via TCP. If the initial TCP connection to the remote_ip fails, an Error msg is returned instead. If the TCP connection fails, the log message is reported to standard error, and attempts are made to re-establish the TCP connection. A syslog message is truncated to truncate bytes (by default no truncation happens). Each syslog message is framed according to the given framing (defaults to a single 0 byte). The hostname defaults to Unix.gethostname (), port to 514, framing to append a 0 byte.

Example usage

To install a Unix syslog reporter. sending via UDP to localhost, use the following snippet:

Logs.set_reporter (udp_reporter (Unix.inet_addr_of_string "127.0.0.1") ())

To install a reporter using TCP, use the following snippet:

let () =
  match tcp_reporter (Unix.inet_addr_of_string "127.0.0.1") () with
  | Error e -> print_endline e
  | Ok r -> Logs.set_reporter r