# SOME DESCRIPTIVE TITLE. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community # members # This file is distributed under the same license as the # matrix-docker-ansible-deploy package. # FIRST AUTHOR , 2024. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-12-16 12:05+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: jp\n" "Language-Team: jp \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.16.0\n" #: ../../../docs/configuring-playbook-prometheus-grafana.md:1 msgid "" "Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server " "(optional)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:3 msgid "" "The playbook can install [Grafana](https://grafana.com/) with " "[Prometheus](https://prometheus.io/) and configure performance metrics of" " your homeserver with graphs for you." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:5 msgid "Adjusting the playbook configuration" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:7 msgid "" "To enable Grafana and/or Prometheus, add the following configuration to " "your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:33 msgid "" "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." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:35 msgid "Adjusting the Grafana URL" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:37 msgid "" "By default, this playbook installs Grafana web user-interface on the " "`stats.` subdomain (`stats.example.com`) and requires you to [adjust your" " DNS records](#adjusting-dns-records)." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:39 msgid "" "By tweaking the `grafana_hostname` variable, you can easily make the " "service available at a **different hostname** than the default one." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:41 msgid "" "Example additional configuration for your " "`inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:48 msgid "Adjusting DNS records" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:50 msgid "" "Once you've decided on the domain, **you may need to adjust your DNS** " "records to point the Grafana domain to the Matrix server." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:52 msgid "" "By default, you will need to create a CNAME record for `stats`. See " "[Configuring DNS](configuring-dns.md) for details about DNS changes." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:54 msgid "" "**Note**: It is possible to install Prometheus without installing " "Grafana. This case it is not required to create the CNAME record." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:56 msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:58 msgid "" "After configuring the playbook and potentially [adjusting your DNS " "records](#adjusting-dns-records), run the playbook with [playbook tags" "](playbook-tags.md) as below:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:65 msgid "" "The shortcut commands with the [`just` program](just.md) are also " "available: `just install-all` or `just setup-all`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:67 msgid "" "`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." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:69 msgid "What does it do?" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "Name" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "Description" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`prometheus_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "[Prometheus](https://prometheus.io) is a time series database. It holds " "all the data we're going to talk about." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`prometheus_node_exporter_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "[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" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`prometheus_postgres_exporter_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an " "addon of sorts to expose Postgres database metrics to Prometheus." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_prometheus_nginxlog_exporter_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "[NGINX Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an " "addon of sorts to expose NGINX logs to Prometheus." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`grafana_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "[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" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`grafana_anonymous_access`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "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." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`grafana_default_admin_user`
`grafana_default_admin_password`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "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" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:81 msgid "Security and privacy" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:83 msgid "" "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." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:85 msgid "" "Most of our docker containers run with limited system access, but the " "`prometheus-node-exporter` has access to the host network stack and " "(readonly) root filesystem. This is required to report on them. If you " "don't like that, you can set `prometheus_node_exporter_enabled: false` " "(which is actually the default). You will still get Synapse metrics with " "this container disabled. Both of the dashboards will always be enabled, " "so you can still look at historical data after disabling either source." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:87 msgid "Collecting metrics to an external Prometheus server" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:89 msgid "" "**If the integrated Prometheus server is enabled** (`prometheus_enabled: " "true`), metrics are collected by it from each service via communication " "that happens over the container network. Each service does not need to " "expose its metrics \"publicly\"." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:91 msgid "" "When you'd like **to collect metrics from an external Prometheus " "server**, you need to expose service metrics outside of the container " "network." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:93 msgid "" "The playbook provides a single endpoint " "(`https://matrix.example.com/metrics/*`), under which various services " "may expose their metrics (e.g. `/metrics/node-exporter`, `/metrics" "/postgres-exporter`, `/metrics/hookshot`, etc). To expose all services on" " this `/metrics/*` feature, use `matrix_metrics_exposure_enabled`. To " "protect access using [Basic " "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)," " see `matrix_metrics_exposure_http_basic_auth_enabled` and " "`matrix_metrics_exposure_http_basic_auth_users` below." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:95 msgid "" "When using `matrix_metrics_exposure_enabled`, you don't need to expose " "metrics for individual services one by one." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:97 msgid "The following variables may be of interest:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_metrics_exposure_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to **enable metrics exposure for all services** on " "`https://matrix.example.com/metrics/*`. If you think this is too much, " "refer to the helpful (but nonexhaustive) list of individual " "`matrix_SERVICE_metrics_proxying_enabled` (or similar) variables below " "for exposing metrics on a per-service basis." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_metrics_exposure_http_basic_auth_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to protect all `https://matrix.example.com/metrics/*` " "endpoints with [Basic " "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)" " (see the other variables below for supplying the actual credentials). " "When enabled, all endpoints beneath `/metrics` will be protected with the" " same credentials" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_metrics_exposure_http_basic_auth_users`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to the Basic Authentication credentials (raw `htpasswd` file " "content) used to protect `/metrics/*`. This htpasswd-file needs to be " "generated with the `htpasswd` tool and can include multiple " "username/password pairs." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_synapse_metrics_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to make Synapse expose metrics (locally, on the " "container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_synapse_metrics_proxying_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to expose Synapse's metrics on " "`https://matrix.example.com/metrics/synapse/main-process` and " "`https://matrix.example.com/metrics/synapse/worker/TYPE-ID`. Read [below" "](#collecting-synapse-worker-metrics-to-an-external-prometheus-server) if" " you're running a Synapse worker setup (`matrix_synapse_workers_enabled: " "true`). To password-protect the metrics, see " "`matrix_metrics_exposure_http_basic_auth_users` above." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to enable the node (general system stats) exporter " "(locally, on the container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`prometheus_node_exporter_container_labels_traefik_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to expose the node (general system stats) metrics on " "`https://matrix.example.com/metrics/node-exporter`. To password-protect " "the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to enable the [Postgres exporter](configuring-" "playbook-prometheus-postgres.md) (locally, on the container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`prometheus_postgres_exporter_container_labels_traefik_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to expose the [Postgres exporter](configuring-" "playbook-prometheus-postgres.md) metrics on " "`https://matrix.example.com/metrics/postgres-exporter`. To password-" "protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` " "above." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to enable the [NGINX Log exporter](configuring-" "playbook-prometheus-nginxlog.md) (locally, on the container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_sliding_sync_metrics_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to make [Sliding Sync](configuring-playbook-sliding-" "sync-proxy.md) expose metrics (locally, on the container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_sliding_sync_metrics_proxying_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to expose the [Sliding Sync](configuring-playbook-" "sliding-sync-proxy.md) metrics on `https://matrix.example.com/metrics" "/sliding-sync`. To password-protect the metrics, see " "`matrix_metrics_exposure_http_basic_auth_users` above." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_bridge_hookshot_metrics_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to make [Hookshot](configuring-playbook-bridge-" "hookshot.md) expose metrics (locally, on the container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_bridge_hookshot_metrics_proxying_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to expose the [Hookshot](configuring-playbook-bridge-" "hookshot.md) metrics on `https://matrix.example.com/metrics/hookshot`. To" " password-protect the metrics, see " "`matrix_metrics_exposure_http_basic_auth_users` above." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_SERVICE_metrics_proxying_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Various other services/roles may provide similar `_metrics_enabled` and " "`_metrics_proxying_enabled` variables for exposing their metrics. Refer " "to each role for details. To password-protect the metrics, see " "`matrix_metrics_exposure_http_basic_auth_users` above or " "`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_enabled`/`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_users`" " variables provided by each role." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "`matrix_media_repo_metrics_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md msgid "" "Set this to `true` to make media-repo expose metrics (locally, on the " "container network)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:118 msgid "Collecting Synapse worker metrics to an external Prometheus server" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:120 msgid "" "If you are using workers (`matrix_synapse_workers_enabled: true`) and " "have enabled `matrix_synapse_metrics_proxying_enabled` as described " "above, the playbook will also automatically expose all Synapse worker " "threads' metrics to " "`https://matrix.example.com/metrics/synapse/worker/ID`, where `ID` " "corresponds to the worker `id` as exemplified in " "`matrix_synapse_workers_enabled_list`." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:122 msgid "" "The playbook also generates an exemplary config file " "(`/matrix/synapse/external_prometheus.yml.template`) with all the correct" " paths which you can copy to your Prometheus server and adapt to your " "needs. Make sure to edit the specified `password_file` path and contents " "and path to your `synapse-v2.rules`. It will look a bit like this:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:150 msgid "More information" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:152 msgid "" "[Enabling synapse-usage-exporter for Synapse usage statistics" "](configuring-playbook-synapse-usage-exporter.md)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:153 msgid "" "[Understanding Synapse Performance Issues Through Grafana Graphs](https" "://element-" "hq.github.io/synapse/latest/usage/administration/understanding_synapse_through_grafana_graphs.html)" " at the Synapse Github Wiki" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:154 msgid "" "[The Prometheus scraping rules](https://github.com/element-" "hq/synapse/tree/master/contrib/prometheus) (we use v2)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:155 msgid "" "[The Synapse Grafana dashboard](https://github.com/element-" "hq/synapse/tree/master/contrib/grafana)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:156 msgid "" "[The Node Exporter dashboard](https://github.com/rfrail3/grafana-" "dashboards) (for generic non-synapse performance graphs)" msgstr ""