From 6441a39a1bb8df98810d6728147a82528ffcc4e3 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 17 Feb 2026 04:38:45 +0900 Subject: [PATCH] Replace `matrix-prometheus-nginxlog-exporter` and `matrix_prometheus_nginxlog_exporter` Signed-off-by: Suguru Hirahara --- ...configuring-playbook-prometheus-grafana.md | 12 +- group_vars/matrix_servers | 56 ++++----- .../defaults/main.yml | 108 +++++++++--------- .../tasks/main.yml | 6 +- .../tasks/setup_install.yml | 46 ++++---- .../tasks/setup_uninstall.yml | 20 ++-- .../tasks/validate_config.yml | 18 +-- .../templates/labels.j2 | 34 +++--- .../prometheus-nginxlog-exporter.yaml.j2 | 6 +- ...ix-prometheus-nginxlog-exporter.service.j2 | 42 +++---- .../defaults/main.yml | 2 + .../tasks/validate_config.yml | 19 +++ 12 files changed, 195 insertions(+), 174 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 4f5ca8f90..33da561d4 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -83,7 +83,7 @@ See the project's [documentation](https://github.com/martin-helmich/prometheus-n To enable it, add the following configuration to your `vars.yml` file: ```yaml -matrix_prometheus_nginxlog_exporter_enabled: true +prometheus_nginxlog_exporter_enabled: true ``` If you enable Grafana, a dedicated `NGINX PROXY` Grafana dashboard will be created. @@ -95,8 +95,8 @@ If you enable Grafana, a dedicated `NGINX PROXY` Grafana dashboard will be creat At the moment of writing only images for `amd64` and `arm64` architectures are available. The playbook currently does not support [self-building](./self-building.md) a container image on other architectures. You can however use a custom-build image by setting: ```yaml -matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false -matrix_prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag +prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false +prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag ``` ### Extending the configuration @@ -181,8 +181,8 @@ Name | Description `prometheus_node_exporter_container_labels_traefik_enabled`|Set this to `true` to expose the node (general system stats) metrics on `https://matrix.example.com/metrics/node-exporter`. `prometheus_postgres_exporter_enabled`|Set this to `true` to enable the [Postgres exporter](#enable-metrics-and-graphs-for-postgres-optional) (locally, on the container network). `prometheus_postgres_exporter_container_labels_traefik_enabled`|Set this to `true` to expose the [Postgres exporter](#enable-metrics-and-graphs-for-postgres-optional) metrics on `https://matrix.example.com/metrics/postgres-exporter`. -`matrix_prometheus_nginxlog_exporter_enabled`|Set this to `true` to enable the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) (locally, on the container network). -`matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled`|Set this to `true` to expose the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) metrics on `https://matrix.example.com/metrics/nginxlog`. +`prometheus_nginxlog_exporter_enabled`|Set this to `true` to enable the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) (locally, on the container network). +`prometheus_nginxlog_exporter_metrics_proxying_enabled`|Set this to `true` to expose the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) metrics on `https://matrix.example.com/metrics/nginxlog`. ### Expose metrics of other services/roles @@ -248,7 +248,7 @@ As with all other services, you can find the logs in [systemd-journald](https:// - `journalctl -fu matrix-prometheus` for Prometheus - `journalctl -fu matrix-prometheus-node-exporter` for Node Exporter - `journalctl -fu matrix-prometheus-postgres-exporter` for PostgreSQL Server Exporter -- `journalctl -fu matrix-prometheus-nginxlog-exporter` for prometheus-nginxlog-exporter +- `journalctl -fu prometheus-nginxlog-exporter` for prometheus-nginxlog-exporter - `journalctl -fu matrix-grafana` for Grafana ## More information diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 8fcf8d228..031d47515 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -760,11 +760,11 @@ devture_systemd_service_manager_services_list_auto: | }] if prometheus_postgres_exporter_enabled else []) + ([{ - 'name': 'matrix-prometheus-nginxlog-exporter.service', + 'name': 'prometheus-nginxlog-exporter.service', 'priority': 3900, - 'restart_necessary': (matrix_prometheus_nginxlog_exporter_restart_necessary | bool), + 'restart_necessary': (prometheus_nginxlog_exporter_restart_necessary | bool), 'groups': ['matrix', 'monitoring', 'prometheus-exporters', 'prometheus-nginxlog-exporter'], - }] if matrix_prometheus_nginxlog_exporter_enabled else []) + }] if prometheus_nginxlog_exporter_enabled else []) + ([{ 'name': (valkey_identifier + '.service'), @@ -4854,7 +4854,7 @@ matrix_synapse_reverse_proxy_companion_container_additional_networks_auto: | ( ([matrix_playbook_reverse_proxyable_services_additional_network] if matrix_synapse_reverse_proxy_companion_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network else []) + - ([matrix_prometheus_nginxlog_exporter_container_network] if (matrix_prometheus_nginxlog_exporter_enabled and matrix_prometheus_nginxlog_exporter_container_network != matrix_synapse_reverse_proxy_companion_container_network) else []) + ([prometheus_nginxlog_exporter_container_network] if (prometheus_nginxlog_exporter_enabled and prometheus_nginxlog_exporter_container_network != matrix_synapse_reverse_proxy_companion_container_network) else []) + ([] if matrix_homeserver_container_network in ['', matrix_synapse_reverse_proxy_companion_container_network] else [matrix_homeserver_container_network]) ) | unique @@ -4903,8 +4903,8 @@ matrix_synapse_reverse_proxy_companion_synapse_stream_writer_presence_stream_wor matrix_synapse_reverse_proxy_companion_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}" matrix_synapse_reverse_proxy_companion_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_worker_client_server_endpoints|default([]) }}" -matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_enabled: "{{ matrix_prometheus_nginxlog_exporter_enabled }}" -matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_server_port: "{{ (matrix_prometheus_nginxlog_exporter_identifier | string +':'+ matrix_prometheus_nginxlog_exporter_container_syslog_port | string) | default('') }}" +matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_enabled: "{{ prometheus_nginxlog_exporter_enabled }}" +matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_server_port: "{{ (prometheus_nginxlog_exporter_identifier | string +':'+ prometheus_nginxlog_exporter_container_syslog_port | string) | default('') }}" ###################################################################### # @@ -5212,41 +5212,41 @@ prometheus_postgres_exporter_systemd_required_services_list_auto: | ###################################################################### # -# matrix-prometheus-nginxlog-exporter +# prometheus_nginxlog_exporter # ###################################################################### -matrix_prometheus_nginxlog_exporter_enabled: false +prometheus_nginxlog_exporter_enabled: false -matrix_prometheus_nginxlog_exporter_identifier: matrix-prometheus-nginxlog-exporter +prometheus_nginxlog_exporter_identifier: prometheus-nginxlog-exporter -matrix_prometheus_nginxlog_exporter_hostname: "{{ matrix_server_fqn_matrix }}" +prometheus_nginxlog_exporter_hostname: "{{ matrix_server_fqn_matrix }}" -matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default }}" +prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default }}" -matrix_prometheus_nginxlog_exporter_container_network: "{{ matrix_monitoring_container_network }}" +prometheus_nginxlog_exporter_container_network: "{{ matrix_monitoring_container_network }}" -matrix_prometheus_nginxlog_exporter_container_additional_networks_auto: |- +prometheus_nginxlog_exporter_container_additional_networks_auto: |- {{ - ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_playbook_reverse_proxyable_services_additional_network and matrix_prometheus_nginxlog_exporter_container_labels_traefik_enabled) else []) + ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_playbook_reverse_proxyable_services_additional_network and prometheus_nginxlog_exporter_container_labels_traefik_enabled) else []) }} -matrix_prometheus_nginxlog_exporter_container_labels_traefik_enabled: "{{ matrix_metrics_exposure_enabled }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" +prometheus_nginxlog_exporter_container_labels_traefik_enabled: "{{ matrix_metrics_exposure_enabled }}" +prometheus_nginxlog_exporter_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +prometheus_nginxlog_exporter_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" +prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" -matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled: "{{ matrix_metrics_exposure_http_basic_auth_enabled }}" -matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users: "{{ matrix_metrics_exposure_http_basic_auth_users }}" +prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled: "{{ matrix_metrics_exposure_http_basic_auth_enabled }}" +prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users: "{{ matrix_metrics_exposure_http_basic_auth_users }}" -matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto: | +prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto: | {{ ([matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_tag] if matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_enabled else []) }} ###################################################################### # -# /matrix-prometheus-nginxlog-exporter +# /prometheus_nginxlog_exporter # ###################################################################### @@ -5273,6 +5273,8 @@ prometheus_container_network: "{{ matrix_monitoring_container_network }}" prometheus_container_additional_networks_auto: | {{ ( + ([prometheus_nginxlog_exporter_container_network] if matrix_prometheus_services_connect_scraper_nginxlog_enabled and prometheus_nginxlog_exporter_container_network != prometheus_container_network else []) + + ([prometheus_node_exporter_container_network] if prometheus_self_node_scraper_enabled and prometheus_node_exporter_container_network != prometheus_container_network else []) + ([matrix_synapse_container_network] if matrix_prometheus_services_connect_scraper_synapse_enabled and matrix_synapse_container_network != prometheus_container_network else []) @@ -5281,8 +5283,6 @@ prometheus_container_additional_networks_auto: | + ([matrix_hookshot_container_network] if matrix_prometheus_services_connect_scraper_hookshot_enabled and matrix_hookshot_container_network != prometheus_container_network else []) + - ([matrix_prometheus_nginxlog_exporter_container_network] if matrix_prometheus_services_connect_scraper_nginxlog_enabled and matrix_prometheus_nginxlog_exporter_container_network != prometheus_container_network else []) - + ([matrix_media_repo_container_network] if matrix_prometheus_services_connect_scraper_media_repo_enabled and matrix_media_repo_container_network != prometheus_container_network else []) + ([matrix_synapse_usage_exporter_container_network] if matrix_prometheus_services_connect_scraper_synapse_usage_exporter_enabled and matrix_synapse_usage_exporter_container_network != prometheus_container_network else []) @@ -5344,8 +5344,8 @@ matrix_prometheus_services_connect_scraper_postgres_static_configs_target: "{{ p matrix_prometheus_services_connect_scraper_hookshot_enabled: "{{ matrix_hookshot_enabled and matrix_hookshot_metrics_enabled }}" matrix_prometheus_services_connect_scraper_hookshot_static_configs_target: "{{ matrix_hookshot_container_url }}:{{ matrix_hookshot_metrics_port | string }}" -matrix_prometheus_services_connect_scraper_nginxlog_enabled: "{{ matrix_prometheus_nginxlog_exporter_enabled }}" -matrix_prometheus_services_connect_scraper_nginxlog_static_configs_target: "{{ matrix_prometheus_nginxlog_exporter_identifier }}:{{ matrix_prometheus_nginxlog_exporter_container_metrics_port | string }}" +matrix_prometheus_services_connect_scraper_nginxlog_enabled: "{{ prometheus_nginxlog_exporter_enabled }}" +matrix_prometheus_services_connect_scraper_nginxlog_static_configs_target: "{{ prometheus_nginxlog_exporter_identifier }}:{{ prometheus_nginxlog_exporter_container_metrics_port | string }}" matrix_prometheus_services_connect_scraper_media_repo_enabled: "{{ matrix_media_repo_enabled and matrix_media_repo_metrics_enabled }}" matrix_prometheus_services_connect_scraper_media_repo_static_configs_target: "{{ matrix_media_repo_identifier }}:{{ matrix_media_repo_metrics_port }}" @@ -5418,7 +5418,7 @@ grafana_dashboard_download_urls: | + (prometheus_postgres_exporter_dashboard_urls if prometheus_postgres_exporter_enabled else []) + - (matrix_prometheus_nginxlog_exporter_dashboard_urls if matrix_prometheus_nginxlog_exporter_enabled else []) + (prometheus_nginxlog_exporter_dashboard_urls if prometheus_nginxlog_exporter_enabled else []) + (matrix_media_repo_dashboard_urls if matrix_media_repo_metrics_enabled else []) + @@ -5430,7 +5430,7 @@ grafana_provisioning_dashboard_template_files: | ([{ 'path': 'roles/galaxy/prometheus_nginxlog_exporter/templates/grafana/nginx-proxy.json', 'name': 'nginx-proxy.json', - }] if matrix_prometheus_nginxlog_exporter_enabled else []) + }] if prometheus_nginxlog_exporter_enabled else []) }} grafana_default_home_dashboard_path: |- diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml index 636516f60..ed72ec0e9 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml @@ -9,101 +9,101 @@ # prometheus-nginxlog-exporter exports nginx logs in a prometheus usable format on a `/metrics/ endpoint # See: https://github.com/martin-helmich/prometheus-nginxlog-exporter/ -matrix_prometheus_nginxlog_exporter_enabled: true +prometheus_nginxlog_exporter_enabled: true -matrix_prometheus_nginxlog_exporter_identifier: '' +prometheus_nginxlog_exporter_identifier: '' # You don't need to configure a hostname and path prefix if you're not exposing this. -matrix_prometheus_nginxlog_exporter_hostname: '' -matrix_prometheus_nginxlog_exporter_path_prefix: "/metrics/nginxlog" +prometheus_nginxlog_exporter_hostname: '' +prometheus_nginxlog_exporter_path_prefix: "/metrics/nginxlog" # renovate: datasource=docker depName=ghcr.io/martin-helmich/prometheus-nginxlog-exporter/exporter -matrix_prometheus_nginxlog_exporter_version: v1.10.0 +prometheus_nginxlog_exporter_version: v1.10.0 -matrix_prometheus_nginxlog_exporter_container_metrics_port: '4040' -matrix_prometheus_nginxlog_exporter_container_syslog_port: '6514' +prometheus_nginxlog_exporter_container_metrics_port: '4040' +prometheus_nginxlog_exporter_container_syslog_port: '6514' -matrix_prometheus_nginxlog_exporter_docker_image_arch: ['amd64', 'arm64'] -matrix_prometheus_nginxlog_exporter_docker_image: "{{ matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix }}martin-helmich/prometheus-nginxlog-exporter/exporter:{{ matrix_prometheus_nginxlog_exporter_docker_image_tag }}" -matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix: "{{ matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream }}" -matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream: "{{ matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default }}" -matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default: "ghcr.io/" -matrix_prometheus_nginxlog_exporter_docker_image_tag: "{{ 'latest' if matrix_prometheus_nginxlog_exporter_version == 'master' else matrix_prometheus_nginxlog_exporter_version }}-{{ matrix_architecture }}" -matrix_prometheus_nginxlog_exporter_docker_image_force_pull: "{{ matrix_prometheus_nginxlog_exporter_docker_image.endswith(':latest') }}" -matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled: true +prometheus_nginxlog_exporter_docker_image_arch: ['amd64', 'arm64'] +prometheus_nginxlog_exporter_docker_image: "{{ prometheus_nginxlog_exporter_docker_image_registry_prefix }}martin-helmich/prometheus-nginxlog-exporter/exporter:{{ prometheus_nginxlog_exporter_docker_image_tag }}" +prometheus_nginxlog_exporter_docker_image_registry_prefix: "{{ prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream }}" +prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream: "{{ prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default }}" +prometheus_nginxlog_exporter_docker_image_registry_prefix_upstream_default: "ghcr.io/" +prometheus_nginxlog_exporter_docker_image_tag: "{{ 'latest' if prometheus_nginxlog_exporter_version == 'master' else prometheus_nginxlog_exporter_version }}-{{ matrix_architecture }}" +prometheus_nginxlog_exporter_docker_image_force_pull: "{{ prometheus_nginxlog_exporter_docker_image.endswith(':latest') }}" +prometheus_nginxlog_exporter_docker_image_arch_check_enabled: true # Controls whether prometheus-nginxlog-exporter metrics should be proxied (exposed) on a public URL -matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled: false -matrix_prometheus_nginxlog_exporter_metrics_proxying_hostname: '' -matrix_prometheus_nginxlog_exporter_metrics_proxying_path_prefix: '' +prometheus_nginxlog_exporter_metrics_proxying_enabled: false +prometheus_nginxlog_exporter_metrics_proxying_hostname: '' +prometheus_nginxlog_exporter_metrics_proxying_path_prefix: '' -# matrix_prometheus_nginxlog_exporter_dashboard_urls contains a list of URLs with Grafana dashboard definitions. +# prometheus_nginxlog_exporter_dashboard_urls contains a list of URLs with Grafana dashboard definitions. # If the Grafana role is enabled, these dashboards will be downloaded. -matrix_prometheus_nginxlog_exporter_dashboard_urls: [] +prometheus_nginxlog_exporter_dashboard_urls: [] -matrix_prometheus_nginxlog_exporter_base_path: "{{ matrix_base_data_path }}/prometheus-nginxlog-exporter" -matrix_prometheus_nginxlog_exporter_config_path: "{{ matrix_prometheus_nginxlog_exporter_base_path }}/config" +prometheus_nginxlog_exporter_base_path: "{{ matrix_base_data_path }}/prometheus-nginxlog-exporter" +prometheus_nginxlog_exporter_config_path: "{{ prometheus_nginxlog_exporter_base_path }}/config" -matrix_prometheus_nginxlog_exporter_container_network: "{{ matrix_prometheus_nginxlog_exporter_identifier }}" +prometheus_nginxlog_exporter_container_network: "{{ prometheus_nginxlog_exporter_identifier }}" -matrix_prometheus_nginxlog_exporter_container_additional_networks: "{{ matrix_prometheus_nginxlog_exporter_container_additional_networks_auto + matrix_prometheus_nginxlog_exporter_container_additional_networks_custom }}" -matrix_prometheus_nginxlog_exporter_container_additional_networks_auto: [] -matrix_prometheus_nginxlog_exporter_container_additional_networks_custom: [] +prometheus_nginxlog_exporter_container_additional_networks: "{{ prometheus_nginxlog_exporter_container_additional_networks_auto + prometheus_nginxlog_exporter_container_additional_networks_custom }}" +prometheus_nginxlog_exporter_container_additional_networks_auto: [] +prometheus_nginxlog_exporter_container_additional_networks_custom: [] -# matrix_prometheus_nginxlog_exporter_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. +# prometheus_nginxlog_exporter_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. # See `../templates/labels.j2` for details. # -# To inject your own other container labels, see `matrix_prometheus_nginxlog_exporter_container_labels_additional_labels`. -matrix_prometheus_nginxlog_exporter_container_labels_traefik_enabled: "{{ true if matrix_prometheus_nginxlog_exporter_hostname else false }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_docker_network: "{{ matrix_prometheus_nginxlog_exporter_container_network }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_hostname: "{{ matrix_prometheus_nginxlog_exporter_hostname }}" +# To inject your own other container labels, see `prometheus_nginxlog_exporter_container_labels_additional_labels`. +prometheus_nginxlog_exporter_container_labels_traefik_enabled: "{{ true if prometheus_nginxlog_exporter_hostname else false }}" +prometheus_nginxlog_exporter_container_labels_traefik_docker_network: "{{ prometheus_nginxlog_exporter_container_network }}" +prometheus_nginxlog_exporter_container_labels_traefik_hostname: "{{ prometheus_nginxlog_exporter_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/metrics`). -matrix_prometheus_nginxlog_exporter_container_labels_traefik_path_prefix: "{{ matrix_prometheus_nginxlog_exporter_path_prefix }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_rule: "Host(`{{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_hostname }}`) && PathPrefix(`{{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_path_prefix }}`)" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_entrypoints: web-secure -matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls: "{{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_entrypoints != 'web' }}" -matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver: default # noqa var-naming -matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled: false +prometheus_nginxlog_exporter_container_labels_traefik_path_prefix: "{{ prometheus_nginxlog_exporter_path_prefix }}" +prometheus_nginxlog_exporter_container_labels_traefik_rule: "Host(`{{ prometheus_nginxlog_exporter_container_labels_traefik_hostname }}`) && PathPrefix(`{{ prometheus_nginxlog_exporter_container_labels_traefik_path_prefix }}`)" +prometheus_nginxlog_exporter_container_labels_traefik_entrypoints: web-secure +prometheus_nginxlog_exporter_container_labels_traefik_tls: "{{ prometheus_nginxlog_exporter_container_labels_traefik_entrypoints != 'web' }}" +prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver: default # noqa var-naming +prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled: false # See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users -matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users: '' +prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users: '' -# matrix_prometheus_nginxlog_exporter_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. +# prometheus_nginxlog_exporter_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. # See `../templates/labels.j2` for details. # # Example: -# matrix_prometheus_nginxlog_exporter_container_labels_additional_labels: | +# prometheus_nginxlog_exporter_container_labels_additional_labels: | # my.label=1 # another.label="here" -matrix_prometheus_nginxlog_exporter_container_labels_additional_labels: '' +prometheus_nginxlog_exporter_container_labels_additional_labels: '' # A list of extra docker arguments to pass to the container -matrix_prometheus_nginxlog_exporter_container_extra_arguments: [] +prometheus_nginxlog_exporter_container_extra_arguments: [] # List of systemd services that matrix-prometheus_nginxlog_exporter.service depends on -matrix_prometheus_nginxlog_exporter_systemd_required_services_list: "{{ matrix_prometheus_nginxlog_exporter_systemd_required_services_list_default + matrix_prometheus_nginxlog_exporter_systemd_required_services_list_auto + matrix_prometheus_nginxlog_exporter_systemd_required_services_list_custom }}" -matrix_prometheus_nginxlog_exporter_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" -matrix_prometheus_nginxlog_exporter_systemd_required_services_list_auto: [] -matrix_prometheus_nginxlog_exporter_systemd_required_services_list_custom: [] +prometheus_nginxlog_exporter_systemd_required_services_list: "{{ prometheus_nginxlog_exporter_systemd_required_services_list_default + prometheus_nginxlog_exporter_systemd_required_services_list_auto + prometheus_nginxlog_exporter_systemd_required_services_list_custom }}" +prometheus_nginxlog_exporter_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" +prometheus_nginxlog_exporter_systemd_required_services_list_auto: [] +prometheus_nginxlog_exporter_systemd_required_services_list_custom: [] # List of systemd services that matrix-prometheus_nginxlog_exporter.service wants -matrix_prometheus_nginxlog_exporter_systemd_wanted_services_list: [] +prometheus_nginxlog_exporter_systemd_wanted_services_list: [] # Controls whether the matrix-prometheus_nginxlog_exporter container exposes its HTTP port (tcp/4040 in the container). # # Takes an ":" or "" value (e.g. "127.0.0.1:4040"), or empty string to not expose. -matrix_prometheus_nginxlog_exporter_container_http_host_bind_port: '' +prometheus_nginxlog_exporter_container_http_host_bind_port: '' # Controls whether the matrix-prometheus_nginxlog_exporter container exposes its SYSLOG port (udp/6514 in the container). # # Takes an ":" or "" value (e.g. "127.0.0.1:6514"), or empty string to not expose. # Note: is an UDP connection! -matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port: '' +prometheus_nginxlog_exporter_container_syslog_host_bind_port: '' -matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags: "{{ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto + matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom }}" -matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto: [] -matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom: [] +prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags: "{{ prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto + prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom }}" +prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto: [] +prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom: [] -# matrix_prometheus_nginxlog_exporter_restart_necessary controls whether the service +# prometheus_nginxlog_exporter_restart_necessary controls whether the service # will be restarted (when true) or merely started (when false) by the # systemd service manager role (when conditional restart is enabled). # @@ -111,4 +111,4 @@ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom: # any configuration files, the systemd service file, or the container image changed. # The default of `false` means "no restart needed" — appropriate when the role's # installation tasks haven't run (e.g., due to --tags skipping them). -matrix_prometheus_nginxlog_exporter_restart_necessary: false +prometheus_nginxlog_exporter_restart_necessary: false diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/main.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/main.yml index 5b2ea34b3..12589bcaa 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/main.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/main.yml @@ -11,15 +11,15 @@ - install-all - install-prometheus-nginxlog-exporter block: - - when: matrix_prometheus_nginxlog_exporter_enabled | bool + - when: prometheus_nginxlog_exporter_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" - - when: matrix_prometheus_nginxlog_exporter_enabled | bool + - when: prometheus_nginxlog_exporter_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" - tags: - setup-all - setup-prometheus-nginxlog-exporter block: - - when: not matrix_prometheus_nginxlog_exporter_enabled | bool + - when: not prometheus_nginxlog_exporter_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_install.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_install.yml index 4c9e7c13b..898a5b153 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_install.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_install.yml @@ -6,16 +6,16 @@ --- -- name: Ensure matrix-prometheus-nginxlog-exporter image is pulled +- name: Ensure prometheus-nginxlog-exporter image is pulled community.docker.docker_image: - name: "{{ matrix_prometheus_nginxlog_exporter_docker_image }}" + name: "{{ prometheus_nginxlog_exporter_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" - force_source: "{{ matrix_prometheus_nginxlog_exporter_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" - force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_prometheus_nginxlog_exporter_docker_image_force_pull }}" - register: matrix_prometheus_nginxlog_exporter_container_image_pull_result + force_source: "{{ prometheus_nginxlog_exporter_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else prometheus_nginxlog_exporter_docker_image_force_pull }}" + register: prometheus_nginxlog_exporter_container_image_pull_result retries: "{{ devture_playbook_help_container_retries_count }}" delay: "{{ devture_playbook_help_container_retries_delay }}" - until: matrix_prometheus_nginxlog_exporter_container_image_pull_result is not failed + until: prometheus_nginxlog_exporter_container_image_pull_result is not failed - name: Ensure prometheus-nginxlog-exporter paths exists ansible.builtin.file: @@ -25,49 +25,49 @@ owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" with_items: - - "{{ matrix_prometheus_nginxlog_exporter_base_path }}" - - "{{ matrix_prometheus_nginxlog_exporter_config_path }}" + - "{{ prometheus_nginxlog_exporter_base_path }}" + - "{{ prometheus_nginxlog_exporter_config_path }}" - name: Ensure prometheus-nginxlog-exporter.yaml present ansible.builtin.template: src: "{{ role_path }}/templates/prometheus-nginxlog-exporter.yaml.j2" - dest: "{{ matrix_prometheus_nginxlog_exporter_config_path }}/prometheus-nginxlog-exporter.yaml" + dest: "{{ prometheus_nginxlog_exporter_config_path }}/prometheus-nginxlog-exporter.yaml" mode: '0644' owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" - register: matrix_prometheus_nginxlog_exporter_config_result + register: prometheus_nginxlog_exporter_config_result - name: Ensure prometheus-nginxlog-exporter support files installed ansible.builtin.template: src: "{{ role_path }}/templates/{{ item }}.j2" - dest: "{{ matrix_prometheus_nginxlog_exporter_base_path }}/{{ item }}" + dest: "{{ prometheus_nginxlog_exporter_base_path }}/{{ item }}" mode: '0640' owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" with_items: - labels - register: matrix_prometheus_nginxlog_exporter_support_files_result + register: prometheus_nginxlog_exporter_support_files_result - name: Ensure prometheus-nginxlog-exporter container network is created community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" - name: "{{ matrix_prometheus_nginxlog_exporter_container_network }}" + name: "{{ prometheus_nginxlog_exporter_container_network }}" driver: bridge driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}" -- name: Ensure matrix-prometheus-nginxlog-exporter.service installed +- name: Ensure prometheus-nginxlog-exporter.service installed ansible.builtin.template: - src: "{{ role_path }}/templates/systemd/matrix-prometheus-nginxlog-exporter.service.j2" - dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-prometheus-nginxlog-exporter.service" + src: "{{ role_path }}/templates/systemd/prometheus-nginxlog-exporter.service.j2" + dest: "{{ devture_systemd_docker_base_systemd_path }}/prometheus-nginxlog-exporter.service" mode: '0644' - register: matrix_prometheus_nginxlog_exporter_systemd_service_result + register: prometheus_nginxlog_exporter_systemd_service_result -- name: Determine whether matrix-prometheus-nginxlog-exporter needs a restart +- name: Determine whether prometheus-nginxlog-exporter needs a restart ansible.builtin.set_fact: - matrix_prometheus_nginxlog_exporter_restart_necessary: >- + prometheus_nginxlog_exporter_restart_necessary: >- {{ - matrix_prometheus_nginxlog_exporter_config_result.changed | default(false) - or matrix_prometheus_nginxlog_exporter_support_files_result.changed | default(false) - or matrix_prometheus_nginxlog_exporter_systemd_service_result.changed | default(false) - or matrix_prometheus_nginxlog_exporter_container_image_pull_result.changed | default(false) + prometheus_nginxlog_exporter_config_result.changed | default(false) + or prometheus_nginxlog_exporter_support_files_result.changed | default(false) + or prometheus_nginxlog_exporter_systemd_service_result.changed | default(false) + or prometheus_nginxlog_exporter_container_image_pull_result.changed | default(false) }} diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_uninstall.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_uninstall.yml index 9b1e5035e..3ae2ac427 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/setup_uninstall.yml @@ -5,26 +5,26 @@ --- -- name: Check existence of matrix-prometheus-nginxlog-exporter service +- name: Check existence of prometheus-nginxlog-exporter service ansible.builtin.stat: - path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-prometheus-nginxlog-exporter.service" - register: matrix_prometheus_nginxlog_exporter_service_stat + path: "{{ devture_systemd_docker_base_systemd_path }}/prometheus-nginxlog-exporter.service" + register: prometheus_nginxlog_exporter_service_stat -- when: matrix_prometheus_nginxlog_exporter_service_stat.stat.exists | bool +- when: prometheus_nginxlog_exporter_service_stat.stat.exists | bool block: - - name: Ensure matrix-prometheus-nginxlog-exporter is stopped + - name: Ensure prometheus-nginxlog-exporter is stopped ansible.builtin.service: - name: matrix-prometheus-nginxlog-exporter + name: prometheus-nginxlog-exporter state: stopped enabled: false daemon_reload: true - - name: Ensure matrix-prometheus-nginxlog-exporter.service doesn't exist + - name: Ensure prometheus-nginxlog-exporter.service doesn't exist ansible.builtin.file: - path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-prometheus-nginxlog-exporter.service" + path: "{{ devture_systemd_docker_base_systemd_path }}/prometheus-nginxlog-exporter.service" state: absent - - name: Ensure matrix-prometheus-nginxlog-exporter path doesn't exist + - name: Ensure prometheus-nginxlog-exporter path doesn't exist ansible.builtin.file: - path: "{{ matrix_prometheus_nginxlog_exporter_base_path }}" + path: "{{ prometheus_nginxlog_exporter_base_path }}" state: absent diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml index e484c9d94..2685009d4 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml @@ -13,8 +13,8 @@ Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml). when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0" with_items: - - {'old': 'matrix_prometheus_nginxlog_exporter_container_hostname', 'new': 'matrix_prometheus_nginxlog_exporter_identifier'} - - {'old': 'matrix_prometheus_nginxlog_exporter_docker_image_name_prefix', 'new': 'matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix'} + - {'old': 'prometheus_nginxlog_exporter_container_hostname', 'new': 'prometheus_nginxlog_exporter_identifier'} + - {'old': 'prometheus_nginxlog_exporter_docker_image_name_prefix', 'new': 'prometheus_nginxlog_exporter_docker_image_registry_prefix'} - name: Fail if docker image not available for arch ansible.builtin.fail: @@ -24,14 +24,14 @@ We currently do not support building an image using this playbook. You can 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' + 'prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false' + 'prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag' or disable 'prometheus-nginxlog-exporter' by setting - 'matrix_prometheus_nginxlog_exporter: false' + 'prometheus_nginxlog_exporter: false' in vars.yml - when: matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled and matrix_architecture not in matrix_prometheus_nginxlog_exporter_docker_image_arch + when: prometheus_nginxlog_exporter_docker_image_arch_check_enabled and matrix_architecture not in prometheus_nginxlog_exporter_docker_image_arch - name: Fail if required prometheus-nginxlog-exporter settings not defined ansible.builtin.fail: @@ -39,6 +39,6 @@ You need to define a required configuration setting (`{{ item.name }}`). when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0" with_items: - - {'name': 'matrix_prometheus_nginxlog_exporter_metrics_proxying_hostname', when: "{{ matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled }}"} - - {'name': 'matrix_prometheus_nginxlog_exporter_metrics_proxying_path_prefix', when: "{{ matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled }}"} - - {'name': 'matrix_prometheus_nginxlog_exporter_container_network', when: true} + - {'name': 'prometheus_nginxlog_exporter_metrics_proxying_hostname', when: "{{ prometheus_nginxlog_exporter_metrics_proxying_enabled }}"} + - {'name': 'prometheus_nginxlog_exporter_metrics_proxying_path_prefix', when: "{{ prometheus_nginxlog_exporter_metrics_proxying_enabled }}"} + - {'name': 'prometheus_nginxlog_exporter_container_network', when: true} diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/labels.j2 b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/labels.j2 index 7aa35d9c6..47d8b14d2 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/labels.j2 +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/labels.j2 @@ -4,39 +4,39 @@ SPDX-FileCopyrightText: 2024 Slavi Pantaleev SPDX-License-Identifier: AGPL-3.0-or-later #} -{% if matrix_prometheus_nginxlog_exporter_container_labels_traefik_enabled %} +{% if prometheus_nginxlog_exporter_container_labels_traefik_enabled %} traefik.enable=true -{% if matrix_prometheus_nginxlog_exporter_container_labels_traefik_docker_network %} -traefik.docker.network={{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_docker_network }} +{% if prometheus_nginxlog_exporter_container_labels_traefik_docker_network %} +traefik.docker.network={{ prometheus_nginxlog_exporter_container_labels_traefik_docker_network }} {% endif %} -traefik.http.services.{{ matrix_prometheus_nginxlog_exporter_identifier }}.loadbalancer.server.port={{ matrix_prometheus_nginxlog_exporter_container_metrics_port }} +traefik.http.services.{{ prometheus_nginxlog_exporter_identifier }}.loadbalancer.server.port={{ prometheus_nginxlog_exporter_container_metrics_port }} {% set middlewares = [] %} -{% if matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled %} -{% set middlewares = middlewares + [matrix_prometheus_nginxlog_exporter_identifier + '-basic-auth'] %} -traefik.http.middlewares.{{ matrix_prometheus_nginxlog_exporter_identifier }}-basic-auth.basicauth.users={{ matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users }} +{% if prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled %} +{% set middlewares = middlewares + [prometheus_nginxlog_exporter_identifier + '-basic-auth'] %} +traefik.http.middlewares.{{ prometheus_nginxlog_exporter_identifier }}-basic-auth.basicauth.users={{ prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users }} {% endif %} -{% set middlewares = middlewares + [matrix_prometheus_nginxlog_exporter_identifier + '-replacepath'] %} -traefik.http.middlewares.{{ matrix_prometheus_nginxlog_exporter_identifier }}-replacepath.replacepath.path=/metrics +{% set middlewares = middlewares + [prometheus_nginxlog_exporter_identifier + '-replacepath'] %} +traefik.http.middlewares.{{ prometheus_nginxlog_exporter_identifier }}-replacepath.replacepath.path=/metrics -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.rule={{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_rule }} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.rule={{ prometheus_nginxlog_exporter_container_labels_traefik_rule }} {% if middlewares | length > 0 %} -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.middlewares={{ middlewares | join(',') }} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.middlewares={{ middlewares | join(',') }} {% endif %} -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.service={{ matrix_prometheus_nginxlog_exporter_identifier }} -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.entrypoints={{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_entrypoints }} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.service={{ prometheus_nginxlog_exporter_identifier }} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.entrypoints={{ prometheus_nginxlog_exporter_container_labels_traefik_entrypoints }} -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.tls={{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls | to_json }} -{% if matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls %} -traefik.http.routers.{{ matrix_prometheus_nginxlog_exporter_identifier }}.tls.certResolver={{ matrix_prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver }} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.tls={{ prometheus_nginxlog_exporter_container_labels_traefik_tls | to_json }} +{% if prometheus_nginxlog_exporter_container_labels_traefik_tls %} +traefik.http.routers.{{ prometheus_nginxlog_exporter_identifier }}.tls.certResolver={{ prometheus_nginxlog_exporter_container_labels_traefik_tls_certResolver }} {% endif %} {% endif %} -{{ matrix_prometheus_nginxlog_exporter_container_labels_additional_labels }} +{{ prometheus_nginxlog_exporter_container_labels_additional_labels }} diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/prometheus-nginxlog-exporter.yaml.j2 b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/prometheus-nginxlog-exporter.yaml.j2 index a059e6d5b..d08e35686 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/prometheus-nginxlog-exporter.yaml.j2 +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/prometheus-nginxlog-exporter.yaml.j2 @@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later #} listen: - port: {{ matrix_prometheus_nginxlog_exporter_container_metrics_port }} + port: {{ prometheus_nginxlog_exporter_container_metrics_port }} address: "0.0.0.0" metrics_endpoint: "/metrics" @@ -20,10 +20,10 @@ namespaces: # print_log: true source: syslog: - listen_address: "udp://0.0.0.0:{{ matrix_prometheus_nginxlog_exporter_container_syslog_port }}" + listen_address: "udp://0.0.0.0:{{ prometheus_nginxlog_exporter_container_syslog_port }}" # format options: "rfc3164" ,"rfc5424", "rfc6587", "auto" format: auto - tags: {{ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags | to_json }} + tags: {{ prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags | to_json }} relabel_configs: - target_label: request_uri from: request diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/systemd/matrix-prometheus-nginxlog-exporter.service.j2 b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/systemd/matrix-prometheus-nginxlog-exporter.service.j2 index 0261d9a04..b6280c6d0 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/templates/systemd/matrix-prometheus-nginxlog-exporter.service.j2 +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/templates/systemd/matrix-prometheus-nginxlog-exporter.service.j2 @@ -1,11 +1,11 @@ #jinja2: lstrip_blocks: True [Unit] -Description=prometheus-nginxlog-exporteer ({{ matrix_prometheus_nginxlog_exporter_identifier }}) -{% for service in matrix_prometheus_nginxlog_exporter_systemd_required_services_list %} +Description=prometheus-nginxlog-exporteer ({{ prometheus_nginxlog_exporter_identifier }}) +{% for service in prometheus_nginxlog_exporter_systemd_required_services_list %} Requires={{ service }} After={{ service }} {% endfor %} -{% for service in matrix_prometheus_nginxlog_exporter_systemd_wanted_services_list %} +{% for service in prometheus_nginxlog_exporter_systemd_wanted_services_list %} Wants={{ service }} {% endfor %} DefaultDependencies=no @@ -13,42 +13,42 @@ DefaultDependencies=no [Service] Type=simple Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} {{ matrix_prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ matrix_prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} {{ prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ --rm \ - --name={{ matrix_prometheus_nginxlog_exporter_identifier }} \ + --name={{ prometheus_nginxlog_exporter_identifier }} \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ --read-only \ - --network={{ matrix_prometheus_nginxlog_exporter_container_network }} \ - {% if matrix_prometheus_nginxlog_exporter_container_http_host_bind_port %} - -p {{ matrix_prometheus_nginxlog_exporter_container_http_host_bind_port }}:{{ matrix_prometheus_nginxlog_exporter_container_metrics_port }} \ + --network={{ prometheus_nginxlog_exporter_container_network }} \ + {% if prometheus_nginxlog_exporter_container_http_host_bind_port %} + -p {{ prometheus_nginxlog_exporter_container_http_host_bind_port }}:{{ prometheus_nginxlog_exporter_container_metrics_port }} \ {% endif %} - {% if matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port %} - -p {{ matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port }}:{{ matrix_prometheus_nginxlog_exporter_container_syslog_port }}/udp \ + {% if prometheus_nginxlog_exporter_container_syslog_host_bind_port %} + -p {{ prometheus_nginxlog_exporter_container_syslog_host_bind_port }}:{{ prometheus_nginxlog_exporter_container_syslog_port }}/udp \ {% endif %} - --mount type=bind,src={{ matrix_prometheus_nginxlog_exporter_config_path }},dst=/etc/prometheus-nginxlog-exporter \ - --label-file={{ matrix_prometheus_nginxlog_exporter_base_path }}/labels \ - {% for arg in matrix_prometheus_nginxlog_exporter_container_extra_arguments %} + --mount type=bind,src={{ prometheus_nginxlog_exporter_config_path }},dst=/etc/prometheus-nginxlog-exporter \ + --label-file={{ prometheus_nginxlog_exporter_base_path }}/labels \ + {% for arg in prometheus_nginxlog_exporter_container_extra_arguments %} {{ arg }} \ {% endfor %} - {{ matrix_prometheus_nginxlog_exporter_docker_image }} \ + {{ prometheus_nginxlog_exporter_docker_image }} \ -config-file /etc/prometheus-nginxlog-exporter/prometheus-nginxlog-exporter.yaml -{% for network in matrix_prometheus_nginxlog_exporter_container_additional_networks %} -ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} {{ matrix_prometheus_nginxlog_exporter_identifier }} +{% for network in prometheus_nginxlog_exporter_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} {{ prometheus_nginxlog_exporter_identifier }} {% endfor %} -ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach {{ matrix_prometheus_nginxlog_exporter_identifier }} +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach {{ prometheus_nginxlog_exporter_identifier }} -ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} {{ matrix_prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' -ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ matrix_prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} {{ prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ prometheus_nginxlog_exporter_identifier }} 2>/dev/null || true' Restart=always RestartSec=30 -SyslogIdentifier={{ matrix_prometheus_nginxlog_exporter_identifier }} +SyslogIdentifier={{ prometheus_nginxlog_exporter_identifier }} [Install] WantedBy=multi-user.target diff --git a/roles/custom/matrix_playbook_migration/defaults/main.yml b/roles/custom/matrix_playbook_migration/defaults/main.yml index 16f24ba4f..b12074cbc 100644 --- a/roles/custom/matrix_playbook_migration/defaults/main.yml +++ b/roles/custom/matrix_playbook_migration/defaults/main.yml @@ -4,6 +4,8 @@ # SPDX-License-Identifier: AGPL-3.0-or-later --- +# Controls if (`matrix_prometheus_nginxlog_exporter` -> `prometheus_nginxlog_exporter`) validation will run. +matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_validation_enabled: true # Controls if (`matrix_prometheus_node_exporter` -> `prometheus_node_exporter`) validation will run. matrix_playbook_migration_matrix_prometheus_node_exporter_migration_validation_enabled: true diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml index 635cc449f..488950cd9 100644 --- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml +++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml @@ -124,6 +124,25 @@ The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | join(', ') }} when: "lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | length > 0" +- when: matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_validation_enabled | bool + block: + - ansible.builtin.set_fact: + matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_vars: |- + {{ lookup('ansible.builtin.varnames', '^matrix_prometheus_nginxlog_exporter_.+', wantlist=True) }} + + - name: (Deprecation) Catch and report matrix_prometheus_nginxlog_exporter variables + ansible.builtin.fail: + msg: >- + The matrix-prometheus-nginxlog-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-nginxlog-exporter. + The new role is compatible with the old one, but uses different names for its variables. + + Please rename all variables (`matrix_prometheus_nginxlog_exporter_` -> `prometheus_nginxlog_exporter_`) on your configuration file (vars.yml). + + After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so. + + The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_vars | join(', ') }} + when: "matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_vars | length > 0" + - when: matrix_playbook_migration_matrix_prometheus_node_exporter_migration_validation_enabled | bool block: - ansible.builtin.set_fact: