8ebf18a885
* add prometheus-nginxlog-exporter role * Rename matrix_prometheus_nginxlog_exporter_container_url to matrix_prometheus_nginxlog_exporter_container_hostname * avoid referencing variables from other roles, handover info using group_vars/matrix_servers * fix: stop service when uninstalling fix: typo move available arch's into a var fix: text * fix: prometheus enabled condition Co-authored-by: ikkemaniac <ikkemaniac@localhost>
3.6 KiB
Enabling metrics and graphs for NginX logs (optional)
It can be useful to have some (visual) insight into NignX logs.
This adds prometheus-nginxlog-exporter to your matrix deployment.
It will provide a prometheus 'metrics' endpoint exposing data from both the matrix-nginx-proxy and matrix-synapse-reverse-proxy-companion logs and automatically aggregates the data with prometheus.
Optionally it visualizes the data, if matrix-grafana is enabled, by means of a dedicated Grafana dashboard named NGINX PROXY
You can enable this role by adding the following settings in your configuration file (inventory/host_vars/matrix.<your-domain>/vars.yml):
matrix_prometheus_nginxlog_exporter_enabled: true
# required depency
matrix_prometheus_enabled: true
# optional for visualization
matrix_grafana_enabled: true
| x | Prerequisites | Variable | Description |
|---|---|---|---|
| REQUIRED | matrix-prometheus |
matrix_prometheus_enabled |
Prometheus is a time series database. It holds all the data we're going to talk about. |
| Optional | matrix-grafana |
matrix_grafana_enabled |
Grafana is the visual component. It shows (on the stats.<your-domain> subdomain) graphs that we're interested in. When enabled the NGINX PROXY dashboard is automatically added. |
Docker Image Compatibility
At the moment of writing only images for amd64 and arm64 architectures are available
The playbook currently does not support building an image. You can however use a custom-build image by setting
matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false
matrix_prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag
Security and privacy
Metrics and resulting graphs can contain a lot of information. NginX logs contain information like IP address, URLs, UserAgents and more. This information can reveal usage patterns and could be considered Personally Identifiable Information (PII). Think about this before enabling (anonymous) access. Please make sure you change the default Grafana password.
Save metrics on an external Prometheus server
The playbook will automatically integrate the metrics into the Prometheus server provided with this playbook. You can choose to save data on an external Prometheus instance.
The metrics of this role will be exposed on https://matrix.DOMAIN/metrics/nginxlog when setting
matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled: true
# required dependency
matrix_nginx_proxy_proxy_matrix_metrics_enabled: true
The playbook can provide a single endpoint (https://matrix.DOMAIN/metrics/*), under which various services may expose their metrics (e.g. /metrics/node-exporter, /metrics/postgres-exporter, /metrics/nginxlog, etc). To enable this /metrics/* feature, use matrix_nginx_proxy_proxy_matrix_metrics_enabled. To protect access using Basic Authentication, see matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_enabled.
The following variables may be of interest:
| Name | Description |
|---|---|
matrix_nginx_proxy_proxy_matrix_metrics_enabled |
Set this to true to enable metrics exposure for various services on https://matrix.DOMAIN/metrics/*. Refer to the individual matrix_SERVICE_metrics_proxying_enabled variables below for exposing metrics for each individual service. |