Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

513 lines
18 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
  3. # members
  4. # This file is distributed under the same license as the
  5. # matrix-docker-ansible-deploy package.
  6. # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
  7. #
  8. #, fuzzy
  9. msgid ""
  10. msgstr ""
  11. "Project-Id-Version: matrix-docker-ansible-deploy \n"
  12. "Report-Msgid-Bugs-To: \n"
  13. "POT-Creation-Date: 2024-12-16 12:05+0900\n"
  14. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
  15. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
  16. "Language: jp\n"
  17. "Language-Team: jp <LL@li.org>\n"
  18. "MIME-Version: 1.0\n"
  19. "Content-Type: text/plain; charset=utf-8\n"
  20. "Content-Transfer-Encoding: 8bit\n"
  21. "Generated-By: Babel 2.16.0\n"
  22. #: ../../../docs/configuring-playbook-prometheus-grafana.md:1
  23. msgid ""
  24. "Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server "
  25. "(optional)"
  26. msgstr ""
  27. #: ../../../docs/configuring-playbook-prometheus-grafana.md:3
  28. msgid ""
  29. "The playbook can install [Grafana](https://grafana.com/) with "
  30. "[Prometheus](https://prometheus.io/) and configure performance metrics of"
  31. " your homeserver with graphs for you."
  32. msgstr ""
  33. #: ../../../docs/configuring-playbook-prometheus-grafana.md:5
  34. msgid "Adjusting the playbook configuration"
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-prometheus-grafana.md:7
  37. msgid ""
  38. "To enable Grafana and/or Prometheus, add the following configuration to "
  39. "your `inventory/host_vars/matrix.example.com/vars.yml` file:"
  40. msgstr ""
  41. #: ../../../docs/configuring-playbook-prometheus-grafana.md:33
  42. msgid ""
  43. "The retention policy of Prometheus metrics is [15 days by "
  44. "default](https://prometheus.io/docs/prometheus/latest/storage"
  45. "/#operational-aspects). Older data gets deleted automatically."
  46. msgstr ""
  47. #: ../../../docs/configuring-playbook-prometheus-grafana.md:35
  48. msgid "Adjusting the Grafana URL"
  49. msgstr ""
  50. #: ../../../docs/configuring-playbook-prometheus-grafana.md:37
  51. msgid ""
  52. "By default, this playbook installs Grafana web user-interface on the "
  53. "`stats.` subdomain (`stats.example.com`) and requires you to [adjust your"
  54. " DNS records](#adjusting-dns-records)."
  55. msgstr ""
  56. #: ../../../docs/configuring-playbook-prometheus-grafana.md:39
  57. msgid ""
  58. "By tweaking the `grafana_hostname` variable, you can easily make the "
  59. "service available at a **different hostname** than the default one."
  60. msgstr ""
  61. #: ../../../docs/configuring-playbook-prometheus-grafana.md:41
  62. msgid ""
  63. "Example additional configuration for your "
  64. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  65. msgstr ""
  66. #: ../../../docs/configuring-playbook-prometheus-grafana.md:48
  67. msgid "Adjusting DNS records"
  68. msgstr ""
  69. #: ../../../docs/configuring-playbook-prometheus-grafana.md:50
  70. msgid ""
  71. "Once you've decided on the domain, **you may need to adjust your DNS** "
  72. "records to point the Grafana domain to the Matrix server."
  73. msgstr ""
  74. #: ../../../docs/configuring-playbook-prometheus-grafana.md:52
  75. msgid ""
  76. "By default, you will need to create a CNAME record for `stats`. See "
  77. "[Configuring DNS](configuring-dns.md) for details about DNS changes."
  78. msgstr ""
  79. #: ../../../docs/configuring-playbook-prometheus-grafana.md:54
  80. msgid ""
  81. "**Note**: It is possible to install Prometheus without installing "
  82. "Grafana. This case it is not required to create the CNAME record."
  83. msgstr ""
  84. #: ../../../docs/configuring-playbook-prometheus-grafana.md:56
  85. msgid "Installing"
  86. msgstr ""
  87. #: ../../../docs/configuring-playbook-prometheus-grafana.md:58
  88. msgid ""
  89. "After configuring the playbook and potentially [adjusting your DNS "
  90. "records](#adjusting-dns-records), run the playbook with [playbook tags"
  91. "](playbook-tags.md) as below:"
  92. msgstr ""
  93. #: ../../../docs/configuring-playbook-prometheus-grafana.md:65
  94. msgid ""
  95. "The shortcut commands with the [`just` program](just.md) are also "
  96. "available: `just install-all` or `just setup-all`"
  97. msgstr ""
  98. #: ../../../docs/configuring-playbook-prometheus-grafana.md:67
  99. msgid ""
  100. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "
  101. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"
  102. "runtime) than `just setup-all`) when its components remain unchanged. If "
  103. "you adjust your `vars.yml` to remove other components, you'd need to run "
  104. "`just setup-all`, or these components will still remain installed. Note "
  105. "these shortcuts run the `ensure-matrix-users-created` tag too."
  106. msgstr ""
  107. #: ../../../docs/configuring-playbook-prometheus-grafana.md:69
  108. msgid "What does it do?"
  109. msgstr ""
  110. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  111. msgid "Name"
  112. msgstr ""
  113. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  114. msgid "Description"
  115. msgstr ""
  116. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  117. msgid "`prometheus_enabled`"
  118. msgstr ""
  119. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  120. msgid ""
  121. "[Prometheus](https://prometheus.io) is a time series database. It holds "
  122. "all the data we're going to talk about."
  123. msgstr ""
  124. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  125. msgid "`prometheus_node_exporter_enabled`"
  126. msgstr ""
  127. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  128. msgid ""
  129. "[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an "
  130. "addon of sorts to Prometheus that collects generic system information "
  131. "such as CPU, memory, filesystem, and even system temperatures"
  132. msgstr ""
  133. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  134. msgid "`prometheus_postgres_exporter_enabled`"
  135. msgstr ""
  136. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  137. msgid ""
  138. "[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an "
  139. "addon of sorts to expose Postgres database metrics to Prometheus."
  140. msgstr ""
  141. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  142. msgid "`matrix_prometheus_nginxlog_exporter_enabled`"
  143. msgstr ""
  144. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  145. msgid ""
  146. "[NGINX Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an "
  147. "addon of sorts to expose NGINX logs to Prometheus."
  148. msgstr ""
  149. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  150. msgid "`grafana_enabled`"
  151. msgstr ""
  152. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  153. msgid ""
  154. "[Grafana](https://grafana.com/) is the visual component. It shows (on the"
  155. " `stats.example.com` subdomain) the dashboards with the graphs that we're"
  156. " interested in"
  157. msgstr ""
  158. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  159. msgid "`grafana_anonymous_access`"
  160. msgstr ""
  161. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  162. msgid ""
  163. "By default you need to log in to see graphs. If you want to publicly "
  164. "share your graphs (e.g. when asking for help in "
  165. "[`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org))"
  166. " you'll want to enable this option."
  167. msgstr ""
  168. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  169. msgid "`grafana_default_admin_user`<br>`grafana_default_admin_password`"
  170. msgstr ""
  171. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  172. msgid ""
  173. "By default Grafana creates a user with `admin` as the username and "
  174. "password. If you feel this is insecure and you want to change it "
  175. "beforehand, you can do that here"
  176. msgstr ""
  177. #: ../../../docs/configuring-playbook-prometheus-grafana.md:81
  178. msgid "Security and privacy"
  179. msgstr ""
  180. #: ../../../docs/configuring-playbook-prometheus-grafana.md:83
  181. msgid ""
  182. "Metrics and resulting graphs can contain a lot of information. This "
  183. "includes system specs but also usage patterns. This applies especially to"
  184. " small personal/family scale homeservers. Someone might be able to figure"
  185. " out when you wake up and go to sleep by looking at the graphs over time."
  186. " Think about this before enabling anonymous access. And you should really"
  187. " not forget to change your Grafana password."
  188. msgstr ""
  189. #: ../../../docs/configuring-playbook-prometheus-grafana.md:85
  190. msgid ""
  191. "Most of our docker containers run with limited system access, but the "
  192. "`prometheus-node-exporter` has access to the host network stack and "
  193. "(readonly) root filesystem. This is required to report on them. If you "
  194. "don't like that, you can set `prometheus_node_exporter_enabled: false` "
  195. "(which is actually the default). You will still get Synapse metrics with "
  196. "this container disabled. Both of the dashboards will always be enabled, "
  197. "so you can still look at historical data after disabling either source."
  198. msgstr ""
  199. #: ../../../docs/configuring-playbook-prometheus-grafana.md:87
  200. msgid "Collecting metrics to an external Prometheus server"
  201. msgstr ""
  202. #: ../../../docs/configuring-playbook-prometheus-grafana.md:89
  203. msgid ""
  204. "**If the integrated Prometheus server is enabled** (`prometheus_enabled: "
  205. "true`), metrics are collected by it from each service via communication "
  206. "that happens over the container network. Each service does not need to "
  207. "expose its metrics \"publicly\"."
  208. msgstr ""
  209. #: ../../../docs/configuring-playbook-prometheus-grafana.md:91
  210. msgid ""
  211. "When you'd like **to collect metrics from an external Prometheus "
  212. "server**, you need to expose service metrics outside of the container "
  213. "network."
  214. msgstr ""
  215. #: ../../../docs/configuring-playbook-prometheus-grafana.md:93
  216. msgid ""
  217. "The playbook provides a single endpoint "
  218. "(`https://matrix.example.com/metrics/*`), under which various services "
  219. "may expose their metrics (e.g. `/metrics/node-exporter`, `/metrics"
  220. "/postgres-exporter`, `/metrics/hookshot`, etc). To expose all services on"
  221. " this `/metrics/*` feature, use `matrix_metrics_exposure_enabled`. To "
  222. "protect access using [Basic "
  223. "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication),"
  224. " see `matrix_metrics_exposure_http_basic_auth_enabled` and "
  225. "`matrix_metrics_exposure_http_basic_auth_users` below."
  226. msgstr ""
  227. #: ../../../docs/configuring-playbook-prometheus-grafana.md:95
  228. msgid ""
  229. "When using `matrix_metrics_exposure_enabled`, you don't need to expose "
  230. "metrics for individual services one by one."
  231. msgstr ""
  232. #: ../../../docs/configuring-playbook-prometheus-grafana.md:97
  233. msgid "The following variables may be of interest:"
  234. msgstr ""
  235. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  236. msgid "`matrix_metrics_exposure_enabled`"
  237. msgstr ""
  238. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  239. msgid ""
  240. "Set this to `true` to **enable metrics exposure for all services** on "
  241. "`https://matrix.example.com/metrics/*`. If you think this is too much, "
  242. "refer to the helpful (but nonexhaustive) list of individual "
  243. "`matrix_SERVICE_metrics_proxying_enabled` (or similar) variables below "
  244. "for exposing metrics on a per-service basis."
  245. msgstr ""
  246. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  247. msgid "`matrix_metrics_exposure_http_basic_auth_enabled`"
  248. msgstr ""
  249. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  250. msgid ""
  251. "Set this to `true` to protect all `https://matrix.example.com/metrics/*` "
  252. "endpoints with [Basic "
  253. "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)"
  254. " (see the other variables below for supplying the actual credentials). "
  255. "When enabled, all endpoints beneath `/metrics` will be protected with the"
  256. " same credentials"
  257. msgstr ""
  258. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  259. msgid "`matrix_metrics_exposure_http_basic_auth_users`"
  260. msgstr ""
  261. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  262. msgid ""
  263. "Set this to the Basic Authentication credentials (raw `htpasswd` file "
  264. "content) used to protect `/metrics/*`. This htpasswd-file needs to be "
  265. "generated with the `htpasswd` tool and can include multiple "
  266. "username/password pairs."
  267. msgstr ""
  268. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  269. msgid "`matrix_synapse_metrics_enabled`"
  270. msgstr ""
  271. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  272. msgid ""
  273. "Set this to `true` to make Synapse expose metrics (locally, on the "
  274. "container network)"
  275. msgstr ""
  276. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  277. msgid "`matrix_synapse_metrics_proxying_enabled`"
  278. msgstr ""
  279. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  280. msgid ""
  281. "Set this to `true` to expose Synapse's metrics on "
  282. "`https://matrix.example.com/metrics/synapse/main-process` and "
  283. "`https://matrix.example.com/metrics/synapse/worker/TYPE-ID`. Read [below"
  284. "](#collecting-synapse-worker-metrics-to-an-external-prometheus-server) if"
  285. " you're running a Synapse worker setup (`matrix_synapse_workers_enabled: "
  286. "true`). To password-protect the metrics, see "
  287. "`matrix_metrics_exposure_http_basic_auth_users` above."
  288. msgstr ""
  289. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  290. msgid ""
  291. "Set this to `true` to enable the node (general system stats) exporter "
  292. "(locally, on the container network)"
  293. msgstr ""
  294. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  295. msgid "`prometheus_node_exporter_container_labels_traefik_enabled`"
  296. msgstr ""
  297. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  298. msgid ""
  299. "Set this to `true` to expose the node (general system stats) metrics on "
  300. "`https://matrix.example.com/metrics/node-exporter`. To password-protect "
  301. "the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above."
  302. msgstr ""
  303. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  304. msgid ""
  305. "Set this to `true` to enable the [Postgres exporter](configuring-"
  306. "playbook-prometheus-postgres.md) (locally, on the container network)"
  307. msgstr ""
  308. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  309. msgid "`prometheus_postgres_exporter_container_labels_traefik_enabled`"
  310. msgstr ""
  311. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  312. msgid ""
  313. "Set this to `true` to expose the [Postgres exporter](configuring-"
  314. "playbook-prometheus-postgres.md) metrics on "
  315. "`https://matrix.example.com/metrics/postgres-exporter`. To password-"
  316. "protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` "
  317. "above."
  318. msgstr ""
  319. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  320. msgid ""
  321. "Set this to `true` to enable the [NGINX Log exporter](configuring-"
  322. "playbook-prometheus-nginxlog.md) (locally, on the container network)"
  323. msgstr ""
  324. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  325. msgid "`matrix_sliding_sync_metrics_enabled`"
  326. msgstr ""
  327. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  328. msgid ""
  329. "Set this to `true` to make [Sliding Sync](configuring-playbook-sliding-"
  330. "sync-proxy.md) expose metrics (locally, on the container network)"
  331. msgstr ""
  332. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  333. msgid "`matrix_sliding_sync_metrics_proxying_enabled`"
  334. msgstr ""
  335. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  336. msgid ""
  337. "Set this to `true` to expose the [Sliding Sync](configuring-playbook-"
  338. "sliding-sync-proxy.md) metrics on `https://matrix.example.com/metrics"
  339. "/sliding-sync`. To password-protect the metrics, see "
  340. "`matrix_metrics_exposure_http_basic_auth_users` above."
  341. msgstr ""
  342. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  343. msgid "`matrix_bridge_hookshot_metrics_enabled`"
  344. msgstr ""
  345. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  346. msgid ""
  347. "Set this to `true` to make [Hookshot](configuring-playbook-bridge-"
  348. "hookshot.md) expose metrics (locally, on the container network)"
  349. msgstr ""
  350. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  351. msgid "`matrix_bridge_hookshot_metrics_proxying_enabled`"
  352. msgstr ""
  353. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  354. msgid ""
  355. "Set this to `true` to expose the [Hookshot](configuring-playbook-bridge-"
  356. "hookshot.md) metrics on `https://matrix.example.com/metrics/hookshot`. To"
  357. " password-protect the metrics, see "
  358. "`matrix_metrics_exposure_http_basic_auth_users` above."
  359. msgstr ""
  360. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  361. msgid "`matrix_SERVICE_metrics_proxying_enabled`"
  362. msgstr ""
  363. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  364. msgid ""
  365. "Various other services/roles may provide similar `_metrics_enabled` and "
  366. "`_metrics_proxying_enabled` variables for exposing their metrics. Refer "
  367. "to each role for details. To password-protect the metrics, see "
  368. "`matrix_metrics_exposure_http_basic_auth_users` above or "
  369. "`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_enabled`/`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_users`"
  370. " variables provided by each role."
  371. msgstr ""
  372. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  373. msgid "`matrix_media_repo_metrics_enabled`"
  374. msgstr ""
  375. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  376. msgid ""
  377. "Set this to `true` to make media-repo expose metrics (locally, on the "
  378. "container network)"
  379. msgstr ""
  380. #: ../../../docs/configuring-playbook-prometheus-grafana.md:118
  381. msgid "Collecting Synapse worker metrics to an external Prometheus server"
  382. msgstr ""
  383. #: ../../../docs/configuring-playbook-prometheus-grafana.md:120
  384. msgid ""
  385. "If you are using workers (`matrix_synapse_workers_enabled: true`) and "
  386. "have enabled `matrix_synapse_metrics_proxying_enabled` as described "
  387. "above, the playbook will also automatically expose all Synapse worker "
  388. "threads' metrics to "
  389. "`https://matrix.example.com/metrics/synapse/worker/ID`, where `ID` "
  390. "corresponds to the worker `id` as exemplified in "
  391. "`matrix_synapse_workers_enabled_list`."
  392. msgstr ""
  393. #: ../../../docs/configuring-playbook-prometheus-grafana.md:122
  394. msgid ""
  395. "The playbook also generates an exemplary config file "
  396. "(`/matrix/synapse/external_prometheus.yml.template`) with all the correct"
  397. " paths which you can copy to your Prometheus server and adapt to your "
  398. "needs. Make sure to edit the specified `password_file` path and contents "
  399. "and path to your `synapse-v2.rules`. It will look a bit like this:"
  400. msgstr ""
  401. #: ../../../docs/configuring-playbook-prometheus-grafana.md:150
  402. msgid "More information"
  403. msgstr ""
  404. #: ../../../docs/configuring-playbook-prometheus-grafana.md:152
  405. msgid ""
  406. "[Enabling synapse-usage-exporter for Synapse usage statistics"
  407. "](configuring-playbook-synapse-usage-exporter.md)"
  408. msgstr ""
  409. #: ../../../docs/configuring-playbook-prometheus-grafana.md:153
  410. msgid ""
  411. "[Understanding Synapse Performance Issues Through Grafana Graphs](https"
  412. "://element-"
  413. "hq.github.io/synapse/latest/usage/administration/understanding_synapse_through_grafana_graphs.html)"
  414. " at the Synapse Github Wiki"
  415. msgstr ""
  416. #: ../../../docs/configuring-playbook-prometheus-grafana.md:154
  417. msgid ""
  418. "[The Prometheus scraping rules](https://github.com/element-"
  419. "hq/synapse/tree/master/contrib/prometheus) (we use v2)"
  420. msgstr ""
  421. #: ../../../docs/configuring-playbook-prometheus-grafana.md:155
  422. msgid ""
  423. "[The Synapse Grafana dashboard](https://github.com/element-"
  424. "hq/synapse/tree/master/contrib/grafana)"
  425. msgstr ""
  426. #: ../../../docs/configuring-playbook-prometheus-grafana.md:156
  427. msgid ""
  428. "[The Node Exporter dashboard](https://github.com/rfrail3/grafana-"
  429. "dashboards) (for generic non-synapse performance graphs)"
  430. msgstr ""