Commit e1b920a8 authored by Ahmad Sherif's avatar Ahmad Sherif
Browse files

Merge branch 'add-readme' into 'master'

Add documentation for gitlab-monitor

See merge request !15
parents 59c3d8c4 4687a8ee
## Introduction
gitlab-monitor is a [Prometheus Web exporter] that does the following:
1. Collects GitLab production metrics via custom probes defined in a YAML file.
2. Custom probes gather measurements in the form of key/value pairs.
3. For each probe, gitlab-monitor creates an HTTP endpoint `/<probe_name>`
(by default on port 4567) that delivers these metrics to a Prometheus scraper.
A central Prometheus process is configured to poll exporters at a specified
frequency.
### Supported Probes
1. Database
* Dead tuples
* Slow queries
* Blocked queries
1. Git
* git pull/push timings
1. Process
* Age
* Memory usage
[Prometheus Web exporter]: https://prometheus.io/docs/instrumenting/exporters/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment