diff options
author | astokes <astokes@ef72aa8b-4018-0410-8976-d6e080ef94d8> | 2010-02-17 16:28:17 +0000 |
---|---|---|
committer | astokes <astokes@ef72aa8b-4018-0410-8976-d6e080ef94d8> | 2010-02-17 16:28:17 +0000 |
commit | 18191c43943661b2d61b191ea95a9c9351bd465c (patch) | |
tree | dd426874c830ec029dbd44eec4e469131d4fadc9 /example_plugins/runcommand.py | |
parent | 494f1de1db6c29a3f5f6d0e5cabc29b86eaf99e8 (diff) | |
download | sos-18191c43943661b2d61b191ea95a9c9351bd465c.tar.gz |
- moved 1.9 to trunkr1.9
git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@778 ef72aa8b-4018-0410-8976-d6e080ef94d8
Diffstat (limited to 'example_plugins/runcommand.py')
-rwxr-xr-x | example_plugins/runcommand.py | 45 |
1 files changed, 45 insertions, 0 deletions
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") |