2022-02-05 22:32:54 +02:00
---
2021-01-29 07:17:45 +02:00
# matrix-prometheus-node-exporter is an Prometheus exporter for machine metrics
# See: https://prometheus.io/docs/guides/node-exporter/
2022-07-16 22:59:21 +02:00
# Project source code URL: https://github.com/prometheus/node_exporter
2021-01-29 07:17:45 +02:00
matrix_prometheus_node_exporter_enabled : false
2022-01-15 19:49:30 +02:00
matrix_prometheus_node_exporter_version : v1.3.1
2021-04-12 14:39:16 +02:00
matrix_prometheus_node_exporter_docker_image : "{{ matrix_container_global_registry_prefix }}prom/node-exporter:{{ matrix_prometheus_node_exporter_version }}"
2021-01-29 07:17:45 +02:00
matrix_prometheus_node_exporter_docker_image_force_pull : "{{ matrix_prometheus_node_exporter_docker_image.endswith(':latest') }}"
# A list of extra arguments to pass to the container
matrix_prometheus_node_exporter_container_extra_arguments : [ ]
2022-06-23 19:37:56 +02:00
# A list of extra arguments to pass to the node_exporter process
#
# Example:
# matrix_prometheus_node_exporter_process_extra_arguments:
# - "--collector.systemd"
# - "--collector.logind"
#
2022-06-24 07:33:17 +02:00
# Note: the above is just an example. Various collectors may require various tweaks to be able to run.
# Running the systemd collector requires the following `matrix_prometheus_node_exporter_container_extra_arguments`:
# - the socket to be mounted as well (`--mount type=bind,src=/var/run/dbus/system_bus_socket,dst=/var/run/dbus/system_bus_socket,ro,bind-propagation=rslave`)
# - (on AppArmor-based distros) disabling AppArmor protection (`--security-opt apparmor=unconfined`)
2022-06-23 19:37:56 +02:00
matrix_prometheus_node_exporter_process_extra_arguments : [ ]
2021-01-29 07:17:45 +02:00
# List of systemd services that matrix-prometheus.service depends on
matrix_prometheus_node_exporter_systemd_required_services_list : [ 'docker.service' ]
# List of systemd services that matrix-prometheus.service wants
matrix_prometheus_node_exporter_systemd_wanted_services_list : [ ]
2022-06-23 16:44:11 +02:00
# Controls whether node-exporter metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/node-exporter`.
# This will only work take effect if `matrix_nginx_proxy_proxy_matrix_metrics_enabled: true`.
# See the `matrix-nginx-proxy` role for details about enabling `matrix_nginx_proxy_proxy_matrix_metrics_enabled`.
matrix_prometheus_node_exporter_metrics_proxying_enabled : false
2021-01-29 07:17:45 +02:00
# Controls whether the matrix-prometheus container exposes its HTTP port (tcp/9100 in the container).
#
2021-04-19 12:05:23 +02:00
# Takes an "<ip>:<port>" value (e.g. "127.0.0.1:9100"), or empty string to not expose.
2021-04-19 17:27:11 +02:00
#
2022-06-23 16:44:11 +02:00
# You likely don't need to do this. See `matrix_prometheus_node_exporter_metrics_proxying_enabled`.
#
2021-04-19 17:27:11 +02:00
# Official recommendations are to run this container with `--net=host`,
# but we don't do that, since it:
# - likely exposes the metrics web server way too publicly (before applying https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1008)
# - or listens on a loopback interface only (--net=host and 127.0.0.1:9100), which is not reachable from another container (like `matrix-prometheus`)
#
# Using `--net=host` and binding to Docker's `matrix` bridge network may be a solution to both,
# but that's trickier to accomplish and won't necessarily work (hasn't been tested).
#
# Not using `--net=host` means that our network statistic reports are likely broken (inaccurate),
# because node-exporter can't see all interfaces, etc.
# For now, we'll live with that, until someone develops a better solution.
2021-01-29 07:17:45 +02:00
matrix_prometheus_node_exporter_container_http_host_bind_port : ''