2018-11-20 09:01:13 -05:00
|
|
|
# Prometheus Metrics library
|
|
|
|
|
|
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8935) in GitLab 9.0.
|
|
|
|
|
|
|
|
|
|
GitLab offers automatic detection of select [Prometheus exporters](https://prometheus.io/docs/instrumenting/exporters/).
|
|
|
|
|
|
|
|
|
|
## Exporters
|
|
|
|
|
|
|
|
|
|
Currently supported exporters are:
|
|
|
|
|
|
|
|
|
|
- [Kubernetes](kubernetes.md)
|
|
|
|
|
- [NGINX](nginx.md)
|
2019-01-18 09:15:32 -05:00
|
|
|
- [NGINX Ingress Controller 0.9.0-0.15.x](nginx_ingress_vts.md)
|
|
|
|
|
- [NGINX Ingress Controller 0.16.0+](nginx_ingress.md)
|
2018-11-20 09:01:13 -05:00
|
|
|
- [HAProxy](haproxy.md)
|
|
|
|
|
- [Amazon Cloud Watch](cloudwatch.md)
|
|
|
|
|
|
|
|
|
|
We have tried to surface the most important metrics for each exporter, and will
|
|
|
|
|
be continuing to add support for additional exporters in future releases. If you
|
|
|
|
|
would like to add support for other official exporters, contributions are welcome.
|
|
|
|
|
|
|
|
|
|
## Identifying Environments
|
|
|
|
|
|
|
|
|
|
GitLab retrieves performance data from the configured Prometheus server, and
|
|
|
|
|
attempts to identifying the presence of known metrics. Once identified, GitLab
|
|
|
|
|
then needs to be able to map the data to a particular environment.
|
|
|
|
|
|
|
|
|
|
In order to isolate and only display relevant metrics for a given environment,
|
|
|
|
|
GitLab needs a method to detect which labels are associated. To do that,
|
|
|
|
|
GitLab uses the defined queries and fills in the environment specific variables.
|
|
|
|
|
Typically this involves looking for the
|
2019-01-30 05:20:50 -05:00
|
|
|
[`$CI_ENVIRONMENT_SLUG`](../../../../ci/variables/README.md#predefined-environment-variables),
|
2018-11-20 09:01:13 -05:00
|
|
|
but may also include other information such as the project's Kubernetes namespace.
|
|
|
|
|
Each search query is defined in the [exporter specific documentation](#exporters).
|
