diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2018-12-03 17:55:24 -0500 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2019-03-12 15:47:15 +0000 |
| commit | 031ff485afd888a5ecf9297bde2c2659cf3e1ec5 (patch) | |
| tree | 114c62ba9b79d02139c079c20f30cede5033ec01 /man | |
| parent | dbb76f07de0e4c3c03197a0536ce1cc5a130def7 (diff) | |
| download | sos-031ff485afd888a5ecf9297bde2c2659cf3e1ec5.tar.gz | |
[sosreport] Allow user-controllable plugin timeouts
Allows users to specify a timeout for each plugin using the '-k
plugin.timeout=value' syntax by adding the 'timeout' option to every
plugin.
Additionally, adds the --plugin-timeout option to set a timeout for
_all_ plugins. If --plugin-timeout and a specific -k timeout option is
provided, the -k timeout option will be applied for those specific
plugins, with --plugin-timeout being applied to all others.
In either case, specifying a timeout of 0 seconds results in no timeout
being applied. In the event that an invalid timeout is set, the timeout
will be set to the default value for the plugin.
Resolves: #1499
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sosreport.1 | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1 index b6051edc..014d01a3 100644 --- a/man/en/sosreport.1 +++ b/man/en/sosreport.1 @@ -13,6 +13,7 @@ sosreport \- Collect and package diagnostic and support data [--batch] [--build] [--debug]\fR [--label label] [--case-id id] [--ticket-number nr] [--threads threads] + [--plugin-timeout TIMEOUT]\fR [-s|--sysroot SYSROOT]\fR [-c|--chroot {auto|always|never}\fR [--tmp-dir directory]\fR @@ -163,6 +164,18 @@ alphanumeric characters. .B \--threads THREADS Specify the number of threads sosreport will use for concurrency. Defaults to 4. .TP +.B \--plugin-timeout TIMEOUT +Specify a timeout in seconds to allow each plugin to run for. A value of 0 +means no timeout will be set. + +Note that this options 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'. + +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 \--case-id NUMBER Specify a case identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods ('.'). |