https://github.com/sunray/rackspace-agent-plugins
Custom Rackspace Plugins
https://github.com/sunray/rackspace-agent-plugins
Last synced: over 1 year ago
JSON representation
Custom Rackspace Plugins
- Host: GitHub
- URL: https://github.com/sunray/rackspace-agent-plugins
- Owner: sunray
- Created: 2015-08-11T14:48:56.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-01-07T18:29:04.000Z (over 10 years ago)
- Last Synced: 2023-03-03T11:56:58.758Z (over 3 years ago)
- Language: Ruby
- Size: 8.79 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rackspace Monitoring Agent Custom Plugins
This repository contains contributed custom plugins for the Rackspace Cloud
Monitoring agent. For details about installing plugins, see [agent plugin check documentation](http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types-agent.html#section-ct-agent.plugin).
## Plugin Requirements
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
## Status
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.
## Metrics
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
## Alarm Criteria
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](http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html#concepts-alarms-alarm-language) for how to write alarm criteria.