Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Matrix
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Operate
Environments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TeDomum
Matrix
Commits
8c784142
Commit
8c784142
authored
9 years ago
by
Paul "LeoNerd" Evans
Browse files
Options
Downloads
Patches
Plain Diff
Formatting / wording fixes to metrics doc
parent
6c994913
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/metrics-howto.rst
+13
-12
13 additions, 12 deletions
docs/metrics-howto.rst
with
13 additions
and
12 deletions
docs/metrics-howto.rst
+
13
−
12
View file @
8c784142
How to monitor Synapse metrics using Prometheus
How to monitor Synapse metrics using Prometheus
===============================================
===============================================
1:
i
nstall prometheus:
1:
I
nstall prometheus:
Follow instructions at http://prometheus.io/docs/introduction/install/
Follow instructions at http://prometheus.io/docs/introduction/install/
2:
e
nable synapse metrics:
2:
E
nable synapse metrics:
Simply setting a (local) port number will enable it. Pick a port.
Simply setting a (local) port number will enable it. Pick a port.
prometheus itself defaults to 9090, so starting just above that for
prometheus itself defaults to 9090, so starting just above that for
locally monitored services seems reasonable. E.g. 9092:
locally monitored services seems reasonable. E.g. 9092:
...
@@ -15,17 +15,18 @@ How to monitor Synapse metrics using Prometheus
...
@@ -15,17 +15,18 @@ How to monitor Synapse metrics using Prometheus
Restart synapse
Restart synapse
3:
c
heck out synapse-prometheus-config
3:
C
heck out synapse-prometheus-config
https://github.com/matrix-org/synapse-prometheus-config
https://github.com/matrix-org/synapse-prometheus-config
4: arrange for synapse.html to appear in prometheus's "consoles"
4: Add `synapse.html` and `synapse.rules`
directory - symlink might be easiest to ensure `git pull` keeps it
The `.html` file needs to appear in prometheus's "consoles" directory, and
updated.
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: arrange for synapse.rules to be invoked from the main
5: Add a prometheus target for synapse
prometheus.conf and add a synapse target. This is easiest if
This is easiest if prometheus runs on the same machine as synapse, as it can
prometheus runs on the same machine as synapse, as it can then just
then just use localhost::
use localhost::
global: {
global: {
rule_file: "synapse.rules"
rule_file: "synapse.rules"
...
@@ -39,11 +40,11 @@ How to monitor Synapse metrics using Prometheus
...
@@ -39,11 +40,11 @@ How to monitor Synapse metrics using Prometheus
}
}
}
}
6:
s
tart prometheus::
6:
S
tart prometheus::
./prometheus -config.file=prometheus.conf
./prometheus -config.file=prometheus.conf
7:
w
ait a few seconds for it to start and perform the first scrape,
7:
W
ait a few seconds for it to start and perform the first scrape,
then visit the console:
then visit the console:
http://server-where-prometheus-runs:9090/consoles/synapse.html
http://server-where-prometheus-runs:9090/consoles/synapse.html
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment