hubot-ibmcloud-alert-notification
v0.0.2
Published
hubot script for alerting user on IBM Cloud application events
Downloads
4
Maintainers
Readme
hubot-ibmcloud-alert-notification
A hubot script that allows monitoring of applications and enabling alerts
Getting Started
Usage
Steps for adding this to your existing hubot:
cd
into your hubot directory- Install the app management functionality with
npm install hubot-ibmcloud-alert-notification --save
- Add
hubot-ibmcloud-alert-notification
andhubot-ibmcloud-alerts
to yourexternal-scripts.json
- Add the necessary environment variables:
export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
export HUBOT_IBM_ALERT_NOTIFICATION_ENDPOINT=<IBM Alert Notifications Endpoint URL>
export HUBOT_IBM_ALERT_NOTIFICATION_USERNAME=<IBM Alert Notification Username>
export HUBOT_IBM_ALERT_NOTIFICATION_PASSWORD=<IBM Alert Notification Password>
- Start up your bot & off to the races!
Commands
hubot ibm alert list|show
- Show status of enabled IBM Alert Notification triggers.hubot ibm alert me when cpu|memory|disk exceeds x%
- Enable IBM Alert Notifications for a resource with a set threshold.hubot ibm alert turn on cpu|memory|disk|crash|all
- Turns on IBM Alert Notifications for specified resource.hubot ibm alert turn off cpu|memory|disk|crash|all
- Turns off IBM Alert Notifications for specified resource.hubot ibm alert change cpu|memory|disk threshold to x%
- Sets IBM Alert Notification threshold trigger for specified resource.
Note: You must enable resource monitoring with the hubot-ibmcloud-alerts
script before enabling IBM Alert Notifications. See hubot alert help
for more details.
Hubot Adapter Setup
Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:
Cognitive Setup
This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.
Development
Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:
Configuration Setup
- Create
config
folder in root of this project. - Create
env
in theconfig
folder, with the following contents:
export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
export HUBOT_IBM_ALERT_NOTIFICATION_ENDPOINT=<IBM Alert Notifications Endpoint URL>
export HUBOT_IBM_ALERT_NOTIFICATION_USERNAME=<IBM Alert Notification Username>
export HUBOT_IBM_ALERT_NOTIFICATION_PASSWORD=<IBM Alert Notification Password>
- In order to view content in chat clients you will need to add
hubot-ibmcloud-formatter
to yourexternal-scripts.json
file. Additionally, if you want to usehubot-help
to make sure your command documentation is correct. Createexternal-scripts.json
in the root of this project
[
"hubot-help",
"hubot-ibmcloud-formatter"
]
- Lastly, run
npm install
to obtain all the dependent node modules.
Running Hubot with Adapters
Hubot supports a variety of adapters to connect to popular chat clients.
If you just want to use:
- Terminal: run
npm run start
- Slack: link to setup instructions
- Facebook Messenger: link to setup instructions
License
See LICENSE.txt for license information.
Contribute
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.