Commit Graph

96 Commits

Author SHA1 Message Date
Suguru Hirahara
c291d53d3e Update docs/configuring-playbook-prometheus-grafana.md: warning message (#4159) 2025-03-09 18:27:49 +02:00
Suguru Hirahara
825cef5f04 Update docs/configuring-playbook-prometheus-grafana.md: add a copyright header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-03-05 00:26:43 +09:00
Suguru Hirahara
471944a72c Update docs/configuring-playbook-prometheus-grafana.md: remove instructions for setting up enabling and exposing metrics for MMR in favor of the one on the document for it
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:37:24 +09:00
Suguru Hirahara
210a431c82 Update docs for metrics of Hookshot
As the document for Hookshot has the section for instrucion about configuring its metrics, this commit moves the instruction to it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:35:42 +09:00
Suguru Hirahara
88e946173f Update docs/configuring-playbook-prometheus-grafana.md: move descriptions about configuring Synapse metrics out of the table
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:35:21 +09:00
Suguru Hirahara
968129398f Update docs/configuring-playbook-prometheus-grafana.md: remove duplicated instruction to refer matrix_metrics_exposure_http_basic_auth_users
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:35:03 +09:00
Suguru Hirahara
bfe8694795 Update docs/configuring-playbook-prometheus-grafana.md: add the instruction about setting dedicated credentials to each endpoint
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:34:53 +09:00
Suguru Hirahara
da8e446e02 Update docs/configuring-playbook-prometheus-grafana.md: move some descriptions out of the table
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:34:42 +09:00
Suguru Hirahara
64d9340f70 Update docs/configuring-playbook-prometheus-grafana.md: add another example for exposing metrics with dedicated credentials for matrix-media-repo
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:33:46 +09:00
Suguru Hirahara
16bb022390 Update docs/configuring-playbook-prometheus-grafana.md: create a section for exposing metrics of other services/roles focusing on Hookshot
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 20:33:36 +09:00
Suguru Hirahara
042f587ba4 Update docs/configuring-playbook-prometheus-grafana.md: add an entry for matrix_media_repo_metrics_proxying_enabled
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 15:58:41 +09:00
Suguru Hirahara
dbab4a5329 Update docs/configuring-playbook-prometheus-grafana.md: move down the entries for exposing metrics of Synapse
The metrics of Synapse belongs to the category of individual services not introduced on the document.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 15:54:43 +09:00
Suguru Hirahara
833c73de56 Update docs/configuring-playbook-prometheus-grafana.md: remove the table with one entry
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 15:54:29 +09:00
Suguru Hirahara
8cbeb3d7dd Update docs/configuring-playbook-prometheus-grafana.md: create a section for the Node Exporter
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 15:54:17 +09:00
Suguru Hirahara
7c81c148cf Update docs for Prometheus: move other relevant instructions
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 02:00:36 +09:00
Suguru Hirahara
2180c58e62 Update docs for Prometheus: move the description for Docker image compatibility
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 02:00:19 +09:00
Suguru Hirahara
7907a649ee Update docs/configuring-playbook-prometheus-grafana.md: remove variables for Sliding Sync proxy metrics
The component has been deprecated and it is not really sensible to keep those entries.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 02:00:06 +09:00
Suguru Hirahara
be02f12fed Update docs/configuring-playbook-prometheus-grafana.md: fix the variables name
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 01:59:57 +09:00
Suguru Hirahara
e4d3b00927 Partially merge docs for prometheus-nginx-log-exporter to docs/configuring-playbook-prometheus-grafana.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 01:59:43 +09:00
Suguru Hirahara
2df8793a9c Update docs/configuring-playbook-prometheus-grafana.md: add two entries for journalctl (matrix-prometheus-node-exporter and matrix-prometheus-postgres-exporter)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:24:41 +09:00
Suguru Hirahara
a67745b1fc Remove the table for variables about the Postgres Server Exporter
As prometheus_postgres_exporter_container_labels_traefik_enabled is explained below, it is sensible to remove this duplicated entry in favor of it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:59 +09:00
Suguru Hirahara
f4bc9c98ed Update docs/configuring-playbook-prometheus-grafana.md: remove the note about the component disabled by default
It is not common to add a note about the component disabled by default.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:49 +09:00
Suguru Hirahara
a691306614 Update docs/configuring-playbook-prometheus-grafana.md: create sections for adjusting configurations of Prometheus and Grafanato decrease the section level
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:44 +09:00
Suguru Hirahara
00f3eda4dc Update docs for Prometheus: adopt the common warning message
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:39 +09:00
Suguru Hirahara
152031bbae Update docs/configuring-playbook-prometheus-grafana.md: move the security notice to the top
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:35 +09:00
Suguru Hirahara
4ecf6c2ba3 Update docs/configuring-playbook-prometheus-grafana.md: fix capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:30 +09:00
Suguru Hirahara
8b7b7732ef Update docs/configuring-playbook-prometheus-grafana.md: move variables for setting username and password of Postgres exporter to the YAML block above
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:23 +09:00
Suguru Hirahara
505ff58292 Update docs/configuring-playbook-prometheus-grafana.md: tidy the section for Postgres exporter
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:11:58 +09:00
Suguru Hirahara
07cca8f4b4 Merge the document for instruction about metrics for Postgres to docs/configuring-playbook-prometheus-grafana.md to improve maintainability
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:05:25 +09:00
Suguru Hirahara
747e8ad589 Update docs/configuring-playbook-prometheus-grafana.md: switch the position of "Grafana" and "Prometheus" in the first sentence
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:04:49 +09:00
Suguru Hirahara
3d4c9bd0e9 Update docs/configuring-playbook-prometheus-grafana.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-02-09 13:35:58 +09:00
Suguru Hirahara
d7eb3f2765 Update docs/configuring-playbook-prometheus-grafana.md: move up the note about creating a CNAME record
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:55 +09:00
Suguru Hirahara
5e2bc80e6b Update docs/configuring-playbook-prometheus-grafana.md: move down the optional configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:40 +09:00
Suguru Hirahara
2163daead2 Update docs/configuring-playbook-prometheus-grafana.md: move the comments out of the YAML block
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:29 +09:00
Suguru Hirahara
0154bc9931 Update docs/configuring-playbook-prometheus-grafana.md: move descriptions specific to each component to its subsection
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:30:12 +09:00
Suguru Hirahara
598cec4257 Update docs/configuring-playbook-prometheus-grafana.md: add the note label
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:30:03 +09:00
Suguru Hirahara
35b88ced00 Update docs/configuring-playbook-prometheus-grafana.md: split the table for the variables into two
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:29:52 +09:00
Suguru Hirahara
781f6d68a7 Update docs/configuring-playbook-prometheus-grafana.md: comment out grafana_anonymous_access as it is disabled by default
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:29:41 +09:00
Suguru Hirahara
8ecc83f2a9 Update docs/configuring-playbook-prometheus-grafana.md: copy the comments from the main.yml file
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:07:29 +09:00
Suguru Hirahara
15e889c21a Update docs/configuring-playbook-prometheus-grafana.md: comment out lines for configs disabled by default
- Replace the comments for them

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:07:06 +09:00
Suguru Hirahara
8d52dc985a Update docs/configuring-playbook-prometheus-grafana.md: add sections for Prometheus and Grafana
The introductions are copied from their configuration files.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:06:41 +09:00
Suguru Hirahara
19f17bb729 Update docs/configuring-playbook-prometheus-grafana.md: use the common placeholders
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:06:08 +09:00
Suguru Hirahara
1e7dba3737 Update docs/configuring-playbook-prometheus-grafana.md: move up the section for explanations about the variables
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:05:45 +09:00
Suguru Hirahara
1ddab52294 Update docs/configuring-playbook-prometheus-grafana.md: add periods to sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 23:33:29 +09:00
Suguru Hirahara
63a6d7e73a Update docs/configuring-playbook-prometheus-grafana.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 16:03:40 +09:00
Suguru Hirahara
049769514d Update docs/configuring-playbook-prometheus-grafana.md: add the common section "Extending the configuration" for Prometheus
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 03:35:46 +09:00
Suguru Hirahara
b1856f0a22 Fix capitalization: nginx
It should be either NGINX or nginx, and this commit converts the string in uppercase to lowercase.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-05 13:11:04 +09:00
Suguru Hirahara
04b32af0c1 Update docs for DNS settings etc. (#3936)
* Update docs for DNS settings of the services which need its CNAME record by default

- Buscarron
- Go-NEB; fix a line on the instruction as well
- wsproxy
- Cinny
- Element Web
- Hydrogen
- SchildiChat Web
- Dimension
- Etherpad
- Jitsi
- ntfy
- Grafana
- rageshake
- Sygnal

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings of the services which do not need its CNAME record by default

- matrix-alertmanager-receiver
- Honoroit
- maubot
- Heisenbridge
- Cactus Comments
- Matrix Authentication Service
- matrix-registration
- Sliding Sync proxy
- Synapse Admin
- synapse-usage-exporter

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: ma1sd

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: Email2Matrix

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: Postmoogle

Remove the table from configuring-dns.md altogether

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Cinny and Dimension: adopt the common note

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: add "Note" to the line on using Cloudflare DNS

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-15 09:22:00 +02:00
Suguru Hirahara
61ace3a063 Edit lines for vars.yml (#3933)
* Simplify paths to vars.yml if referred multiple times

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Fix the filename: vars.yaml → vars.yml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-12 15:31:19 +02:00
Suguru Hirahara
e8548e0016 Mention how much "just install-all" is faster than "just setup-all"
This way, the "installing" sections would cover from beginners to advanced (professional) readers.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-02 20:00:58 +09:00