This repository contains contributed custom plugins for the Rackspace Cloud Monitoring agent. For details about installing plugins, see agent plugin check documentation.
You can contribute your plugins by first forking the repo, committing your changes, and then opening a pull request through github. If you have any questions, feel free to reach out to us on #cloudmonitoring on freenode IRC.
Each plugin must fulfill the following properties:
- Output a status message to STDOUT
- Output one or more metrics if it succeeds in obtaining them to STDOUT
- Contain an appropriate license header
- Contain example alarm criteria
The status message should be of the form status $status_string, For example, it might be:
status ok succeeded in obtaining metrics
or
status err failed to obtain metrics
The status string should be a summary of the results, with actionable information if it fails.
The metrics message should be of the form metric $name $type $value [unit], for example:
metric time int32 1 seconds
The units are optional, and if present should be a string representing the units of the metric measurement. Units may not be provided on string metrics, and may not contain any spaces.
The available types are:
- string
- float
- double
- int32
- int64
- uint32
- uint64
- gauge
Each script should contain, just below the license header, in a comment, an example alarm criteria that can be used for the plugin. See the Rackspace Cloud Monitoring Documentation for how to write alarm criteria.
Submodules of repositories are stored in the contrib folder in this repo.
There are more plugins in that folder, some of these plugins have dependencies and their own readmes.
The contrib directory contains submodules of more custom plugins that have been used by other teams, including those from openstack and rackspace. These are older plugins for Icehouse/Juno, newer plugins for Kilo can be found at rcbops/rpc-openstack or inside contrib/rpc-openstack/maas/plugins.
You can pull the submodules with
git pull --recurse-submodules
git submodule update --recursive
The exact content will depend on your chosen license, but we recommend BSD, Apache 2.0, or MIT Licenses. Regardless of license choice the header should contain the author's (or authors') name(s) and email address(es).