# Prometheus and Grafana

## Monitoring Antidote with Prometheus

Antidote is configured to expose metrics to [Prometheus](https://prometheus.io/) via the [antidote\_stats module](https://github.com/AntidoteDB/antidote_stats).

Follow the steps in the `README` of the `antidote_stats` module to start the required monitoring services:

```bash
cd monitoring
docker-compose up -d
```

This starts a prometheus server and a grafana database. If the containers started with no problems, open `http://localhost:9090/targets` in a web-browser. You will see the targets prometheus is configured to monitor. To change or add additional Antidote nodes, follow the necessesary steps in the README to [add targets to the prometheus configuration](https://github.com/AntidoteDB/antidote_stats).

To shutdown containers: `docker-compose down`

## Grafana GUI

To view the monitoring data of antidote, open the Grafana Dashboard. With default the configuration open the URL `http://localhost:3000` and log in with user `admin` and password `admin`.

The monitoring system provides information for the following metrics: Antidote API, Antidote Ring Structure, Antidote Log Size (disk usage), Memory, I/O, CPU, and Erlang Internals.

### Antidote API

Antidote has client, internal, and inter-dc operations which are monitored separately. Addionally, transactions are tracked.

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKOTge6ti-DlG3C%2Fmon_api.png?generation=1575916825404729\&alt=media)

### Antidote Ring Structure

We use `riak_core` as a main dependency to provide sharding and means of distributing the log. The current state of the ring can be seen in the `Ring State` section and should be checked when setting up the nodes for the first time or look for outages of nodes in a DC.

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKQLH1u9vaPxzMq%2Fmon_ring.png?generation=1575916825385705\&alt=media)

### Antidote Log Size

To know how much disk space Antidote is using, log sizes are monitored.

To check for unusually active vnodes, the log sizes of every vnode is checked, too.

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKSQiHcyKAfF5Yh%2Fmon_disk.png?generation=1575916825291132\&alt=media)

### Memory, I/O, CPU, Erlang Internals

Additional host metrics are provided. These include memory usage, network I/O, CPU usage, and Erlang internal metrics.

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKU_ILSuhqnfCMQ%2Fmon_memory.png?generation=1575916825400378\&alt=media)

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKWJc5KJ2I2i3bC%2Fmon_io.png?generation=1575916825399237\&alt=media)

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaKYK6EUl8RqUDNv%2Fmon_cpu.png?generation=1575916825441923\&alt=media)

![](https://2797393517-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LFUQ59GuGxETl1dvZ1y%2F-Lvfx_9N30-an2GNNdfU%2F-LvfxaK_x_9_3Ca3JvNA%2Fmon_internals.png?generation=1575916825495470\&alt=media)

## Adding Metrics to Antidote

To add a metric collection call to the Antidote source code, use the macro `?STATS(term)`, where `term` is the term to send to the stat collector process. The actual Prometheus processing is done in the `antidote_stats` module and every term should be implemented there. Unknown terms which are not yet supported are logged during runtime, but will not crash the system.