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 <https://opentelemetry.io/>
_ 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.
.. image:: https://readthedocs.org/projects/zmon/badge/?version=latest :target: https://readthedocs.org/projects/zmon/?badge=latest :alt: Documentation Status
ZMON is Zalando's open-source platform monitoring tool, used in production since early 2014. It supports our many engineering teams in observing their services and metrics on various layers, from low level system metrics to team's business KPIs.
To get familiar with the ideas behind ZMON and how things work, you can take a quick dive in: Intro <http://zmon.readthedocs.org/en/latest/intro.html>
_
Check commands <https://zmon.readthedocs.io/en/latest/user/check-commands.html>
_We suggest to use docker compose for deploying zmon locally or on a single host:
More here: compose <https://github.com/zalando/zmon/tree/master/compose>
_
The docker compose is also the most convient way to setup a development environment.
In cases where docker compose is not an options continue on (or fall back to obsolete vagrant box).
You best head for the documentation now: Component overview <https://zmon.readthedocs.io/en/latest/installation/configuration.html>
_
ZMON relies on a few great open source products to run, which you will need to operate.
This seems to be a lot, but we provide both a Vagrant box and the deployment scripts for our demo host <https://github.com/zalando/zmon-demo/blob/master/bootstrap/bootstrap.sh>
_, lowering the bar to get started :)
Frontend / Controller <https://github.com/zalando/zmon-controller>
_ UI and REST API
Scheduler <https://github.com/zalando/zmon-scheduler>
_ Schedules check/alert execution
Worker <https://github.com/zalando/zmon-worker>
_ Executes check/alert commands and data acquisition
Data service <https://github.com/zalando/zmon-data-service>
_ Used for distributed monitoring where sites don't share network connectivity other than the Internet.
Metric cache <https://github.com/zalando/zmon-metric-cache>
_ Fast special purpose cache for REST API metric data for ZMON's REST metrics/cloud UI
Install a recent Vagrant_ version (at least 1.7.4) and simply do:
.. code-block:: bash
$ vagrant up
Please note that the provisioning process will take some time (~15min) while it downloads the Docker images.
Login with your own GitHub credentials (OAuth redirect).
https://localhost:8443/grafana/
You will be able to create/save dashboards.
KairosDB frontend, i.e. for manually query of metrics:
start.sh
script again manually or use the start-services.sh
script to restart single components. Later one takes parameters like controller
or worker
.Use PIP to install the zmon
executable from PyPI_.
.. code-block:: bash
$ pip3 install --upgrade zmon-cli
Use the ZMON CLI to push/create/update entities (hosts, databases, etc.), check definitions and create optional alerts (also possible via UI).
.. code-block:: bash
$ zmon entities push examples/entities/local-postgresql.yaml
$ zmon entities push examples/entities/local-scheduler-instance.json
Push your first check definition:
.. code-block:: bash
$ zmon check-definitions update examples/check-definitions/zmon-scheduler-rates.yaml
Modify the alert definition to point to the right check id before doing:
.. code-block:: bash
$ zmon alert-definitions update examples/alert-definitions/scheduler-rate-too-low.yaml
.. _Vagrant: https://www.vagrantup.com/ .. _PyPI: https://pypi.python.org/pypi/zmon-cli
If you want to compile everything from source, you can do so with our separate "build-env" Vagrant box:
.. code-block:: bash
$ cd build-env
$ vagrant up
Docker images/scripts used in slightly modified versions are:
Thanks to the original authors!
Copyright 2013-2016 Zalando SE
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.