README.rst

ZMON source code on GitHub is no longer in active development. Zalando will no longer actively review issues or merge pull-requests.

ZMON is still being used at Zalando and serves us well for many purposes. We are now deeper into our observability journey and understand better that we need other telemetry sources and tools to elevate our understanding of the systems we operate. We support the OpenTelemetry initiative and recommended others starting their journey to begin there.

If members of the community are interested in continuing developing ZMON, consider forking it. Please review the licence before you do.

ZMON Worker

ZMON's Python worker is doing the heavy lifting of executing tasks against entities, and evaluating all alerts assigned to check. Tasks are picked up from Redis and the resulting check values plus alert state changes are written back to Redis.

Local Development

Start Redis on localhost:6379:

$ docker run -p 6379:6379 -it redis

Install the required development libraries:

Ubuntu/Debian:

$ sudo apt-get install build-essential python2.7-dev libpq-dev libldap2-dev libsasl2-dev libsnappy-dev libev4 libev-dev freetds-dev
$ sudo pip2 install -r requirements.txt

macOS:

$ brew install python snappy
$ sudo pip install -r requirements.txt

Start the ZMON worker process:

$ python2 -m zmon_worker_monitor

You can query the worker monitor via the REST API:

$ curl http://localhost:8080/status

You can also query the worker monitor via RPC:

$ python2 -m zmon_worker_monitor.rpc_client http://localhost:23500/zmon_rpc list_stats

Running Unit Tests

Run tests via Tox.

$ tox

You can also pass args to pytest via tox, for instance to run specific test case:

$ tox tests/test_kairosdb.py::test_kairosdb_query

Alternative way of running unit tests within Docker:

$ export WORKER_IMAGE=registry.opensource.zalan.do/stups/zmon-worker:cd166
$ docker run -it -u $(id -u) -v $(pwd):/workdir -w /workdir $WORKER_IMAGE python setup.py flake8
$ docker run -it -u $(id -u) -v $(pwd):/workdir -w /workdir $WORKER_IMAGE python setup.py test

Building the Docker Image

$ docker build -t zmon-worker .
$ docker run -it zmon-worker

Running the Docker image

The Docker image supports many configuration options via environment variables. Configuration options are explained in the ZMON Documentation.