2022-02-05 20:32:54 +00:00
---
2021-01-29 04:29:25 +00:00
# matrix-prometheus is an open-source systems monitoring and alerting toolkit
# See: https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md
2022-07-16 20:59:21 +00:00
# Project source code URL: https://github.com/prometheus/prometheus
2021-01-29 04:29:25 +00:00
matrix_prometheus_enabled : false
2022-07-17 14:31:41 +00:00
matrix_prometheus_version : v2.37.0
2021-04-12 12:39:16 +00:00
matrix_prometheus_docker_image : "{{ matrix_container_global_registry_prefix }}prom/prometheus:{{ matrix_prometheus_version }}"
2021-01-29 04:29:25 +00:00
matrix_prometheus_docker_image_force_pull : "{{ matrix_prometheus_docker_image.endswith(':latest') }}"
matrix_prometheus_base_path : "{{ matrix_base_data_path }}/prometheus"
matrix_prometheus_config_path : "{{ matrix_prometheus_base_path }}/config"
matrix_prometheus_data_path : "{{ matrix_prometheus_base_path }}/data"
# A list of extra arguments to pass to the container
matrix_prometheus_container_extra_arguments : [ ]
# List of systemd services that matrix-prometheus.service depends on
matrix_prometheus_systemd_required_services_list : [ 'docker.service' ]
# List of systemd services that matrix-prometheus.service wants
matrix_prometheus_systemd_wanted_services_list : [ ]
# Controls whether the matrix-prometheus container exposes its HTTP port (tcp/9090 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9090"), or empty string to not expose.
matrix_prometheus_container_http_host_bind_port : ''
2022-06-26 09:01:57 +00:00
# A list of default arguments to pass to the prometheus process
matrix_prometheus_process_default_arguments :
2022-06-26 05:41:22 +00:00
- "--config.file=/etc/prometheus/prometheus.yml"
- "--storage.tsdb.path=/prometheus"
- "--web.console.libraries=/usr/share/prometheus/console_libraries"
- "--web.console.templates=/usr/share/prometheus/consoles"
2022-06-26 09:01:57 +00:00
# A list of extra arguments to pass to the prometheus process
matrix_prometheus_process_extra_arguments : [ ]
# holds the final list of process arguments
matrix_prometheus_process_arguments : "{{ matrix_prometheus_process_default_arguments + matrix_prometheus_process_extra_arguments }}"
2021-01-31 17:23:12 +00:00
# Tells whether the "synapse" scraper configuration is enabled.
matrix_prometheus_scraper_synapse_enabled : false
# Tells whether to download and load a Synapse rules file
matrix_prometheus_scraper_synapse_rules_enabled : "{{ matrix_prometheus_scraper_synapse_enabled }}"
matrix_prometheus_scraper_synapse_rules_synapse_tag : "master"
matrix_prometheus_scraper_synapse_rules_download_url : "https://raw.githubusercontent.com/matrix-org/synapse/{{ matrix_prometheus_scraper_synapse_rules_synapse_tag }}/contrib/prometheus/synapse-v2.rules"
matrix_prometheus_scraper_synapse_targets : [ ]
2021-07-02 15:41:36 +00:00
matrix_prometheus_scraper_synapse_workers_enabled_list : [ ]
2021-01-31 17:23:12 +00:00
2021-01-31 16:26:08 +00:00
# Tells whether the "node" scraper configuration is enabled.
# This configuration aims to scrape the current node (this server).
matrix_prometheus_scraper_node_enabled : false
2021-01-31 16:17:57 +00:00
# Target addresses for the "node" scraper configuration.
# Unless you define this as a non-empty list, it gets populated at runtime with the IP address of `matrix-prometheus-node-exporter` and port 9100.
2021-01-31 16:26:08 +00:00
matrix_prometheus_scraper_node_targets : [ ]
2021-01-29 04:29:25 +00:00
# Default prometheus configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
# For a more advanced customization, you can extend the default (see `matrix_prometheus_configuration_extension_yaml`)
# or completely replace this variable with your own template.
matrix_prometheus_configuration_yaml : "{{ lookup('template', 'templates/prometheus.yml.j2') }}"
matrix_prometheus_configuration_extension_yaml : |
# Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_prometheus_configuration_yaml`).
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `matrix_prometheus_configuration_yaml`.
matrix_prometheus_configuration_extension : "{{ matrix_prometheus_configuration_extension_yaml|from_yaml if matrix_prometheus_configuration_extension_yaml|from_yaml is mapping else {} }}"
# Holds the final configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `matrix_prometheus_configuration_yaml`.
matrix_prometheus_configuration : "{{ matrix_prometheus_configuration_yaml|from_yaml|combine(matrix_prometheus_configuration_extension, recursive=True) }}"