diff options
Diffstat (limited to 'example_plugins')
| -rwxr-xr-x | example_plugins/example.py | 94 | ||||
| -rw-r--r-- | example_plugins/fsusage.py | 23 | ||||
| -rw-r--r-- | example_plugins/release.py | 21 | ||||
| -rwxr-xr-x | example_plugins/runcommand.py | 45 |
4 files changed, 183 insertions, 0 deletions
diff --git a/example_plugins/example.py b/example_plugins/example.py new file mode 100755 index 00000000..1e650417 --- /dev/null +++ b/example_plugins/example.py @@ -0,0 +1,94 @@ +## example.py +## An example sos plugin + +### This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. + +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. + +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +import sos.plugintools + +# Class name must be the same as file name and method names must not change +class example(sos.plugintools.PluginBase): + """This is an example plugin for sos. Plugins gather, analyze, and report on various aspects + of system operation that are of interest. plugins are based on the PluginBase class, which + you should inspect if you wish to override any methods in your plugin. The methods of use + to plugin developers are: + collect() - use the functions sosCp and sosRunExe to gether information + analyze() - perform any special analysis you require beyond just saving the + information gathered by collect(). Use sosAlert() and sosAddCustomText() + to add information to the report. + report() - override this method if you wish to replace the default reporting + + All plugins will use collect(), some will use analyze(), few will override report() + """ + + # Add your options here, indicate whether they are slow to run, and set whether they are enabled by default + # Options are python dictionaries that conatin a short name, long description, speed, and whether they are enabled by default + optionList = [("init.d", 'Gathers the init.d directory', 'slow', 0), + ('follicles', 'Gathers information about each follicle on every toe', 'slow', 0), + ('color', 'Gathers toenail polish color', 'fast', 0)] + + def setup(self): + ''' First phase - Collect all the information we need. + Directories are copied recursively. arbitrary commands may be + executed using the susRunExe method. Information is automatically saved, and + links are presented in the report to each file or directory which has been + copied to the saved tree. Also, links are provided to the output from each command. + ''' + # Here's how to copy files and directory trees + self.addCopySpec("/etc/hosts") + # this one saves a file path to the copy for later analysis + # FIXME: Need to figure out how to do this + # self.fooFilePath = self.copyFileOrDir("/proc/cpuinfo") + + # Here's how to test your options and execute if enabled + if self.isOptionEnabled("init.d"): + self.addCopySpec("/etc/init.d") # copies a whole directory tree + + # Here's how to execute a command + # you can save the path to the copied file for later analysis if desired + # FIXME: Need to figure out how to do this + self.psCmdDstFileName = self.runExe("/bin/ps -ef") + return + + def analyze(self): + ''' This is optional and need not be defined. + If you wish to perform some analysis on either files + that were gathered or on the output of commands, then save the filenames on the + destination file system when gathering that information in the collect() method + and use them here + ''' + # This is an example of opening and reading the output of a command that + # was run in the collect() method. Note that the output of the command is + # included in the report anyway + fd = open(self.fooFilePath) + lines = fd.readlines() + fd.close() + for line in lines: + if line.count("vendor_id"): + self.addCustomText("Vendor ID string is: %s <br>\n" % line) + # + # Alerts can optionally be generated, and will be included in the + # report automatically + # + self.addAlert("This is an alert") + return + +# def report(self): +# """ Usually, this doesn't even need to be defined, and you can inherit the +# base class, unless you want to replace what sosGetResults() +# does with your own custom report generator. If you are going to do that, have a good +# look at that method to see what it does. Custom text and alerts can still be added +# here using sosAddCustomText() and sosAddAlert() +# This method returns html that will be included inline in the report +# """ diff --git a/example_plugins/fsusage.py b/example_plugins/fsusage.py new file mode 100644 index 00000000..2532c5f7 --- /dev/null +++ b/example_plugins/fsusage.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python + +### This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. + +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. + +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +import sos.plugintools + +# Class name must be the same as file name and method names must not change +class fsusage(sos.plugintools.PluginBase): + def setup(self): + self.psCmdDstFileName = self.collectExtOutput("/bin/df -al") + return diff --git a/example_plugins/release.py b/example_plugins/release.py new file mode 100644 index 00000000..db4d7581 --- /dev/null +++ b/example_plugins/release.py @@ -0,0 +1,21 @@ +### This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. + +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. + +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +import sos.plugintools + +# Class name must be the same as file name and method names must not change +class release(sos.plugintools.PluginBase): + def setup(self): + self.addCopySpec("/etc/redhat-release") + return diff --git a/example_plugins/runcommand.py b/example_plugins/runcommand.py new file mode 100755 index 00000000..df8951d2 --- /dev/null +++ b/example_plugins/runcommand.py @@ -0,0 +1,45 @@ +## runcommand.py +## An example plugin for sos + +### This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. + +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. + +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +import sos.plugintools + +# Class name must be the same as file name and method names must not change +class runcommand(sos.plugintools.PluginBase): + """This is a very simple example plugin that just runs one command in a shell. That + command could be a script supplied with your package which outputs information of interest + to support. When the script or command is run, stdout is collected and included in the + report generated by sosreport, and stderr is collected and copied into the sos log. + + This is useful for people who have minimal knowledge of python, who wish to write + collection tools in other languages, or who have existing tools. + + If your script or command generates output files that you want included in the sosreport + collection of files, include sosCp calls to include them. + + The only method required for this simple plugin is collect(). + + Your finished plugin should be included with your package and installed in python's + site-packages/sos/plugins/ directory + """ + def setup(self): + ''' Run a command. Output is automatically included in the report. + ''' + self.collectExtOutput("/path/to/my/script --myoption --anotheroption") + + # if (for example) that command created files /foo/bar/baz.txt and + # we want to include that in our report, we include the next line: + #self.pit.sosCp("/foo/bar/baz.txt") |