diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2020-04-20 13:17:32 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2020-04-22 10:58:15 -0400 |
| commit | 6a81e8d666a8f276833fa2e6a32a6047b2fd5790 (patch) | |
| tree | 0cd019d7044dbce92a5ee6e2696903eede0a8de5 /man/en | |
| parent | 9db06acd5c07180290cf9614f5f3bbf5eda80dde (diff) | |
| download | sos-6a81e8d666a8f276833fa2e6a32a6047b2fd5790.tar.gz | |
[collector] Passthru --threads, replace with --jobs for collect
Replaces the previous `--threads` option in collect with a `--jobs`
option to determine the number of concurrent collections to run.
Uses `--threads` as a passthru option now if the node supports it
(sos-3.6+), in an effort to unify option meanings between components.
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man/en')
| -rw-r--r-- | man/en/sos-collect.1 | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1 index 42c7e8bd..7d6f8b87 100644 --- a/man/en/sos-collect.1 +++ b/man/en/sos-collect.1 @@ -15,6 +15,7 @@ sos collect \- Collect sosreports from multiple (cluster) nodes [--encrypt-key KEY]\fR [--encrypt-pass PASS]\fR [\-\-group GROUP] + [\-j|\-\-jobs JOBS] [\-\-save\-group GROUP] [\-\-nopasswd-sudo] [\-k PLUGIN_OPTION] @@ -166,6 +167,15 @@ with the settings for cluster-type, master, and the node list as discovered by c Note that this means regexes are not directly saved to host groups, but the results of matching against those regexes are. .TP +\fB\-j\fR JOBS \fB\-\-jobs\fR JOBS +Specify the number of concurrent node collections that should be run. + +If the number of nodes enumerated exceeds the number of JOBS, then sos collect +will start collecting from the first X number of nodes and then continue to iterate +through the remaining nodes as sosreport collection finishes. + +Defaults to 4. +.TP \fB\-\-nopasswd-sudo\fR Use this option when connecting as a non-root user that has passwordless sudo configured. @@ -269,19 +279,18 @@ option cannot be removed from the sosreport command as it is required to run sosreport non-interactively for sos collect to function. .TP \fB\-t\fR THREADS \fB\-\-threads\fR THREADS -Specify the number of threads to use for concurrent collection of sosreports. +Report option. Specify the number of collection threads to run. -If the number of nodes enumerated exceeds the number of threads, then sos collect -will start collecting from the first X number of nodes and then continue to iterate -through the remaining nodes as sosreport collection finishes. +The report process on each node will run THREADS number of plugins concurrently +during the collection process. Defaults to 4. .TP \fB\-\-timeout\fR TIMEOUT Timeout for sosreport generation on each node, in seconds. -Note that sosreports are collected in parallel, so this can also be considered to be -approximately the same as a timeout for the entire collection process. +Note that sosreports are collected in parallel, so you can approximate the total +runtime of sos collect via timeout*(number of nodes/jobs). Default is 180 seconds. .TP |