improved imuxsock doc & added small testing tool permanently

3 files changed, 37 insertions, 5 deletions

diff --git a/doc/imuxsock.html b/doc/imuxsock.html
index f3ee7be2..1ab99a76 100644
--- a/doc/imuxsock.html
+++ b/doc/imuxsock.html
@@ -27,15 +27,16 @@ case, it can be enabled via the
 $InputUnixListenSocketIgnoreMsgTimestamp and $SystemLogSocketIgnoreMsgTimestamp config directives</p>
 <p><b>There is input rate limiting available,</b> (since 5.7.1) to guard you against
 the problems of a wild running logging process. 
-If more than $IMUXSockRateLimitInterval * $IMUXSockRateLimitBurst log messages are emitted
-from the same process, those messages with $IMUXSockRateLimitSeverity or lower will be
+If more than $SystemLogRateLimitInterval * $SystemLogRateLimitBurst log messages are emitted
+from the same process, those messages with $SystemLogRateLimitSeverity or lower will be
 dropped. It is not possible to recover anything about these messages, but imuxsock will
 tell you how many it has dropped one the interval has expired AND the next message
 is logged. Rate-limiting depends on SCM_CREDENTIALS. If the platform does not support
 this socket option, rate limiting is turned off. If multiple sockets are configured,
 rate limiting works independently on each of them (that should be what you usually expect).
-The same functionality is available for the system log socket, which
-just uses the prefix $SystemLogRateLimit... but otherwise works exactly the same.
+The same functionality is available for additional log sockets, in which case the
+config statements just use 
+the prefix $IMUXSockRateLimit... but otherwise works exactly the same.
 When working with severities, please keep in mind that higher severity numbers mean lower
 severity and configure things accordingly.
 <p><b>Unix log sockets can be flow-controlled.</b> That is, if processing queues fill up,
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 8538140e..62d45228 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -1,6 +1,6 @@
 if ENABLE_TESTBENCH
 TESTRUNS = rt_init rscript
-check_PROGRAMS = $(TESTRUNS) ourtail nettester tcpflood chkseq msleep randomgen diagtalker uxsockrcvr
+check_PROGRAMS = $(TESTRUNS) ourtail nettester tcpflood chkseq msleep randomgen diagtalker uxsockrcvr syslog_caller
 TESTS = $(TESTRUNS) cfg.sh \
 	arrayqueue.sh \
 	linkedlistqueue.sh \
@@ -322,6 +322,9 @@ chkseq_SOURCES = chkseq.c
 tcpflood_SOURCES = tcpflood.c
 tcpflood_LDADD = $(SOL_LIBS)
 
+syslog_caller_SOURCES = syslog_caller.c
+syslog_caller_LDADD = $(SOL_LIBS)
+
 diagtalker_SOURCES = diagtalker.c
 diagtalker_LDADD = $(SOL_LIBS)
 
diff --git a/tests/syslog_caller.c b/tests/syslog_caller.c
index 91a1f08b..60f24166 100644
--- a/tests/syslog_caller.c
+++ b/tests/syslog_caller.c
@@ -1,3 +1,31 @@
+/* A very primitive testing tool that just emits a number of
+ * messages to the system log socket. Currently sufficient, but
+ * obviously room for improvement. 
+ *
+ * It is highly suggested NOT to "base" any derivative work
+ * on this tool ;)
+ *
+ * Part of the testbench for rsyslog.
+ *
+ * Copyright 2010 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include <syslog.h>