From 74effdcfcd9faadce07eaabfe69857492d8723b7 Mon Sep 17 00:00:00 2001 From: Thong Kuah Date: Tue, 3 Sep 2019 14:24:26 +0000 Subject: Development docs: how to add Prometheus metrics This documents the various knowledge needed to add new GitLab self-monitoring Prometheus metrics. --- doc/development/prometheus_metrics.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/development/prometheus_metrics.md b/doc/development/prometheus_metrics.md index 576601372a3..2a34851d21c 100644 --- a/doc/development/prometheus_metrics.md +++ b/doc/development/prometheus_metrics.md @@ -44,3 +44,26 @@ class ImportCommonMetrics < ActiveRecord::Migration[4.2] end end ``` + +## GitLab Prometheus metrics + +GitLab provides [Prometheus metrics](../administration/monitoring/prometheus/gitlab_metrics.md) +to monitor itself. + +### Adding a new metric + +This section describes how to add new metrics for self-monitoring +([example](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/15440)). + +1. Select the [type of metric](https://gitlab.com/gitlab-org/prometheus-client-mmap#metrics): + + - `Gitlab::Metrics.counter` + - `Gitlab::Metrics.gauge` + - `Gitlab::Metrics.histogram` + - `Gitlab::Metrics.summary` + +1. Select the appropriate name for your metric. Refer to the guidelines + for [Prometheus metric names](https://prometheus.io/docs/practices/naming/#metric-names). +1. Update the list of [GitLab Prometheus metrics](../administration/monitoring/prometheus/gitlab_metrics.md). +1. Trigger the relevant page/code that will record the new metric. +1. Check that the new metric appears at `/-/metrics`. -- cgit v1.2.1