summary refs log tree commit diff
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <paul@matrix.org>2016-10-28 13:58:27 +0100
committerPaul "LeoNerd" Evans <paul@matrix.org>2016-10-28 13:58:27 +0100
commit159434a13301f7838d2ca8d26e16a856216a318a (patch)
treeb6238909d8debf737fddc36eecdde6622e432e2f
parentMerge pull request #1184 from matrix-org/paul/metrics (diff)
downloadsynapse-159434a13301f7838d2ca8d26e16a856216a318a.tar.xz
Remove long-deprecated instructions about promethesus console; also fix for modern config file format
-rw-r--r--docs/metrics-howto.rst41
1 files changed, 8 insertions, 33 deletions
diff --git a/docs/metrics-howto.rst b/docs/metrics-howto.rst

index c1f5ae2174..9f5f1767e4 100644 --- a/docs/metrics-howto.rst +++ b/docs/metrics-howto.rst
@@ -15,36 +15,11 @@ How to monitor Synapse metrics using Prometheus Restart synapse -3: Check out synapse-prometheus-config - https://github.com/matrix-org/synapse-prometheus-config - -4: Add ``synapse.html`` and ``synapse.rules`` - The ``.html`` file needs to appear in prometheus's ``consoles`` directory, - and the ``.rules`` file needs to be invoked somewhere in the main config - file. A symlink to each from the git checkout into the prometheus directory - might be easiest to ensure ``git pull`` keeps it updated. - -5: Add a prometheus target for synapse - This is easiest if prometheus runs on the same machine as synapse, as it can - then just use localhost:: - - global: { - rule_file: "synapse.rules" - } - - job: { - name: "synapse" - - target_group: { - target: "http://localhost:9092/" - } - } - -6: Start prometheus:: - - ./prometheus -config.file=prometheus.conf - -7: Wait a few seconds for it to start and perform the first scrape, - then visit the console: - - http://server-where-prometheus-runs:9090/consoles/synapse.html +3: Add a prometheus target for synapse. It needs to set the ``metrics_path`` + to a non-default value:: + + - job_name: "synapse" + metrics_path: "/_synapse/metrics" + static_configs: + - targets: + "my.server.here:9092"