diff options
author | Kamil Trzciński <ayufan@ayufan.eu> | 2018-09-04 16:01:34 +0300 |
---|---|---|
committer | Kamil Trzciński <ayufan@ayufan.eu> | 2018-09-04 16:01:34 +0300 |
commit | 9f2a6ca03c9b7bc5e2984bc6a2bf2bf731761784 (patch) | |
tree | dcc59723d11cc3d79bbf679d3c7c0bfca4359bf7 /doc/development/prometheus_metrics.md | |
parent | cf5f50544c3c379474e918fe5e59f3ca3ace15f1 (diff) |
Add development documentation
Diffstat (limited to 'doc/development/prometheus_metrics.md')
-rw-r--r-- | doc/development/prometheus_metrics.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/development/prometheus_metrics.md b/doc/development/prometheus_metrics.md new file mode 100644 index 00000000000..488d344b8cc --- /dev/null +++ b/doc/development/prometheus_metrics.md @@ -0,0 +1,46 @@ +# Working with Prometheus Metrics + +## Adding to the library + +We strive to support the 2-4 most important metrics for each common system service that supports Prometheus. If you are looking for support for a particular exporter which has not yet been added to the library, additions can be made [to the `common_metrics.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/prometheus/common_metrics.yml) file. + +### Query identifier + +The requirement for adding a new metrics is to make each query to have an unique identifier. +Identifier is used to update the metric later when changed. + +```yaml +- group: Response metrics (NGINX Ingress) + metrics: + - title: "Throughput" + y_label: "Requests / Sec" + queries: + - id: response_metrics_nginx_ingress_throughput_status_code + query_range: 'sum(rate(nginx_upstream_responses_total{upstream=~"%{kube_namespace}-%{ci_environment_slug}-.*"}[2m])) by (status_code)' + unit: req / sec + label: Status Code +``` + +### Update existing metrics + +After you add or change existing _common_ metric you have to create a new database migration that will query and update all existing metrics. + +**Note: If a query metric (which is identified by `id:`) is removed it will not be removed from database by default.** +**You might want to add additional database migration that makes a decision what to do with removed one.** +**For example: you might be interested in migrating all dependent data to a different metric.** + +```ruby +class ImportCommonMetrics < ActiveRecord::Migration + require_relative '../importers/common_metrics_importer.rb' + + DOWNTIME = false + + def up + Importers::CommonMetricsImporter.new.execute + end + + def down + # no-op + end +end +``` |