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 1468728 - docbugs for sosreport(1)
Summary: docbugs for sosreport(1)
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: sos
Version: 6.8
Hardware: All
OS: Linux
unspecified
low
Target Milestone: rc
: ---
Assignee: Shane Bradley
QA Contact: BaseOS QE - Apps
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-07-07 18:37 UTC by Mason Loring Bliss
Modified: 2022-03-13 14:20 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-08-16 17:05:41 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Mason Loring Bliss 2017-07-07 18:37:48 UTC
Description of problem:

Man page points to /usr/share/doc/sosreport, but should point to
/usr/share/doc/sos-3.2/ instead. Also, the man page should describe
--all-logs with more clarity, as the option only brings in additional
logs explicated in (for instance) rsyslog.conf.


Version-Release number of selected component (if applicable):

sos-3.2-15.el7.noarch

Actual results:

Incorrect documentation.

Expected results:

Correct documentation.

Additional info:

Additional bugs incoming.

Comment 2 Bryn M. Reeves 2017-07-07 19:31:27 UTC
I'm not sure at this stage in RHEL6's life time if there'd be much appetite for a pure documentation update - it may be better to consider this for upstream and RHEL7.

> as the option only brings in additional logs explicated in (for instance) 
> rsyslog.conf.

The option could use a better description but that's not quite accurate; the precise behaviour is plugin-defined but generally the option tells plugins that they can also collect rotated and archived logs, as well as logs in user-defined locations: all logs the plugin knows of should be included.

It is not mandatory and some plugins may behave the same regardless of --all-logs setting.

The most common pattern for implementing --all-logs is to collect all files in the log path with a glob ("/path/to/logs/*"). This is still subject to size limiting unless --log-size=0 is used (which we should also document explicitly if we're updating the man page).

For the system journal the option currently disables all scoping options (date range, line count etc.) and collects everything returned by journalctl. The journal interface available to all plugins supports these options but currently few other plugins that implement journal logs implement --all-logs for them (generally they collect the entire log by default).

It's implemented by 10 plugins in RHEL6, and about 45 in current upstream (which will soon be in RHEL7).

Some plugins also implement configuration parsing to identify additional logs (as the logs plugin does for syslog and rsyslog); by its nature this is plugin specific so we would either need to create documentation for each plugin (not a small task: there are over 220 plugins today), or extend the existing plugin description mechanism to also include some kind of summary of the log sources it will collect.


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