From 1e7dba3737dc1ff0951cf25fc375499219822d5e Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 3 Feb 2025 02:06:25 +0900 Subject: [PATCH 01/13] Update docs/configuring-playbook-prometheus-grafana.md: move up the section for explanations about the variables Signed-off-by: Suguru Hirahara --- ...configuring-playbook-prometheus-grafana.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index ca8b6a082..9fb3bf5b9 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -38,6 +38,18 @@ grafana_default_admin_password: "some_strong_password_chosen_by_you" The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. +### What does it do? + +Name | Description +-----|---------- +`prometheus_enabled`|[Prometheus](https://prometheus.io) is a time series database. It holds all the data we're going to talk about. +`prometheus_node_exporter_enabled`|[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures. +`prometheus_postgres_exporter_enabled`|[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus. +`matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. +`grafana_enabled`|[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in. +`grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. +`grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. If you feel this is insecure and you want to change it beforehand, you can do that here. + ### Adjusting the Grafana URL (optional) By tweaking the `grafana_hostname` variable, you can easily make the service available at a **different hostname** than the default one. @@ -74,18 +86,6 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju `just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. -## What does it do? - -Name | Description ------|---------- -`prometheus_enabled`|[Prometheus](https://prometheus.io) is a time series database. It holds all the data we're going to talk about. -`prometheus_node_exporter_enabled`|[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures. -`prometheus_postgres_exporter_enabled`|[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus. -`matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. -`grafana_enabled`|[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in. -`grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. -`grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. If you feel this is insecure and you want to change it beforehand, you can do that here. - ## Security and privacy Metrics and resulting graphs can contain a lot of information. This includes system specs but also usage patterns. This applies especially to small personal/family scale homeservers. Someone might be able to figure out when you wake up and go to sleep by looking at the graphs over time. Think about this before enabling anonymous access. And you should really not forget to change your Grafana password. From 19f17bb729496a935a091c3c796b20dcad8ce944 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 3 Feb 2025 15:35:08 +0900 Subject: [PATCH 02/13] Update docs/configuring-playbook-prometheus-grafana.md: use the common placeholders Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 9fb3bf5b9..5e7c08dbc 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -30,10 +30,10 @@ grafana_anonymous_access: false # This has no relation to your Matrix user ID. It can be any username you'd like. # Changing the username subsequently won't work. -grafana_default_admin_user: "some_username_chosen_by_you" +grafana_default_admin_user: "USERNAME_HERE" # Changing the password subsequently won't work. -grafana_default_admin_password: "some_strong_password_chosen_by_you" +grafana_default_admin_password: "PASSWORD_HERE" ``` The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. From 8d52dc985a9ce891abda7535272653dff869c48f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 01:42:41 +0900 Subject: [PATCH 03/13] 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 --- docs/configuring-playbook-prometheus-grafana.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 5e7c08dbc..3b2f5514d 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -10,7 +10,9 @@ When setting, replace `example.com` with your own. ## Adjusting the playbook configuration -To enable Grafana and/or Prometheus, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +### Configure Prometheus + +Prometheus is an open-source systems monitoring and alerting toolkit. To enable it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml prometheus_enabled: true @@ -23,7 +25,13 @@ prometheus_postgres_exporter_enabled: true # You can remove this, if unnecessary. matrix_prometheus_nginxlog_exporter_enabled: true +``` +### Configure Grafana + +Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file: + +```yaml grafana_enabled: true grafana_anonymous_access: false From 15e889c21a16ccad2da3dbc922c1ebe6fb1b90f6 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 02:20:04 +0900 Subject: [PATCH 04/13] 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 --- docs/configuring-playbook-prometheus-grafana.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 3b2f5514d..d5a3d2953 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -17,14 +17,14 @@ Prometheus is an open-source systems monitoring and alerting toolkit. To enable ```yaml prometheus_enabled: true -# You can remove this, if unnecessary. -prometheus_node_exporter_enabled: true +# Uncomment to enable Node Exporter. +# prometheus_node_exporter_enabled: true -# You can remove this, if unnecessary. -prometheus_postgres_exporter_enabled: true +# Uncomment to enable Postgres Exporter. +# prometheus_postgres_exporter_enabled: true -# You can remove this, if unnecessary. -matrix_prometheus_nginxlog_exporter_enabled: true +# Uncomment to enable nginx Log Exporter. +# matrix_prometheus_nginxlog_exporter_enabled: true ``` ### Configure Grafana From 8ecc83f2a94213077cc59427c1d2731458867dce Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 03:21:39 +0900 Subject: [PATCH 05/13] Update docs/configuring-playbook-prometheus-grafana.md: copy the comments from the main.yml file Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index d5a3d2953..3a07a9a5c 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -34,6 +34,7 @@ Grafana is an open source visualization and analytics software. To enable it, ad ```yaml grafana_enabled: true +# Allow viewing Grafana without logging in. grafana_anonymous_access: false # This has no relation to your Matrix user ID. It can be any username you'd like. @@ -56,7 +57,7 @@ Name | Description `matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. `grafana_enabled`|[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in. `grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. -`grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. If you feel this is insecure and you want to change it beforehand, you can do that here. +`grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. You are asked to change the credentials on first login. If you feel this is insecure and you want to change them beforehand, you can do that here. ### Adjusting the Grafana URL (optional) From 781f6d68a756222509477e4851692d9813cb5c68 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 03:25:36 +0900 Subject: [PATCH 06/13] Update docs/configuring-playbook-prometheus-grafana.md: comment out grafana_anonymous_access as it is disabled by default Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 3a07a9a5c..1e607b62c 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -34,8 +34,8 @@ Grafana is an open source visualization and analytics software. To enable it, ad ```yaml grafana_enabled: true -# Allow viewing Grafana without logging in. -grafana_anonymous_access: false +# Uncomment to allow viewing Grafana without logging in. +# grafana_anonymous_access: true # This has no relation to your Matrix user ID. It can be any username you'd like. # Changing the username subsequently won't work. From 35b88ced00ff816dd5007bda4dd9ac03972d4762 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 02:21:12 +0900 Subject: [PATCH 07/13] Update docs/configuring-playbook-prometheus-grafana.md: split the table for the variables into two Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 1e607b62c..a579fc4ec 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -27,6 +27,15 @@ prometheus_enabled: true # matrix_prometheus_nginxlog_exporter_enabled: true ``` +Name | Description +-----|---------- +`prometheus_enabled`|[Prometheus](https://prometheus.io) is a time series database. It holds all the data we're going to talk about. +`prometheus_node_exporter_enabled`|[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures. +`prometheus_postgres_exporter_enabled`|[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus. +`matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. + +The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. + ### Configure Grafana Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file: @@ -45,16 +54,8 @@ grafana_default_admin_user: "USERNAME_HERE" grafana_default_admin_password: "PASSWORD_HERE" ``` -The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. - -### What does it do? - Name | Description -----|---------- -`prometheus_enabled`|[Prometheus](https://prometheus.io) is a time series database. It holds all the data we're going to talk about. -`prometheus_node_exporter_enabled`|[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures. -`prometheus_postgres_exporter_enabled`|[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus. -`matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. `grafana_enabled`|[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in. `grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. `grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. You are asked to change the credentials on first login. If you feel this is insecure and you want to change them beforehand, you can do that here. From 598cec4257325535fdc7230ee369028fb9f779bb Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 02:48:45 +0900 Subject: [PATCH 08/13] Update docs/configuring-playbook-prometheus-grafana.md: add the note label Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index a579fc4ec..418758cf4 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -34,7 +34,7 @@ Name | Description `prometheus_postgres_exporter_enabled`|[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus. `matrix_prometheus_nginxlog_exporter_enabled`|[nginx Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose nginx logs to Prometheus. -The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. +**Note**: the retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. ### Configure Grafana From 0154bc9931d8d9f3a52a365126a3bd510e244017 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 13:46:43 +0900 Subject: [PATCH 09/13] Update docs/configuring-playbook-prometheus-grafana.md: move descriptions specific to each component to its subsection Signed-off-by: Suguru Hirahara --- .../configuring-playbook-prometheus-grafana.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 418758cf4..d3ea84f38 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -36,6 +36,14 @@ Name | Description **Note**: the retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically. +#### Extending the configuration + +There are some additional things you may wish to configure about Prometheus. + +Take a look at: + +- [Prometheus role](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `prometheus_configuration_extension_yaml` variable + ### Configure Grafana Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file: @@ -60,7 +68,7 @@ Name | Description `grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. `grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. You are asked to change the credentials on first login. If you feel this is insecure and you want to change them beforehand, you can do that here. -### Adjusting the Grafana URL (optional) +#### Adjusting the Grafana URL (optional) By tweaking the `grafana_hostname` variable, you can easily make the service available at a **different hostname** than the default one. @@ -75,14 +83,6 @@ After changing the domain, **you may need to adjust your DNS** records to point **Note**: It is possible to install Prometheus without installing Grafana. This case it is not required to create the CNAME record. -### Extending the configuration - -There are some additional things you may wish to configure about Prometheus. - -Take a look at: - -- [Prometheus role](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `prometheus_configuration_extension_yaml` variable - ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: From 2163daead26389562384da339295958841be0fb0 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 23:48:00 +0900 Subject: [PATCH 10/13] Update docs/configuring-playbook-prometheus-grafana.md: move the comments out of the YAML block Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index d3ea84f38..13da39f81 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -46,7 +46,11 @@ Take a look at: ### Configure Grafana -Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file: +Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file. Make sure to replace `USERNAME_HERE` and `PASSWORD_HERE`. + +**Notes**: +- `grafana_default_admin_user` has nothing to do with your Matrix user ID. It can be any string you'd like. +- Changing the username/password subsequently won't work. ```yaml grafana_enabled: true @@ -54,11 +58,7 @@ grafana_enabled: true # Uncomment to allow viewing Grafana without logging in. # grafana_anonymous_access: true -# This has no relation to your Matrix user ID. It can be any username you'd like. -# Changing the username subsequently won't work. grafana_default_admin_user: "USERNAME_HERE" - -# Changing the password subsequently won't work. grafana_default_admin_password: "PASSWORD_HERE" ``` From 5e2bc80e6b5d5aae3bac3448a9312264736a7a51 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 23:49:02 +0900 Subject: [PATCH 11/13] Update docs/configuring-playbook-prometheus-grafana.md: move down the optional configuration Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 13da39f81..e02270d7a 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -55,18 +55,18 @@ Grafana is an open source visualization and analytics software. To enable it, ad ```yaml grafana_enabled: true -# Uncomment to allow viewing Grafana without logging in. -# grafana_anonymous_access: true - grafana_default_admin_user: "USERNAME_HERE" grafana_default_admin_password: "PASSWORD_HERE" + +# Uncomment to allow viewing Grafana without logging in. +# grafana_anonymous_access: true ``` Name | Description -----|---------- `grafana_enabled`|[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in. -`grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. `grafana_default_admin_user`
`grafana_default_admin_password`|By default Grafana creates a user with `admin` as the username and password. You are asked to change the credentials on first login. If you feel this is insecure and you want to change them beforehand, you can do that here. +`grafana_anonymous_access`|By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option. #### Adjusting the Grafana URL (optional) From d7eb3f27650c354eaa0a4b9f766930593435a9f5 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 8 Feb 2025 23:51:33 +0900 Subject: [PATCH 12/13] Update docs/configuring-playbook-prometheus-grafana.md: move up the note about creating a CNAME record Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index e02270d7a..897ebedab 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -8,6 +8,8 @@ By default, this playbook installs Grafana web user-interface on the `stats.` su When setting, replace `example.com` with your own. +**Note**: It is possible to install Prometheus without installing Grafana. This case it is not required to create the CNAME record. + ## Adjusting the playbook configuration ### Configure Prometheus @@ -81,8 +83,6 @@ grafana_hostname: grafana.example.com After changing the domain, **you may need to adjust your DNS** records to point the Grafana domain to the Matrix server. -**Note**: It is possible to install Prometheus without installing Grafana. This case it is not required to create the CNAME record. - ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: From 3d4c9bd0e9a0d59bcb01cf72daa2a32793d5d7da Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 9 Feb 2025 13:35:58 +0900 Subject: [PATCH 13/13] Update docs/configuring-playbook-prometheus-grafana.md Co-authored-by: Slavi Pantaleev --- docs/configuring-playbook-prometheus-grafana.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 897ebedab..477cb172e 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -8,7 +8,7 @@ By default, this playbook installs Grafana web user-interface on the `stats.` su When setting, replace `example.com` with your own. -**Note**: It is possible to install Prometheus without installing Grafana. This case it is not required to create the CNAME record. +**Note**: It is possible to install Prometheus without installing Grafana. In this case it is not required to create the CNAME record. ## Adjusting the playbook configuration