Hubot-canary NPM

hubot-canary

A Hubot script to query the canary.io API.

The commands supported are subject to change with little warning as we figure out what hubot-canary will become.

Install with npm using --save to add to your package.json dependencies.

  > npm install --save hubot-canary

Then add "hubot-canary" to your external-scripts.json.

Example external-scripts.json

["hubot-canary"]

Or if you prefer, just drop canary-io.coffee in your Hubot scripts folder and enjoy.

hubot canary mon <check-id> - start monitoring <check-id>. every 5 seconds send hubot canary summary <check-id>
hubot canary mon stop <check-id> - stop monitoring <check-id>
hubot canary mon stop all - stop all monitoring
hubot canary incident <check-id> - same as hubot canary mon <check-id> but only display 5xx http status and non-zero exit status (failures)
hubot canary summary <check-id> - get summary measurements of <check-id> for last 5 minutes sorted by most http status 5xx, most failed checks (non-zero exit_status), slowest avg, slowest single call, slowest total time
hubot canary check - get the list of URLs which have measurements taken by canary.io
hubot canary check <filter> - get filtered list of checked URLs. Coming soon!
hubot canary check reset - clear the hubot canary check cache, then get again
hubot canary watch <check-id> - get url to open <check-id> for real-time monitoring in http://watch.canary.io
hubot canary measure <check-id> - get url to download measurements of check-id for last 10 seconds
hubot canary measure <check-id> <num-seconds> - get url to download measurements of check-id for last num-seconds seconds
hubot canary help - get list of hubot canary commands