2015-01-09 23:40:46 +00:00
|
|
|
# Verspätung
|
|
|
|
|
|
2015-01-19 19:54:28 +00:00
|
|
|
[](https://travis-ci.org/lookout/verspaetung)
|
|
|
|
|
|
2015-01-28 11:20:10 +00:00
|
|
|
[  ](https://bintray.com/lookout/systems/verspaetung/_latestVersion)
|
|
|
|
|
|
2015-01-09 23:40:46 +00:00
|
|
|
Verspätung is a small utility which aims to help identify delay of
|
|
|
|
|
[Kafka](http://kafka.apache.org) consumers.
|
|
|
|
|
|
|
|
|
|
Verspätung monitors the topics and their latest offsets by talking to Kafka, it
|
|
|
|
|
will also keep track of how far along consumers are by monitoring the offsets
|
|
|
|
|
that they have committed to Zookeeper. Using both of these pieces of
|
|
|
|
|
information, Verspätung computs the delta for each of the consumer groups and
|
|
|
|
|
reports it to statsd.
|
|
|
|
|
|
2015-01-28 11:33:52 +00:00
|
|
|
### Using
|
|
|
|
|
|
2015-07-04 21:12:27 +00:00
|
|
|
% java -jar verspaetung-*-all.jar --help
|
|
|
|
|
usage: verspaetung
|
|
|
|
|
-H,--statsd-host <STATSD> Hostname for a statsd instance (defaults to
|
|
|
|
|
localhost)
|
|
|
|
|
-n,--dry-run Disable reporting to a statsd host
|
|
|
|
|
-p,--statsd-port <PORT> Port for the statsd instance (defaults to
|
|
|
|
|
8125)
|
|
|
|
|
-s,--storm Watch Storm KafkaSpout offsets (under
|
|
|
|
|
/kafka_spout)
|
|
|
|
|
-z,--zookeeper <HOSTS> Comma separated list of Zookeeper hosts (e.g.
|
|
|
|
|
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.
|
2015-01-09 23:40:46 +00:00
|
|
|
|
2015-01-10 02:17:45 +00:00
|
|
|
### Hacking
|
|
|
|
|
|
|
|
|
|
* *Running tests:* `./gradlew check`
|
2015-01-18 00:46:28 +00:00
|
|
|
* *Running the app locally:* `./gradlew run -PzookeeperHosts=localhost:2181`
|
2015-07-04 21:12:27 +00:00
|
|
|
* *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).
|
