https://github.com/sensu-plugins/sensu-plugins-statuspage
Sensu plugins for Statuspage
https://github.com/sensu-plugins/sensu-plugins-statuspage
Last synced: 7 months ago
JSON representation
Sensu plugins for Statuspage
- Host: GitHub
- URL: https://github.com/sensu-plugins/sensu-plugins-statuspage
- Owner: sensu-plugins
- License: mit
- Created: 2015-02-16T12:06:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T19:17:41.000Z (about 4 years ago)
- Last Synced: 2024-04-25T23:44:11.344Z (about 1 year ago)
- Language: Ruby
- Homepage: http://sensu-plugins.io
- Size: 49.8 KB
- Stars: 4
- Watchers: 10
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Sensu-Plugins-statuspage
[](https://travis-ci.org/sensu-plugins/sensu-plugins-statuspage)
[](http://badge.fury.io/rb/sensu-plugins-statuspage)
[](https://codeclimate.com/github/sensu-plugins/sensu-plugins-statuspage)
[](https://codeclimate.com/github/sensu-plugins/sensu-plugins-statuspage)
[](https://gemnasium.com/sensu-plugins/sensu-plugins-statuspage)
## Functionality
**handler-statuspage**
Creates an issue on StatusPage.io and (optionally) updates a component status.
**metrics-statuspageio**
Sends graphite-style metrics to statuspage.io, for displaying public metrics. Note, this forks and is not meant for high-throughput. Rather, it is meant for high-value, low-throughput metrics for display on status page.
**check-statuspage-status**
Check the status rollup of a statuspage instance
## Files
* bin/check-statuspage-status
* bin/handler-statuspage
* bin/metrics-statuspageio
## Usage
**handler-statuspage**
```
{
"statuspage": {
"api_key": "YOURAPIKEY",
"page_id": "YOURPAGEID"
}
}
```
For use of a basic proxy, use "proxy_address" and "proxy_port":
```
{
"statuspage": {
"api_key": "YOURAPIKEY",
"page_id": "YOURPAGEID",
"proxy_port": "YOURPROXY",
"proxy_address": "YOURPROXYADDRESS"
}
}
```
**metrics-statuspageio**
```
{
"metrics-statuspageio": {
"api_key": "my_api_key",
"page_id": "my_page_id",
"metrics": {
"some.metric.identifier": "my_metric_id",
"another.metric.identifier": "another_metric_id"
}
}
}
```
**check-statuspage-status**
Use `-u` to set the url to your statuspage instance.
* `/opt/sensu/embedded/bin/check-statuspage-status.rb -u https://metastatuspage.com`
## Installation
[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
## Notes
As of this writing Redphone has not added StatusPage.io support to v0.0.6
You must manually build and install the gem:
```
git clone https://github.com/portertech/redphone.git
cd redphone
gem build redphone.gemspec OR /opt/sensu/embedded/bin/gem build redphone.gemspec
gem install redphone-0.0.6.gem OR /opt/sensu/embedded/bin/gem install redphone-0.0.6.gem
```
To update a component add a `"component_id": "IDHERE"` attribute to the corresponding check definition
Example:
```
{
"checks": {
"check_sshd": {
"handlers": ["statuspage"],
"component_id": "IDHERE",
"command": "/etc/sensu/plugins/check-procs.rb -p sshd -C 1 ",
"interval": 60,
"subscribers": [ "default" ]
}
}
}
```
To choose your own component or incident statuses instead of the defaults add the `statuspage__` in the check definition.
Example:
```
{
"checks": {
"check_sshd": {
"handlers": ["statuspage"],
"component_id": "IDHERE",
"statuspage_component_warning": "degraded_performance",
"statuspage_component_critical": "partial_outage",
"statuspage_incident_warning": "ignore",
"statuspage_incident_critical": "identified",
"command": "/etc/sensu/plugins/check-procs.rb -p sshd -C 1 ",
"interval": 60,
"subscribers": [ "default" ]
}
}
}
```