package logs-syslog

  1. Overview
  2. Docs
Logs reporter to syslog (UDP/TCP/TLS)

Install

Dune Dependency

Authors

Maintainers

Sources

logs-syslog-0.4.0.tbz
sha256=4eeb0d897d9c0f8aba6d38052b710dc72caaabb757bfa67c08bace0c87b8748a
sha512=3d66e4bc5323513b6796c29755ebf632b58a01208b9d858580e4e1175b6b98291cacc97de8848cad9c9ff660450d681952b548db8612ee4713b3dd2e1fb24f74

Description

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).

Published: 04 Jun 2023

README

Logs-syslog - Logs output via syslog

v0.4.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

Dependencies (5)

  1. syslog-message >= "1.0.0"
  2. ptime
  3. logs >= "0.5.0"
  4. dune >= "1.1.0"
  5. ocaml >= "4.03.0"

Dev Dependencies

None

Used by

None

Conflicts (3)

  1. tcpip < "7.0.0"
  2. mirage-clock < "3.0.0"
  3. mirage-kv < "3.0.0"