From 6334d335d89ae5df344f833c5095e9dea2abf6fb Mon Sep 17 00:00:00 2001
From: Rainer Gerhards
Date: Thu, 23 Oct 2008 14:46:47 +0200
Subject: added configuration directive "HUPisRestart"
...which enables to configure HUP to be either a full restart
or "just" a leightweight way to close open files
---
doc/rsyslog_conf.html | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
(limited to 'doc/rsyslog_conf.html')
diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html
index be543833..cd3db405 100644
--- a/doc/rsyslog_conf.html
+++ b/doc/rsyslog_conf.html
@@ -59,17 +59,19 @@ remember, that a modules configuration directive (and functionality) is
only available if it has been loaded (using $ModLoad).
Lines
Lines can be continued by specifying a backslash ("\") as the last
-character of the line.
+character of the line. There is a hard-coded maximum line length of 4K.
+If you need lines larger than that, you need to change compile-time
+settings inside rsyslog and recompile.
Global Directives
All global directives need to be specified on a line by their
own and must start with a dollar-sign. Here is a list in alphabetical
order. Follow links for a description.
+Please note that not all directives here are actually global. Some affect
+only the next action. This documentation will be changed soon.
Not all directives have an in-depth description right now.
Default values for them are in bold. A more in-depth description will
-appear as implementation progresses. Directives may change during that
-process, we will NOT try hard to maintain backwards compatibility
-(after all, v3 is still very early in development and quite
-unstable...). So you have been warned ;)
+appear as implementation progresses.
+
Be sure to read information about queues in rsyslog -
many parameter settings modify queue parameters. If in doubt, use the
default, it is usually well-chosen and applicable in most cases.
@@ -175,12 +177,16 @@ default 60000 (1 minute)]
$GssForwardServiceName
$GssListenServiceName
$GssMode
+$HUPisRestart [on/off] - if set to on, a HUP is a full daemon restart. This means any queued messages are discarded (depending
+on queue configuration, of course) all modules are unloaded and reloaded. This mode keeps compatible with sysklogd, but is
+not recommended for use with rsyslog. To do a full restart, simply stop and start the daemon. The default is "on" for
+compatibility reasons. If it is set to "off", a HUP will only close open files. This is a much quicker action and usually
+the only one that is needed e.g. for log rotation. It is recommended to set the setting to "off".
$IncludeConfigMainMsgQueueCheckpointInterval <number>
$MainMsgQueueDequeueSlowdown <number> [number
is timeout in microseconds (1000000us is 1sec!),
default 0 (no delay). Simple rate-limiting!]
-$MainMsgQueueDiscardMark <number> [default
-9750]
+$MainMsgQueueDiscardMark <number> [default 9750]
$MainMsgQueueDiscardSeverity <severity>
[either a textual or numerical severity! default 4 (warning)]
$MainMsgQueueFileName <name>
--
cgit