From b0fe68c13b04af8c098d53ea999bba6b7395163d Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Wed, 16 Sep 2020 12:04:55 +0000 Subject: Documentation fixes, by flexibeast --- doc/s6-log.html | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'doc/s6-log.html') diff --git a/doc/s6-log.html b/doc/s6-log.html index 9384fa9..bd6d168 100644 --- a/doc/s6-log.html +++ b/doc/s6-log.html @@ -20,7 +20,7 @@

s6-log is a reliable logging program with automated log rotation, similar to -daemontools' multilog, +daemontools' multilog, with full POSIX regular expression support.

@@ -51,7 +51,7 @@ in order to process log lines.
  • -b : blocking mode. With this option, s6-log stops reading its standard input while it has unflushed buffers. This ensures that every log line has been fully processed before reading the next one; this is also -multilog's behaviour. +multilog's behaviour. By default, s6-log keeps reading from stdin even if its buffers still contain data. -b is safer, but may slow down your service; the default is faster, but may lead to unbound memory use if you have a lot of output to @@ -99,7 +99,7 @@ to make sure only one instance is running at the same time.
    • If current has the executable-by-user flag, it means that no s6-log process is currently writing to it and the previous s6-log process managed to cleanly finalize it. If it does not, -either a s6-log process is writing to it or the previous one +either an s6-log process is writing to it or the previous one has been interrupted without finalizing it.
  • state: last processor's output, see below.
  • previous: a rotation is happening in that logdir.
    • @@ -185,7 +185,7 @@ line is selected. -

    Why have another logging mechanism ?

    +

    Why have another logging mechanism?

    Because the syslog mechanism and all its implementations (save one) suck. @@ -375,7 +375,7 @@ I'm not being judgmental; I'm just stating the obvious.

    -When +When asked why he started rsyslog, Rainer Gerhards came up with a lot of hand-waving and not a single word about technical points. There is a reason for that: rsyslog is forked from sysklogd! So, no matter how @@ -416,7 +416,7 @@ up a disk before a rotation occurs. I am all for separating tasks that can be separated, but there is no choice here: logging and log rotation management must be done by the same tool. Only a few non-mainstream implementations of syslogd do this, including the -Busybox one - and that is a +Busybox one - and that is a feature added by the Busybox developers who are aware of the problem but want to maintain compatibility with the historical syslogd. Neither syslogd (-ng or not) nor rsyslogd manages its log files: that's a @@ -425,14 +425,14 @@ flaw that no amount of external tools is going to fix. complex processes running as root mean: bugs turning into security holes.

  • syslog requires a syslogd service, and fails otherwise. A syslogd service may not be present, it may fail... or it may want to log stuff. -Who's going to take care of syslogd's error messages ?
    • +Who's going to take care of syslogd's error messages?

    syslog is slow, it's unsafe, and it's incomplete. The only reason people use it is because it's historical, it exists, and there hasn't been any serious alternative yet, except maybe -multilog, which +multilog, which s6-log improves upon.

    @@ -502,7 +502,7 @@ system console. -

    What does s6-log have to do with all this ?

    +

    What does s6-log have to do with all this?

    @@ -524,7 +524,7 @@ not waste resources. is as powerful as a traditional syslogd.

  • s6-log can log to a RAM filesystem and thus is suitable as a catch-all logger. Clever tricks like Upstart's logd or daemontools' -readproctitle +readproctitle are just that: tricks. s6-log gives a unified interface to all of your system's loggers.
    • -- cgit v1.2.3