rPath Appliance Platform Agent:Collection Tool
From rPath Wiki
The rPath Appliance Platform Agent (rAPA) includes a Collection Tool plugin which is enabled by default. The plugin provides the Collection Tool page in the rAPA web interface. The Collection Tool allows a rAPA user to run an operation that gathers important information from the appliance into a compressed archive file which, in turn, can be downloaded from the appliance. This is useful for support personnel who need to have specific information to help troubleshoot and appliance issue.
Using the Services Plugin Interface
See the Collection Tool page in the Appliance Administration pages for information on how to use the Collection Tool in the web interface.
Appliance Developer Notes
The guide text on the default plugin provides information on how to customize what data is collected and how to brand the message on the Collection Tool page. The following is that text as created for rAPA 3.0.0:
Appliance Developers should customize and brand the contents of this section as appropriate for the appliance.
- To add data to the collection, add file lists and scripts as necessary to /etc/raa/collect.d/ on the appliance.
- To brand this page, place a custom HTML file on the appliance and set the collectiontool.vendorInformationPath in a [/collectiontool] section within custom.cfg to the absolute path of this HTML file. (This should be done alongside other custom rAPA configuration in /etc/raa/custom.cfg on the appliance, overriding default values in /etc/raa/prod.cfg.) For example, if the name of the HTML file is collection.html and it is placed in /etc/custom/raa/ on the appliance, developers should include the following line in custom.cfg for rAPA:
- collectiontool.vendorInformationPath = /etc/custom/raa/collection.html
 | CAUTION: The HTML file must be well-formed XHTML code, or this page will fail to render. |
| configuration item | default value | description |
|---|---|---|
| collectiontool.vendorInformationPath | %(top_level_dir)s/../raaplugins/collectiontool/web/static/vendor.html | Location of the HTML fragment which provides instruction text on the Collection Tool page in the Appliance Agent. This would generally be used to describe how a customer should file an issue report, including a data collection from Collection Tool. |
| collectiontool.storageDir | /var/lib/raa/collections | Default storage location for data collections. |
| collectiontool.configDir | /etc/raa/collect.d | Directory where configuration files are read. Typically no need to change this outside of a development environment. |
| collectiontool.fileNameFormat | datacollection-%Y-%m-%d.%H-%M | Format of the data collection file name (which uses time.strftime to interpret time/date macros). ".tar.gz" will always be added as an extension. |