From ecb68392ea6c51e170112667c611f0726ac92c2a Mon Sep 17 00:00:00 2001
From: Florian Riedl
Date: Tue, 10 Sep 2013 13:10:34 +0200
Subject: doc: add queue parameter skeleton
---
doc/queue_parameters.html | 71 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
create mode 100644 doc/queue_parameters.html
(limited to 'doc/queue_parameters.html')
diff --git a/doc/queue_parameters.html b/doc/queue_parameters.html
new file mode 100644
index 00000000..04da2ca7
--- /dev/null
+++ b/doc/queue_parameters.html
@@ -0,0 +1,71 @@
+
+
+rsyslog queues parameters
+
+back
+General Queue Parameters
+Queues need to be configured in the action or ruleset it should affect. If nothing is configured,
+default values will be used. Thus, the default ruleset has only the default main queue. Specific Action
+queues are not set up by default.
+
+ - queue.filename name
+ - queue.size number
+ - queue.dequeuebatchsize number
+
default 16
+ - queue.maxdiskspace number
+ - queue.highwatermark number
+
default 8000
+ - queue.lowwatermark number
+
default 2000
+ - queue.fulldelaymark number
+ - queue.lightdelaymark number
+ - queue.discardmark number
+
default 9750]
+ - queue.discardseverity number
+
*numerical* severity! default 8 (nothing discarded)
+ - queue.checkpointinterval number
+ - queue.syncqueuefiles on/off
+ - queue.type [FixedArray/LinkedList/Direct/Disk]
+ - queue.workerthreads number
+
number of worker threads, default 1, recommended 1
+ - queue.timeoutshutdown number
+
number is timeout in ms (1000ms is 1sec!), default 0 (indefinite)
+ - queue.timeoutactioncompletion number
+
number is timeout in ms (1000ms is 1sec!), default 1000, 0 means immediate!
+ - queue.timeoutenqueue number
+
number is timeout in ms (1000ms is 1sec!), default 2000, 0 means indefinite
+ - queue.timeoutworkerthreadshutdown number
+
number is timeout in ms (1000ms is 1sec!), default 60000 (1 minute)
+ - queue.workerthreadminimummessages number
+
default 100
+ - queue.maxfilesize size_nbr
+
default 1m
+ - queue.saveonshutdown on/off
+ - queue.dequeueslowdown number
+
number is timeout in microseconds (1000000us is 1sec!), default 0 (no delay). Simple rate-limiting!
+ - queue.dequeuetimebegin number
+ - queue.dequeuetimeend number
+
+Sample:
+The following is a sample of a TCP forwarding action with its own queue.
+
+
+[manual index]
+[rsyslog.conf]
+[rsyslog site]
+This documentation is part of the
+rsyslog project.
+Copyright © 2008, 2009 by Rainer Gerhards and
+Adiscon. Released under the GNU GPL
+version 3 or higher.
+
+
--
cgit v1.2.3