RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1459896 - rsyslog-doc: Documentation regarding disk assisted queues incorrect
Summary: rsyslog-doc: Documentation regarding disk assisted queues incorrect
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: rsyslog
Version: 7.5
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: rc
: ---
Assignee: Jiří Vymazal
QA Contact: Stefan Dordevic
URL:
Whiteboard:
Depends On:
Blocks: 1420851
TreeView+ depends on / blocked
 
Reported: 2017-06-08 13:20 UTC by Kyle Walker
Modified: 2021-08-30 13:15 UTC (History)
6 users (show)

Fixed In Version: rsyslog-8.24.0-16.el7
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-04-10 15:26:37 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
proposed patch (4.75 KB, patch)
2017-10-09 14:44 UTC, Jiří Vymazal
no flags Details | Diff
proposed patch (6.78 KB, patch)
2017-11-09 11:39 UTC, Jiří Vymazal
no flags Details | Diff


Links
System ID Private Priority Status Summary Last Updated
Github rsyslog rsyslog-doc issues 365 0 'None' closed Fix queue default values 2020-08-20 07:16:30 UTC
Red Hat Knowledge Base (Solution) 3071121 0 None None None 2017-06-08 13:21:53 UTC
Red Hat Product Errata RHBA-2018:0856 0 None None None 2018-04-10 15:27:12 UTC

Description Kyle Walker 2017-06-08 13:20:43 UTC
Description of problem:
The documented default values for the following values are incorrect. Per the documentation shipped within the rsyslog-doc RPM:

/usr/share/doc/rsyslog-7.4.7/html/rsyslog_conf_global.html
<formatted>
    $ActionQueueHighWaterMark <number> [default 8000]
<snip>
    $ActionQueueLowWaterMark <number> [default 2000]
<formatted>

This is similar to the bug report below that was closed WONTFIX due to being opened against an older release not eligible for the solution described.

    Bug 922152 – Documentation states incorrect default values for certain queue related directives

When using the documented default values, the disk assisted queues will not be used. This is due to the (documented) ActionQueueLowWaterMark being higher than the default ActionQueueSize of 1000. The ActionQueueSize is hit prior to the watermark being hit, and the disk-assisted queue functionality fails.


Version-Release number of selected component (if applicable):
 rsyslog-7.4.7-16.el7

How reproducible:
 Easily

Steps to Reproduce:
1. Set a remote rsyslog target with the default configuration values.

$ActionQueueFileName fwdRule1 # unique name prefix for spool files
$ActionQueueMaxDiskSpace 1g   # 1gb space limit (use as much as possible)
$ActionQueueSaveOnShutdown on # save messages to disk on shutdown
$ActionQueueType LinkedList   # run asynchronously
$ActionResumeRetryCount -1    # infinite retries if host is down
$ActionQueueLowWaterMark 2000 # the default
$ActionQueueHighWaterMark 8000 # the default

# remote host is: name/ip:port, e.g. 192.168.0.1:514, port optional
*.* @@remote-host:514

2. Initiate a connection failure state on the remote-host system
3. Verify that there are local fwdRule1 spool files created


Actual results:
 Spool files are not created, and the local logging will stall within rsyslog until the remote action is failed entirely.


Expected results:
 Spool files are created and logging continues during intermittent connection failures to a remote rsyslog server.

Additional info:
 The actual defaults are visible in the action.c source file:

        cs.iActionQHighWtrMark = 800;                   /* high water mark for disk-assisted queues */
        cs.iActionQLowWtrMark = 200;                    /* low water mark for disk-assisted queues */

Comment 5 Jiří Vymazal 2017-10-09 14:44:58 UTC
Created attachment 1336435 [details]
proposed patch

Comment 9 Jiří Vymazal 2017-11-09 11:39:31 UTC
Created attachment 1349855 [details]
proposed patch

Comment 15 errata-xmlrpc 2018-04-10 15:26:37 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2018:0856


Note You need to log in before you can comment on or make changes to this bug.