Skip to main content

Python-based service registration daemon for Apache ZooKeeper

Project description

zk_watcher is a Python script that handles registration with an Apache ZooKeeper service.

The goal of zk_watcher is to monitor a particular service on a host machine and register that machine as a provider of that service at a given path on the ZooKeeper service.

A simple example is having zk_watcher monitor Apache httpd by running service apache2 status at a regular interval and registers with ZooKeeper at a given path (say /services/production/webservers). As long as the command returns a safe exit code (0), zk_watcher will register with ZooKeeper that this server is providing this particular service. If the hostname of the machine is, the registration path would look like this


In the event that the service check fails, the host will be immediately de- registered from that path.


To install, run

python install


pip install zk_watcher

Service Configs

To configure, edit the ‘/etc/zk/config.cfg’ file. The file consists of sections that each point to a particular service you want to monitor and register with ZooKeeper. An example file is provided, but could look like this

cmd: /etc/init.d/sshd status
refresh: 60
service_port: 22
zookeeper_path: /services/ssh
zookeeper_data: { "foo": "bar", "bah": "humbug" }

cmd: /etc/init.d/apache status
refresh: 60
service_port: 22
zookeeper_path: /services/web
zookeeper_data: foo=bar, bah=humbug


If you wish to create a Digset authentication token and use that for your client session with Zookeeper, you can add the settings to the config file like this

user: username
password: 123456

If you do this, please look at the nd_service_registry docs to understand how the auth token is used, and what permissions are setup by default.

Running it

See the ‘zk_watcher.rst’ file for configuration and run-time options.


Right now you must install this package as root, or you must create the /etc/zk directory ahead of time and change its ownership to your installation user name. The uses a hard-coded path (/etc/zk/config.cfg) for the config file, and will fail if it cannot create the file at that path. This will be fixed in the next version.

Contributing to this code

Code contributions can be made through the Nextdoor Gerrit Code Review system. In order to contribute, you will want to follow these instructions:

Nextdoor Code Review System

Place the following lines into ~/.ssh/config::

Port 29418

Then verify that you can connect to Gerrit::

$ ssh
****    Welcome to Gerrit Code Review    ****

Hi Matt Wise, you have successfully connected over SSH.

Unfortunately, interactive shells are disabled.
To clone a hosted Git repository, use:

git clone ssh://<YOUR USERNAME>

Connection to closed.

Install and configure git-change::

$ sudo easy_install pip
$ sudo pip install git-change

Clone the repo and setup your hooks::

$ git clone
$ cd zkwatcher
$ etc/

Make your change, and submit it::

$ touch MyFile
$ git add MyFile
$ git change create

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
zk_watcher-0.3.2.tar.gz (9.8 kB) Copy SHA256 hash SHA256 Source None Aug 27, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page