diff options
| -rw-r--r-- | man/en/sosreport.1 | 4 | ||||
| -rw-r--r-- | requirements.txt | 1 | ||||
| -rw-r--r-- | setup.py | 2 | ||||
| -rw-r--r-- | sos.spec | 1 | ||||
| -rw-r--r-- | sos/plugins/__init__.py | 1 | ||||
| -rw-r--r-- | sos/sosreport.py | 118 |
6 files changed, 100 insertions, 27 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1 index 8ec70c7e..b0adcd8b 100644 --- a/man/en/sosreport.1 +++ b/man/en/sosreport.1 @@ -12,6 +12,7 @@ sosreport \- Collect and package diagnostic and support data [--no-report] [--config-file conf]\fR [--batch] [--build] [--debug]\fR [--label label] [--case-id id] [--ticket-number nr] + [--threads threads] [-s|--sysroot SYSROOT]\fR [-c|--chroot {auto|always|never}\fR [--tmp-dir directory]\fR @@ -131,6 +132,9 @@ Specify an arbitrary identifier to associate with the archive. Labels will be appended after the system's short hostname and may contain alphanumeric characters. .TP +.B \--threads THREADS +Specify the number of threads sosreport will use for concurrency. Defaults to 4. +.TP .B \--case-id NUMBER Specify a case identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods ('.'). diff --git a/requirements.txt b/requirements.txt index 3a072cd4..7abc37f6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ pep8>=1.7.0 nose>=1.3.7 coverage>=4.0.3 Sphinx>=1.3.5 +futures @@ -73,7 +73,7 @@ setup(name='sos', ], packages=['sos', 'sos.plugins', 'sos.policies'], cmdclass={'build': BuildData, 'install_data': InstallData}, - requires=['six'], + requires=['six', 'futures'], ) @@ -19,6 +19,7 @@ Requires: tar Requires: bzip2 Requires: xz Requires: python-six +Requires: python-futures %description Sos is a set of tools that gathers information about system diff --git a/sos/plugins/__init__.py b/sos/plugins/__init__.py index 5882c37f..46962734 100644 --- a/sos/plugins/__init__.py +++ b/sos/plugins/__init__.py @@ -126,6 +126,7 @@ class Plugin(object): archive = None profiles = () sysroot = '/' + timeout = 300 def __init__(self, commons): if not getattr(self, "option_list", False): diff --git a/sos/sosreport.py b/sos/sosreport.py index 39b37b58..d19b1a36 100644 --- a/sos/sosreport.py +++ b/sos/sosreport.py @@ -30,6 +30,7 @@ from collections import deque from shutil import rmtree import tempfile import hashlib +from concurrent.futures import ThreadPoolExecutor, TimeoutError from sos import _sos as _ from sos import __version__ @@ -541,6 +542,17 @@ class SoSOptions(object): self._check_options_initialized() self._compression_type = value + @property + def threads(self): + if self._options is not None: + return self._options.threads + return self._threads + + @threads.setter + def threads(self, value): + self._check_options_initialized() + self._threads = value + def _parse_args(self, args): """ Parse command line options and arguments""" @@ -640,7 +652,10 @@ class SoSOptions(object): dest="compression_type", default="auto", help="compression technology to use [auto, " "gzip, bzip2, xz] (default=auto)") - + parser.add_argument("-t", "--threads", action="store", dest="threads", + default=4, type=int, + help="specify number of concurrent plugins to run" + " (default=4)") return parser.parse_args(args) @@ -1261,34 +1276,85 @@ class SoSReport(object): self.ui_log.info("") plugruncount = 0 - for i in zip(self.loaded_plugins): + self.pluglist = [] + self.running_plugs = [] + for i in self.loaded_plugins: plugruncount += 1 - plugname, plug = i[0] - status_line = (" Running %d/%d: %s... " - % (plugruncount, len(self.loaded_plugins), - plugname)) - if self.opts.verbosity == 0: - status_line = "\r%s" % status_line - else: - status_line = "%s\n" % status_line - if not self.opts.quiet: - sys.stdout.write(status_line) - sys.stdout.flush() + self.pluglist.append((plugruncount, i[0])) + try: + self.plugpool = ThreadPoolExecutor(self.opts.threads) + self.plugpool.map(self._collect_plugin, self.pluglist, chunksize=1) + self.plugpool.shutdown(wait=True) + self.ui_log.info("") + except KeyboardInterrupt: + self.ui_log.error(" Keyboard interrupt\n") + os._exit(1) + + def _collect_plugin(self, plugin): + '''Wraps the collect_plugin() method so we can apply a timeout + against the plugin as a whole''' + with ThreadPoolExecutor(1) as pool: try: - plug.collect() - except KeyboardInterrupt: - raise - except (OSError, IOError) as e: - if e.errno in fatal_fs_errors: - self.ui_log.error("") - self.ui_log.error(" %s while collecting plugin data" - % e.strerror) - self.ui_log.error("") - self._exit(1) - self.handle_exception(plugname, "collect") + t = pool.submit(self.collect_plugin, plugin) + t.result(timeout=self.loaded_plugins[plugin[0]-1][1].timeout) + return True + except TimeoutError: + self.ui_log.error("\n Plugin %s timed out\n" % plugin[1]) + self.running_plugs.remove(plugin[1]) + pool.shutdown(wait=False) + + def collect_plugin(self, plugin): + try: + count, plugname = plugin + plug = self.loaded_plugins[count-1][1] + self.running_plugs.append(plugname) + except: + return False + status_line = " Starting {:<5}: {:<15} [Running: {}]".format( + '%d/%d' % (count, len(self.loaded_plugins)), + plugname, + ' '.join(p for p in self.running_plugs)) + self.ui_progress(status_line) + try: + plug.collect() + # certain exceptions can cause either of these lists to no + # longer contain the plugin, which will result in sos hanging + # so we can't blindly call remove() on these two. + try: + self.pluglist.remove(plugin) except: - self.handle_exception(plugname, "collect") - self.ui_log.info("") + pass + try: + self.running_plugs.remove(plugname) + except: + pass + status = '' + if (len(self.pluglist) <= int(self.opts.threads) and + self.running_plugs): + status = " Finishing plugins %-13s [Running: %s]" % ( + ' ', + ' '.join(p for p in self.running_plugs)) + if not self.pluglist and not self.running_plugs: + status = " Finished running plugins" + if status: + self.ui_progress(status) + except (OSError, IOError) as e: + if e.errno in fatal_fs_errors: + self.ui_log.error("\n %s while collecting plugin data\n" + % e.strerror) + self._exit(1) + self.handle_exception(plugname, "collect") + except: + self.handle_exception(plugname, "collect") + + def ui_progress(self, status_line): + if self.opts.verbosity == 0: + status_line = "\r%s" % status_line + else: + status_line = "%s\n" % status_line + if not self.opts.quiet: + sys.stdout.write(status_line) + sys.stdout.flush() def report(self): for plugname, plug in self.loaded_plugins: |