aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-04-26 12:43:45 -0400
committerJake Hunsaker <jhunsake@redhat.com>2021-04-30 10:25:38 -0400
commit433e3c410cfdf43614b17180325e67bd8b35e852 (patch)
tree517292899eef37ddecdccf1c9e20cf1945b09cc0 /man
parent5ac15f2c22d9a5d6b55caba1024ebbb8b92c5157 (diff)
downloadsos-433e3c410cfdf43614b17180325e67bd8b35e852.tar.gz
[man] Add missing log-size report option to collect manpage
The `collect` component supports `--log-size` as a passthru option for report. Add it to the `collect` manpage for completeness. Related: #2510 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-collect.113
1 files changed, 13 insertions, 0 deletions
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index da36542d..286bfe71 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -20,6 +20,7 @@ sos collect \- Collect sosreports from multiple (cluster) nodes
[\-\-nopasswd-sudo]
[\-k PLUGIN_OPTION]
[\-\-label LABEL]
+ [\-\-log-size SIZE]
[\-n SKIP_PLUGINS]
[\-\-nodes NODES]
[\-\-no\-pkg\-check]
@@ -198,6 +199,18 @@ both the sos collect archive and the sosreport archives.
If a cluster sets a default label, the user-provided label will be appended to
that cluster default.
.TP
+\fB \--log-size\fR SIZE
+Places a limit on the size of collected logs and output in MiB. Note that this
+causes sos to capture the last X amount of the file or command output collected.
+
+By default, this is set to 25 MiB and applies to all files and command output collected
+with the exception of journal collections, which are limited to 100 MiB.
+
+Setting this value to 0 removes all size limitations, and any files or commands
+collected will be collected in their entirety, which may drastically increase the
+size of the final sos report tarball and the memory usage of sos during collection
+of commands, such as very large journals that may be several GiB in size.
+.TP
\fB\-n\fR SKIP_PLUGINS, \fB\-\-skip\-plugins\fR SKIP_PLUGINS
Sosreport option. Disable (skip) a particular plugin that would otherwise run.
This is useful if a particular plugin is prone to hanging for one reason or another.