Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix metric documentation tables #3341

Merged
merged 3 commits into from
Jun 6, 2018
Merged

Fix metric documentation tables #3341

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3985a3b
does this make it work?
hawkowl Jun 5, 2018
cc12808
use the full RST table format
hawkowl Jun 5, 2018
9310982
make them actual rows
hawkowl Jun 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 30 additions & 20 deletions docs/metrics-howto.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,30 +63,40 @@ The duplicated metrics deprecated in Synapse 0.27.0 have been removed.

All time duration-based metrics have been changed to be seconds. This affects:

================================
msec -> sec metrics
================================
python_gc_time
python_twisted_reactor_tick_time
synapse_storage_query_time
synapse_storage_schedule_time
synapse_storage_transaction_time
================================
+----------------------------------+
| msec -> sec metrics |
+==================================+
| python_gc_time |
+----------------------------------+
| python_twisted_reactor_tick_time |
+----------------------------------+
| synapse_storage_query_time |
+----------------------------------+
| synapse_storage_schedule_time |
+----------------------------------+
| synapse_storage_transaction_time |
+----------------------------------+

Several metrics have been changed to be histograms, which sort entries into
buckets and allow better analysis. The following metrics are now histograms:

=========================================
Altered metrics
=========================================
python_gc_time
python_twisted_reactor_pending_calls
python_twisted_reactor_tick_time
synapse_http_server_response_time_seconds
synapse_storage_query_time
synapse_storage_schedule_time
synapse_storage_transaction_time
=========================================
+-------------------------------------------+
| Altered metrics |
+===========================================+
| python_gc_time |
+-------------------------------------------+
| python_twisted_reactor_pending_calls |
+-------------------------------------------+
| python_twisted_reactor_tick_time |
+-------------------------------------------+
| synapse_http_server_response_time_seconds |
+-------------------------------------------+
| synapse_storage_query_time |
+-------------------------------------------+
| synapse_storage_schedule_time |
+-------------------------------------------+
| synapse_storage_transaction_time |
+-------------------------------------------+


Block and response metrics renamed for 0.27.0
Expand Down