Commit 0f993f77 authored by Pablo Carranza's avatar Pablo Carranza
Browse files

Merge branch 'rs-readme' into 'master'

Minor README cleanup

See merge request !46
parents aaf5c39e 36e5abd2
......@@ -2,8 +2,8 @@
gitlab-monitor is a [Prometheus Web exporter] that does the following:
1. Collects GitLab production metrics via custom probes defined in a YAML file
(config format is explained in [config/gitlab-monitor.yml.example]).
1. Collects GitLab production metrics via custom probes defined in a [YAML
configuration file](config/gitlab-monitor.yml.example).
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 9168) that delivers these metrics to a Prometheus scraper.
......@@ -32,16 +32,19 @@ frequency.
### Setup with GitLab Development Kit
gitlab-monitor can be setup with the [GitLab Development Kit] for development.
When using the CLI, you'll need to set the --db-conn flag to connect to the PG
instance in your GDK folder. Like:
When using the gitlab-monitor CLI, you'll need to set the `--db-conn` flag to
connect to the PostgreSQL instance in your GDK folder. For example:
`bin/gitlab-mon row-counts --db-conn="dbname=gitlabhq_development host=/Users/<user>/gitlab-development-kit/postgresql"`
```
bin/gitlab-mon row-counts --db-conn="dbname=gitlabhq_development host=/Users/<user>/gitlab-development-kit/postgresql"
```
When serving the pages on localhost, you'll need to edit the config yaml. An
example can be found under `config/gitlab-monitor.yml.example`. For each probe
which has to connect to the database, set the connection_string to:
`dbname=gitlabhq_development host=/Users/<user>/gitlab-development-kit/postgresq`
When serving the pages on `localhost`, you'll need to edit the YAML
configuration file. An example can be found under
[`config/gitlab-monitor.yml.example`](config/gitlab-monitor.yml.example). For
each probe that has to connect to the database, set the `connection_string` to
`dbname=gitlabhq_development
host=/Users/<user>/gitlab-development-kit/postgresql`
[Prometheus Web exporter]: https://prometheus.io/docs/instrumenting/exporters/
[GitLab Development Kit]: https://gitlab.com/gitlab-org/gitlab-development-kit
[config/gitlab-monitor.yml.example]: https://gitlab.com/gitlab-org/gitlab-monitor/blob/master/config/gitlab-monitor.yml.example
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