Extend the log config option description

Someone asked on Slack/IRC about this so I figured I'd clean it up a bit
to be more clear on how it works.

1 files changed, 54 insertions, 32 deletions

diff --git a/rel/overlay/etc/default.ini b/rel/overlay/etc/default.ini
index c6f4b9953..f08fff177 100644
--- a/rel/overlay/etc/default.ini
+++ b/rel/overlay/etc/default.ini
@@ -464,38 +464,60 @@ min_file_size = 131072
 _default = [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}]
 
 [log]
-; Set the log writer to use
-; Current writers include:
-;   stderr
-;   file
-;   syslog
-; You can also specify a full module name
-; here if you want to implement your own
-; writer. See couch_log_writer.erl for
-; more information on the (simple) API.
-writer = stderr
-
-; Options for the file writer
-; file = /path/to/couch.log
-; write_buffer = size_in_bytes
-; write_delay = time_in_milliseconds
-
-; Options for the syslog writer
-; syslog_host = remote host
+; Possible log levels:
+;  debug
+;  info
+;  notice
+;  warning, warn
+;  error, err
+;  critical, crit
+;  alert
+;  emergency, emerg
+;  none
+;
+; level = info
+;
+; Set the maximum log message length in bytes that will be
+; passed through the writer
+;
+; max_message_size = 16000
+;
+;
+; There are three different log writers that can be configured
+; to write log messages. The default writes to stderr of the
+; Erlang VM which is useful for debugging/development as well
+; as a lot of container deployments.
+;
+; There's also a file writer that works with logrotate and an
+; rsyslog writer for deployments that need to have logs sent
+; over the network.
+;
+; writer = stderr
+;
+; File Writer Options:
+;
+; The file writer will check every 30s to see if it needs
+; to reopen its file. This is useful for people that configure
+; logrotate to move log files periodically.
+;
+; file = ./couch.log ; Path name to write logs to
+;
+; Write operations will happen either every write_buffer bytes
+; or write_delay milliseconds. These are passed directly to the
+; Erlang file module with the write_delay option documented here:
+;
+;     http://erlang.org/doc/man/file.html
+;
+; write_buffer = 0
+; write_delay = 0
+;
+;
+; Syslog Writer Options:
+;
+; The syslog writer options all correspond to their obvious
+; counter parts in rsyslog nomenclature.
+;
+; syslog_host =
 ; syslog_port = 514
 ; syslog_appid = couchdb
 ; syslog_facility = local2
-
-; Possible logging levels (sorted by level):
-;     none
-;     emergency, emerg
-;     alert
-;     critical, crit
-;     error, err
-;     warning, warn
-;     notice
-;     info
-;     debug
-; Each controls how verbose logging will be. Higher level mean less log output.
-; none level turns logging off
-level = info