README.md in watchmonkey_cli-1.10.0 vs README.md in watchmonkey_cli-1.11.0
- old
+ new
@@ -2,14 +2,15 @@
Watchmonkey is a very simple tool to monitor resources with Ruby without the need of installing agents on the systems you want to monitor. To accomplish this the application polls information via SSH or other endpoints (e.g. websites, FTP access). It's suitable for small to medium amounts of services.
Before looking any further you might want to know:
- * There is no escalation or notification system but you may add it yourself
- * I created this for being used with [Platypus](http://sveinbjorn.org/platypus) hence the [Platypus Hook](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb)
+ * There is no escalation or notification system (except experimental telegram bot) but you may add it yourself
+ * I originally created this for being used with [Platypus](http://sveinbjorn.org/platypus) hence the [Platypus Hook](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb)
* This is how the text output looks like: [Screenshot](http://imgur.com/8yLYnKb)
* This is how the Platypus support looks like: [ProgressBar](http://imgur.com/Vd8ZD7A) [HTML/WebView](http://imgur.com/5FwmWFZ)
+ * This is how Telegram Bot looks for now: [Telegram Screenshot](http://imgur.com/HBONi51)
---
## Help
If you need help or have problems [open an issue](https://github.com/2called-chaos/watchmonkey_cli/issues/new).
@@ -41,10 +42,12 @@
Usage: watchmonkey [options]
# Application options
--generate-config [myconfig] Generates a example config in ~/.watchmonkey
-l, --log [file] Log to file, defaults to ~/.watchmonkey/logs/watchmonkey.log
-t, --threads [NUM] Amount of threads to be used for checking (default: 10)
+ -e, --except tag1,tag2 Don't run tasks tagged with given tags
+ -o, --only tag1,tag2 Only run tasks tagged with given tags
-s, --silent Only print errors and infos
-q, --quiet Only print errors
# General options
-d, --debug [lvl=1] Enable debug output
@@ -78,9 +81,18 @@
## Additional Features
### ReQueue
By default Watchmonkey will run all tests once and then exit. This addon will enable Watchmonkey to run in a loop and run tests on a periodic interval.
Since this seems like a core feature it might get included directly into Watchmonkey but for now take a look at the [application configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [ReQueue source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/requeue.rb) for integration examples.
+
+### Telegram Bot
+Notify via Telegram. Experimental. Refer to [application configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [TelegramBot source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/telegram_bot.rb) for further information.
+
+* works with ReQueue (wouldn't make much sense otherwise huh?)
+* optional per-user message throttling via checker uniqid (checker name + host + arguments)
+* optional per-user only/except filters based on tags
+* planned: robust telegram connection failure handling
+* planned: per-user regex exclusion filters
### Platypus support
[Platypus](http://sveinbjorn.org/platypus) is a MacOS software to create dead simple GUI wrappers for scripts. There is buildin support for the interface types ProgressBar and WebView. For integration examples take a look at the [application configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [Platypus hook source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb).