diff options
| author | Pavel Moravec <pmoravec@redhat.com> | 2021-03-29 16:23:01 +0200 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2021-04-05 14:09:33 -0400 |
| commit | 90b6b709e9f4002376b656b155d00d85382f1828 (patch) | |
| tree | 8c2f2f07557955fa2ba40b86353a323feb18ec37 /man | |
| parent | b27140a9126ea82efb517d60bf1b8455aaf4f5a6 (diff) | |
| download | sos-90b6b709e9f4002376b656b155d00d85382f1828.tar.gz | |
[report] add --cmd-timeout option
Add --cmd-timeout option to configure command timeout. Plugin-specific
option of the same name (i.e. -k logs.cmd-timeout=60) can control the
timeout per plugin.
Option defaults and global/plugin-specific option preference follows the
--plugin-timeout rules.
Resolves: #2466
Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sos-report.1 | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1 index 81005959..51cf3436 100644 --- a/man/en/sos-report.1 +++ b/man/en/sos-report.1 @@ -17,6 +17,7 @@ sosreport \- Collect and package diagnostic and support data [--label label] [--case-id id]\fR [--threads threads]\fR [--plugin-timeout TIMEOUT]\fR + [--cmd-timeout TIMEOUT]\fR [-s|--sysroot SYSROOT]\fR [-c|--chroot {auto|always|never}\fR [--tmp-dir directory]\fR @@ -247,7 +248,7 @@ Specify a timeout in seconds to allow each plugin to run for. A value of 0 means no timeout will be set. A value of -1 is used to indicate the default timeout of 300 seconds. -Note that this options sets the timeout for all plugins. If you want to set +Note that this option sets the timeout for all plugins. If you want to set a timeout for a specific plugin, use the 'timeout' plugin option available to all plugins - e.g. '-k logs.timeout=600'. @@ -255,6 +256,21 @@ The plugin-specific timeout option will override this option. For example, using \'--plugin-timeout=60 -k logs.timeout=600\' will set a timeout of 600 seconds for the logs plugin and 60 seconds for all other enabled plugins. .TP +.B \--cmd-timeout TIMEOUT +Specify a timeout limit in seconds for a command execution. Same defaults logic +from --plugin-timeout applies here. + +This option sets the command timeout for all plugins. If you want to set a cmd +timeout for a specific plugin, use the 'cmd-timeout' plugin option available to +all plugins - e.g. '-k logs.cmd-timeout=600'. + +Again, the same plugin/global precedence logic as for --plugin-timeout applies +here. + +Note that setting --cmd-timeout (or -k logs.cmd-timeout) high should be followed +by increasing the --plugin-timeout equivalent, otherwise the plugin can easily +timeout on slow commands execution. +.TP .B \--case-id NUMBER Specify a case identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods ('.'). |