From 1d4d518b50edec020faad41cc857edbf75b47eda Mon Sep 17 00:00:00 2001
From: "Paul \"LeoNerd\" Evans" <paul@matrix.org>
Date: Mon, 31 Oct 2016 15:06:52 +0000
Subject: [PATCH] Add details of renamed metrics
---
docs/metrics-howto.rst | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/docs/metrics-howto.rst b/docs/metrics-howto.rst
index 9f5f1767e4..7aa4757a35 100644
--- a/docs/metrics-howto.rst
+++ b/docs/metrics-howto.rst
@@ -23,3 +23,37 @@ How to monitor Synapse metrics using Prometheus
static_configs:
- targets:
"my.server.here:9092"
+
+Standard Metric Names
+---------------------
+
+As of synapse version 0.18.2, the format of the process-wide metrics has been
+changed to fit prometheus standard naming conventions. Additionally the units
+have been changed to seconds, from miliseconds.
+
+================================== =============================
+New name Old name
+---------------------------------- -----------------------------
+process_cpu_user_seconds_total process_resource_utime / 1000
+process_cpu_system_seconds_total process_resource_stime / 1000
+process_open_fds (no 'type' label) process_fds
+================================== =============================
+
+The python-specific counts of garbage collector performance have been renamed.
+
+=========================== ======================
+New name Old name
+--------------------------- ----------------------
+python_gc_time reactor_gc_time
+python_gc_unreachable_total reactor_gc_unreachable
+python_gc_counts reactor_gc_counts
+=========================== ======================
+
+The twisted-specific reactor metrics have been renamed.
+
+==================================== =================
+New name Old name
+------------------------------------ -----------------
+python_twisted_reactor_pending_calls reactor_tick_time
+python_twisted_reactor_tick_time reactor_tick_time
+==================================== =================
--
GitLab