https://github.com/sensu-plugins/sensu-plugins-sms
Sensu SMS plugins
https://github.com/sensu-plugins/sensu-plugins-sms
Last synced: 7 months ago
JSON representation
Sensu SMS plugins
- Host: GitHub
- URL: https://github.com/sensu-plugins/sensu-plugins-sms
- Owner: sensu-plugins
- License: mit
- Created: 2015-03-19T14:23:06.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T15:04:54.000Z (about 4 years ago)
- Last Synced: 2024-11-09T07:49:49.923Z (8 months ago)
- Language: Ruby
- Homepage: http://sensu-plugins.io
- Size: 35.2 KB
- Stars: 2
- Watchers: 10
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Sensu-Plugins-sms
[](https://travis-ci.org/sensu-plugins/sensu-plugins-sms)
[](http://badge.fury.io/rb/sensu-plugins-sms)
[](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sms)
[](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sms)
[](https://gemnasium.com/sensu-plugins/sensu-plugins-sms)
## Functionality
## Files
* bin/check-sms
* bin/handler-playsms
* bin/metrics-sms-bulk
* bin/metrics-sms-if
* bin/metrics-sms
## Usage
### FreeSMS
```json
{
"free_sms_alert": {
"carrier_portal": {
// US carriers:
"att": "%number%@txt.att.net",
"verizon": "%number%@vtext.com",
"tmobile": "%number%@tmomail.net",
"sprint": "%number%@messaging.sprintpcs.com",
"virgin": "%number%@vmobl.com",
"uscellular": "%number%@email.uscc.net",
"nextel": "%number%@messaging.nextel.com",
"boost": "%number%@myboostmobile.com",
"alltel": "%number%@message.alltel.com",
// Canadian carriers:
"telus": "%number%@msg.telus.com",
"rogers": "%number%@pcs.rogers.com",
"fido": "%number%@fido.ca",
"bell": "%number%@txt.bell.ca",
"mts": "%number%@text.mtsmobility.com",
"kudo": "%number%@msg.koodomobile.com",
"presidentschoice": "%number%@txt.bell.ca",
"sasktel": "%number%@sms.sasktel.com",
"solo": "%number%@txt.bell.ca",
"virgincanada": "%number%@vmobile.ca",
// Dummy carrier (in case you actually want to send an email):
"email": "%number%"
},
"smtp_address": "localhost",
"smtp_domain": "localhost.localdomain",
"smtp_port": "25",
"mail_from": "[email protected]"
}
}
```
```json
{
"free_sms_alert": {
"alert_recipient_mappings": {
"ttutone": {
"name": "Tommy Tutone",
"carrier": "att",
"number": "800-867-5309"
},
"ghostbuster": {
"name": "Ghost Busters",
"carrier": "tmobile",
"number": "800-555-2368"
}
}
}
}
```
### playSMS
Create a json config file with your host, API user, and API secret.
```json
{
"playsms": {
"host": "http://playsms.example.com",
"api_user": "sensu",
"api_secret": "XXXXX"
}
}
```
Set your check to use the handler and define the playsms recipients.
```json
{
"checks": {
"check-disk-usage": {
"command": "check-disk-usage.rb -w :::disk.warning|80::: -c :::disk.critical|90:::",
"subscribers": [
"production"
],
"handlers": [
"playsms"
],
"playsms": {
"recipients": [
"1234567890",
"@joe_smith",
"#operations"
]
},
"interval": 60,
}
}
}
```
## Installation
[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
## Notes