summaryrefslogtreecommitdiffstats
path: root/doc/rsconf1_abortonuncleanconfig.html
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2009-09-17 12:30:00 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2009-09-17 12:30:00 +0200
commit8bea0d1d5762a3f0af74a5b9e9c0b15518774bec (patch)
treec957932f61f8ce1c38a0e4fa8861936af427b962 /doc/rsconf1_abortonuncleanconfig.html
parent4ccd08139214fd2c97268b39412a11241edbd815 (diff)
downloadrsyslog-8bea0d1d5762a3f0af74a5b9e9c0b15518774bec.tar.gz
rsyslog-8bea0d1d5762a3f0af74a5b9e9c0b15518774bec.tar.xz
rsyslog-8bea0d1d5762a3f0af74a5b9e9c0b15518774bec.zip
added $AbortOnUncleanConfig directive
permits to prevent startup when there are problems with the configuration file. See it's doc for details.
Diffstat (limited to 'doc/rsconf1_abortonuncleanconfig.html')
-rw-r--r--doc/rsconf1_abortonuncleanconfig.html37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/rsconf1_abortonuncleanconfig.html b/doc/rsconf1_abortonuncleanconfig.html
new file mode 100644
index 00000000..77526c07
--- /dev/null
+++ b/doc/rsconf1_abortonuncleanconfig.html
@@ -0,0 +1,37 @@
+<html>
+<head>
+<title>rsyslog.conf file</title>
+</head>
+<body>
+<a href="rsyslog_conf_global.html">rsyslog.conf configuration directive</a>
+
+<h2>$AboortOnUncleanConfig</h2>
+<p><b>Type:</b> global configuration directive</p>
+<p><b>Parameter Values:</b> boolean (on/off, yes/no)</p>
+<p><b>Available since:</b> 5.3.1+</p>
+<p><b>Default:</b> off</p>
+<p><b>Description:</b></p>
+<p>This directive permits to prevent rsyslog from running when the configuration file
+is not clean. "Not Clean" means there are errors or some other annoyances that rsyslgod
+reports on startup. This is a user-requested feature to have a strict startup mode. Note
+that with the current code base it is not always possible to differentiate between an
+real error and a warning-like condition. As such, the startup will also prevented if
+warnings are present. I consider this a good thing in being &quot;strict&quot;, but I admit
+there also currently is no other way of doing it.
+<p><b>Caveats:</b></p>
+Note that the consequences of a failed rsyslogd startup can be much more serious than a
+startup with only partial configuration. For example, log data may be lost or systems that
+depend on the log server in question will not be able to send logs, what in the ultimate
+result could result in a system hang on those systems. Also, the local system may hang when
+the local log socket has become full and is not read. There exist many such scenarios.
+As such, it is strongly recommended not to turn on this directive.
+
+<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual
+index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2009 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL
+version 2 or higher.</font></p>
+</body>
+</html>