Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacob Vosmaer <jacob@gitlab.com>2019-07-10 19:31:02 +0300
committerJohn Cai <jcai@gitlab.com>2019-07-10 19:31:02 +0300
commitc0264bd81cd822c0fe9318a90d3e1362f38be72a (patch)
tree8225bc4f67d4dfe64032254ae40fcabf5bcdc715
parente6b278d5b08aae16d83dc252d58452ea11173188 (diff)
Refer to prometheus best practices in STYLE.md
-rw-r--r--STYLE.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/STYLE.md b/STYLE.md
index bc0bfc005..aaafb308e 100644
--- a/STYLE.md
+++ b/STYLE.md
@@ -124,3 +124,11 @@ As a team we are currently divided on which style to prefer so we are
going to allow both. In areas of the code where there is a clear
pattern, please stick with the pattern. For example, almost all our
service tests are white box.
+
+## Prometheus metrics
+
+Prometheus is a great tool to collect data about how our code behaves in
+production. When adding new Prometheus metrics, please follow the [best
+practices](https://prometheus.io/docs/practices/naming/) and be aware of
+the
+[gotchas](https://prometheus.io/docs/practices/instrumentation/#things-to-watch-out-for).