Bug 1354663

Summary: Documentation for rsyslog centralized logging contains typos
Product: Red Hat OpenStack Reporter: David Mulford <dmulford>
Component: documentationAssignee: RHOS Documentation Team <rhos-docs>
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: low Docs Contact:
Priority: unspecified    
Version: 5.0 (RHEL 7)CC: lars, lindomatic, srevivo
Target Milestone: ---Keywords: Documentation, ZStream
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Build Name: 22465, Installation and Configuration Guide-3-1 Build Date: 13-02-2014 15:49:11 Topic ID: 15932-446841 [Specified]
Last Closed: 2017-07-17 15:42:56 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Screen shot of documentation with call outs. none

Description David Mulford 2016-07-11 22:03:08 UTC
Created attachment 1178549 [details]
Screen shot of documentation with call outs.

Title: Configuring rsyslog on the Centralized Logging Server

Describe the issue:
Steps 1 and 3 contain typos that need to be fixed.

Suggestions for improvement:

For step 1, the documentation gives the following command to add the rsyslog port 514 through SELinux.

  # semanage -a -t syslogd_port_t -p udp 514

However, the "port" command is missing there, and the full command needs to say:

  # semanage port -a -t syslogd_port_t -p udp 514

For step 3, the documentation lists the following /etc/rsyslog.conf entries.

  $template TmplAuth, "/var/log/%HOSTNAME%/%PROGRAMNAME%.log" 

  authpriv.*   ?TmplAuth
  *.info,mail.none,authpriv.none,cron.none   ?TmplMsg

The last time contains ?TmplMsg, which creates an error when rsyslog parses the config file. Changing ?TmplMsg to ?TmplAuth fixes the issue. Here is the correct config:

  $template TmplAuth, "/var/log/%HOSTNAME%/%PROGRAMNAME%.log" 

  authpriv.*   ?TmplAuth
  *.info,mail.none,authpriv.none,cron.none   ?TmplAuth


Additional information:

I've added a screen shot highlighting the sections mentioned above.

Here is a link to the document:
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/3/html/Installation_and_Configuration_Guide/Configuring_the_rsyslog_Server.html

Comment 2 Lucy Bopf 2017-02-16 01:48:47 UTC
*** Bug 1421233 has been marked as a duplicate of this bug. ***

Comment 3 Lars Kellogg-Stedman 2017-07-17 15:42:56 UTC
The centralized logging solution we delivered in OSP11 does not use rsyslog.