Skip to main content

Zookeeper's four letters command wrapper and web monitor.

Project description

image0 image2 image1

Module lets you call ZooKeeper commands - four letters commands over TCP - https://zookeeper.apache.org/doc/r3.1.2/zookeeperAdmin.html#sc_zkCommands. It also has built-in web monitor. Based on Tornado, compatibile with Python 2.7.x, 3.x and above. It doesn’t require zookeeper, nor zookeeper’s headers (since it doesn’t utilize zkpython).

Installation

It can be installed from pypi or directly from git repository.

pip install zookeeper_monitor

#or

git clone https://github.com/kAlmAcetA/zookeeper_monitor.git
cd zookeeper_monitor/
python setup.py install

Usage

Example:

from zookeeper_monitor import zk

@tornado.gen.coroutine
def some_coroutine()
    host = zk.Host('zookeeper.addr.ip', 2181)
    # you can run each command as a coroutine example:
    # get srvr data
    srvr_data = yield host.srvr()
    # get stat data
    stat_data = yield host.stat()
    # get server state
    ruok = yield host.ruok()
    # stop zookeeper
    yield host.kill()

You can wrap it to sync code if you are not using tornado

from tornado.ioloop import IOLoop

IOLoop.instance().run_sync(some_coroutine)

Web monitor

To run web monitor you need to provide configuration, if you don’t, it will used localhost:2181 by default.

python -m zookeeper_monitor.web

# with configuration file
python -m zookeeper_monitor.web -c /somepath/cluster.json

# to see available options
python -m zookeeper_monitor.web --help

Next you navigate to http://127.0.0.1:8080/ (or whatever you specified).

Configuration

Defining cluster cluster.json (json or yaml)

{
    "name": "brand-new-zookeeper-cluster",
    "hosts": [
        {"addr": "10.1.15.1", "port": 2181, "dc":"eu-west"},
        {"addr": "10.2.31.2", "port": 2181, "dc":"us-east"},
        {"addr": "10.1.12.3", "port": 2181, "dc":"eu-west"}
    ]
}
  • name (string) - cluster name.

  • hosts (list) - List of hosts running ZooKeeper connected in cluster:

    • addr (string): IP or domain, mandatory

    • port (int): ZooKeeper port, optional, default 2181

    • dc (string): datacenter/location name, optional

Screenshots

Cluster view image22

Node stat view image23

License

MIT

TODO

  • more tests

  • more stats in webmonitor

  • parse zookeeper version

  • new commands in zookeeper 3.3 and 3.4

  • parse output of dump, reqs

Changelog

0.2.2 - clean ups: pylint, README, classifiers

0.2.1 - fix package, fix tests

0.2.0 - implement more commands, updated docs

0.1.2 - release - pypi

0.1.1 - clean up

0.1.0 - public standalone

0.0.3 - 0.0.9 - refactor, tests

0.0.2 - working draft

0.0.1 - initial concept

Project details


Download files

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

Source Distribution

zookeeper_monitor-0.2.3.tar.gz (19.3 kB view details)

Uploaded Source

File details

Details for the file zookeeper_monitor-0.2.3.tar.gz.

File metadata

File hashes

Hashes for zookeeper_monitor-0.2.3.tar.gz
Algorithm Hash digest
SHA256 5d059bc208ca3caea28556a4ce6622c000eb88132769e706f8f75955b2856109
MD5 c96372e43aff28a2cadb0b50c2a2355c
BLAKE2b-256 f44edc11bd40c050973c34557f6130ae1ec774be1fa9137988459b7021a1c55d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page