package logs-syslog

Logs-syslog - Logs output via syslog

v0.3.0

This library provides log reporters using syslog over various transports (UDP, TCP, TLS) with various effectful layers: Unix, Lwt, MirageOS. It integrates the Logs library, which provides logging infrastructure for OCaml, with the syslog-message library, which provides encoding and decoding of syslog messages (RFC 3164).

Six ocamlfind libraries are provided: the bare Logs-syslog, a minimal dependency Unix Logs-syslog-unix, a Lwt one Logs-syslog-lwt, another one with Lwt and TLS (RFC 5425) support Logs-syslog-lwt-tls, a MirageOS one Logs-syslog-mirage, and a MirageOS one using TLS Logs-syslog-mirage-tls.

Since MirageOS3, syslog is well integrated:

let logger =
  syslog_udp
    (syslog_config ~truncate:1484 "nqsb.io" (Ipaddr.V4.of_string_exn "192.168.0.1"))
    net
...
  register "myunikernel" [
    foreign
      ~deps:[abstract logger]

Documentation

API documentation is available online.

Installation

This is targeting other libraries (apart from syslog-message) which are released to opam-repository.

opam pin add syslog-message --dev-repo
opam pin add logs-syslog https://github.com/hannesm/logs-syslog.git