riak_exporter/README.md

57 lines
1.9 KiB
Markdown
Raw Normal View History

# Riak KV Metrics Exporter
Prometheus exporter for Riak metrics.
Supports Riak KV 2.x
It works simply by fetching available Riak /stats enpoint from the node, parsing its metrics
and converting to format that Prometheus understands.
## Installing, configuring, and running
You can install exporter on the same node as Riak KV instance, or on separate machine.
To run, you must have ``Python`` and ``pip`` installed (Python 2 and 3 supported).
To install with ``pip``:
```
pip install riak_exporter
```
Then just:
```
riak-exporter --address=0.0.0.0 --port=8097 --riak=http://localhost:8098/stats --endpoint=/metrics
```
2016-06-02 09:11:46 +00:00
All arguments are optional.
2016-08-09 12:41:59 +00:00
## Docker
To run the container, simply use the below:
`docker run -p 8097:8097 infinityworks/prometheus-riak-exporter:latest`
To run it with the optional arguments
`docker run -p 8097:8097 infinityworks/prometheus-riak-exporter:latest --address=0.0.0.0 --port=8097 --riak=http://localhost:8098/stats --endpoint=/metrics`
Example Docker Compose
```
riak-exporter:
command: --address=0.0.0.0 --port=8097 --riak=http://localhost:8098/stats --endpoint=/metrics
image: infinityworks/prometheus-riak-exporter:latest
ports:
- "8097:8097"
```
## Daemonizing
Application intentionally does not daemonize itself. You are free to use your favorite method on your distribution.
## Status
Currently, this app is in early stages of development. Nothing more that simple ``/stats`` endpoint translation
2016-06-02 09:12:23 +00:00
is here. More features will (or will not follows) as long as I'll need them in my production setup.
2016-09-01 12:11:36 +00:00
## Metrics
[![](https://images.microbadger.com/badges/image/infinityworks/riak_exporter.svg)](http://microbadger.com/images/infinityworks/riak_exporter "Get your own image badge on microbadger.com") [![](https://images.microbadger.com/badges/version/infinityworks/riak_exporter.svg)](http://microbadger.com/images/infinityworks/riak_exporter "Get your own version badge on microbadger.com")