From 90b12bd71bb9fc79a4640b9112c13ef529d0196a Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Fri, 5 Dec 2014 22:26:11 +0000 Subject: Initial commit --- doc/ucspilogd.html | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 doc/ucspilogd.html (limited to 'doc/ucspilogd.html') diff --git a/doc/ucspilogd.html b/doc/ucspilogd.html new file mode 100644 index 0000000..1b06335 --- /dev/null +++ b/doc/ucspilogd.html @@ -0,0 +1,94 @@ + + + + + s6: the ucspilogd program + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The `ucspilogd` program

+ +

+ ucspilogd acts as a filter, converting syslog facility +numbers and alert levels into names. +

+ +

Interface

+ +

+     ucspilogd [ var ... ]
+

+ +

ucspilogd reads a stream of syslog-like messages on stdin. +Those messages can be newline-terminated or null-terminated.
For every line it reads: if it has been given var +arguments, it writes the value of every var environment +variable, followed by a colon and a space.
If the line begins with a syslog facility number and/or +alert level in the syslog format, it converts them into a +human-readable name in the syslogd fashion.
It then writes the processed line to stdout.

+ +

Common use

+ +

+ You can emulate the whole syslogd behaviour by combining the following +components: +

+ +

A Unix stream super-server such as +s6-ipcserver +listening to the Unix domain socket /dev/log, to connect to +the kernel log-reading interface.
ucspilogd running under that super-server, to read the +logs and perform adequate transformations.
A logger such as +s6-log +to store the logs into the filesystem.
A supervision mechanism such as s6, +to ensure ease of use and reliability of the whole chain.

+ +

+ The resulting suite of programs is still smaller, and way more reliable, +than a standard syslogd. +

+ +

+ In the examples/ROOT/img/services-local/syslogd-linux subdirectory of the s6 package, you will +find a suitable ucspilogd service directory. +The run scripts are written in the +execline +language. +

+ +

Using `ucspilogd` as a klogd replacement

+ +

+ Certain Unix kernels offer a nice interface to the kernel logs. +For instance, the Linux kernel provides the /proc/kmsg fake +file, that can be opened and read like a normal file, excepts that +it gives the kernel logs when they are available and blocks otherwise. +You can use ucspilogd to process data from those interfaces. +

+ +

+ The examples/ROOT/img/services-local/klogd-linux subdirectory of the s6 package +is a service directory providing such a klogd service +for Linux, using the /proc/kmsg interface. +

+ + + -- cgit v1.2.3

The ucspilogd program

Interface

Common use

Using ucspilogd as a klogd replacement

The `ucspilogd` program

Using `ucspilogd` as a klogd replacement