reiseburo
/
verspaetung
mirror of https://github.com/reiseburo/verspaetung
1
0
Fork 0
Code Issues Releases Wiki Activity

Update the readme with release notes

This commit is contained in:
R. Tyler Croy 2015-07-04 14:12:27 -07:00
parent cb3465f715
commit 08e4076f95
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
1 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -16,24 +16,33 @@ reports it to statsd.
### Using ### Using
``` % java -jar verspaetung-*-all.jar --help
% java -jar verspaetung-0.1.4-all.jar --help usage: verspaetung
usage: verspaetung -H,--statsd-host <STATSD> Hostname for a statsd instance (defaults to
-H,--statsd-host <STATSD> Hostname for a statsd instance (defaults to localhost)
localhost) -n,--dry-run Disable reporting to a statsd host
-n,--dry-run Disable reporting to a statsd host -p,--statsd-port <PORT> Port for the statsd instance (defaults to
-p,--statsd-port <PORT> Port for the statsd instance (defaults to 8125)
8125) -s,--storm Watch Storm KafkaSpout offsets (under
-s,--storm Watch Storm KafkaSpout offsets (under /kafka_spout)
/kafka_spout) -z,--zookeeper <HOSTS> Comma separated list of Zookeeper hosts (e.g.
-z,--zookeeper <HOSTS> Comma separated list of Zookeeper hosts (e.g. localhost:2181)
localhost:2181)
```
Running Verspätung is rather easy, by default the daemon will monitor the standard Kafka high-level consumer offset path of `/consumers` and start reporting deltas automatically. Running Verspätung is rather easy, by default the daemon will monitor the
standard Kafka high-level consumer offset path of `/consumers` and start
reporting deltas automatically.
### Hacking ### Hacking
* *Running tests:* `./gradlew check` * *Running tests:* `./gradlew check`
* *Running the app locally:* `./gradlew run -PzookeeperHosts=localhost:2181` * *Running the app locally:* `./gradlew run -PzookeeperHosts=localhost:2181`
* *Building the app for distribution:* `./gradlew shadowJar` * *Building the app for distribution:* `./gradlew assemble`
### Releasing
This is mostly meant for the developer team, but currently releases can be
produced by simply pushing a Git tag to this GitHub repository. This will cause
Travis CI to build and test the tag, which if it is successful, will
automatically publish to
[Bintray](https://bintray.com/lookout/systems/verspaetung).