You must deploy your custom plugin on the HQ Server and on all the Agents you want to run the plugin.
Deploying the Plugin in .xml or .jar Format
You can name your plugin as you please, but the name must end with either -plugin.xml or -plugin.jar, depending on the plugin format.
| Plugin Format |
Description and Contents |
| -plugin.jar |
A standard jar-formatted file, containing etc/hq-plugin.xml — the plugin's XML descriptor — and any java class files, scripts, and MIB files. |
| -plugin.xml |
For plugins that consist solely of an XML descriptor. It is combined with HQ's plugin support classes (either in the hq-product.jar or other *-plugin.jar plugins). In the case of a script plugin, the script can also be included in a separate file (as opposed to embedded in the XML descriptor). |
Where to Place Custom-Plugin Files
Usually you will place your custom-plugin files in a subdirectory of the Server's and Agent's parent directories. By doing this, your plugin files will persist through upgrades. The subdirectory is called hq-plugins. For example:
Non-Windows Installation
- If the Server is installed at /usr/local/hyperic/<Server directory>, then add the plugin in /usr/local/hyperic/hq-plugins
- If the Agent is installed at /usr/local/hyperic/<Agent directory>, then add the plugin in /usr/local/hyperic/hq-plugins
Windows Installation
- If the Server is installed at C:\Program Files\Hyperic HQ\<Server directory>, then add the plugin in C:\Program Files\Hyperic HQ\hq-plugins
- If the Agent is installed at C:\Program Files\Hyperic HQ\<Agent directory>, then add the plugin in C:\Program Files\Hyperic HQ\hq-plugins
 | hq-plugins/ must exist prior to starting the Server
Hot-deployment on the Server side using the custom hq-plugins/ directory requires that the directory exist prior to starting the Server. So, after creating /usr/local/hyperic/hq-plugins/, you must restart the Server. |
Alternate File Placement
You can also place the files under the Server and Agent directories:
- On the Server: <Server directory>/hq-engine/server/default/deploy/hq.ear/hq-plugins/
- On the Agent: <Agent directory>/bundles/agent-x.y.z/pdk/plugins/
You should do this when, for example, you are installing a patch to a plugin, or if you want to keep all your Agent-deployment files together.
Hot Deployment of Plugins
The Server supports hot-deployment: plugins can be updated or added without restarting the Server.
The Agent does not support hot-deployment: it must be restarted after a plugin is updated or added.
Comments (1)
Mar 03
Stefan Lenke says:
,,