Browse Source

Remove dead metrics support from the mautrix-twitter bridge

Bridges based on bridgev2 no longer expose a metrics endpoint, so the
playbook was publishing a Traefik route which could only ever yield an
HTTP 502.

Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/5487
pull/5494/head
Slavi Pantaleev 2 days ago
parent
commit
45e337f71c
4 changed files with 12 additions and 67 deletions
  1. +0
    -9
      group_vars/matrix_servers
  2. +0
    -21
      roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml
  3. +12
    -2
      roles/custom/matrix-bridge-mautrix-twitter/tasks/validate_config.yml
  4. +0
    -35
      roles/custom/matrix-bridge-mautrix-twitter/templates/labels.j2

+ 0
- 9
group_vars/matrix_servers View File

@@ -2156,9 +2156,6 @@ matrix_bridge_mautrix_twitter_container_labels_traefik_docker_network: "{{ matri
matrix_bridge_mautrix_twitter_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}"
matrix_bridge_mautrix_twitter_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}"

matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_enabled: "{{ matrix_metrics_exposure_http_basic_auth_enabled }}"
matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_users: "{{ matrix_metrics_exposure_http_basic_auth_users }}"

matrix_bridge_mautrix_twitter_appservice_token: "{{ (matrix_homeserver_generic_secret_key + ':twt.as.token') | hash('sha512') | to_uuid }}"

matrix_bridge_mautrix_twitter_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}"
@@ -2177,12 +2174,6 @@ matrix_bridge_mautrix_twitter_double_puppet_secrets_auto: |-
else {}
}}

matrix_bridge_mautrix_twitter_metrics_enabled: "{{ prometheus_enabled or matrix_metrics_exposure_enabled }}"

matrix_bridge_mautrix_twitter_metrics_proxying_enabled: "{{ matrix_bridge_mautrix_twitter_metrics_enabled and matrix_metrics_exposure_enabled }}"
matrix_bridge_mautrix_twitter_metrics_proxying_hostname: "{{ matrix_metrics_exposure_hostname }}"
matrix_bridge_mautrix_twitter_metrics_proxying_path_prefix: "{{ matrix_metrics_exposure_path_prefix }}/mautrix-twitter"

matrix_bridge_mautrix_twitter_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}"
matrix_bridge_mautrix_twitter_exposure_enabled: "{{ matrix_bridges_exposure_enabled }}"
matrix_bridge_mautrix_twitter_exposure_hostname: "{{ matrix_bridges_exposure_hostname }}"


+ 0
- 21
roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml View File

@@ -79,17 +79,6 @@ matrix_bridge_mautrix_twitter_container_labels_traefik_docker_network: "{{ matri
matrix_bridge_mautrix_twitter_container_labels_traefik_entrypoints: web-secure
matrix_bridge_mautrix_twitter_container_labels_traefik_tls_certResolver: default # noqa var-naming

# Controls whether labels will be added that expose mautrix-instagram's metrics
matrix_bridge_mautrix_twitter_container_labels_metrics_enabled: "{{ matrix_bridge_mautrix_twitter_metrics_enabled and matrix_bridge_mautrix_twitter_metrics_proxying_enabled }}"
matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_rule: "Host(`{{ matrix_bridge_mautrix_twitter_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_twitter_metrics_proxying_path_prefix }}`)"
matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_priority: 0
matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_entrypoints: "{{ matrix_bridge_mautrix_twitter_container_labels_traefik_entrypoints }}"
matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls: "{{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_entrypoints != 'web' }}"
matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_twitter_container_labels_traefik_tls_certResolver }}" # noqa var-naming
matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_enabled: false
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_users: ''

# Controls whether labels will be added that expose mautrix-twitter's HTTP API
# (used by tools like mautrix-manager for bridge login) at `https://<hostname><path_prefix>`.
matrix_bridge_mautrix_twitter_container_labels_exposure_enabled: "{{ matrix_bridge_mautrix_twitter_exposure_enabled }}"
@@ -169,16 +158,6 @@ matrix_bridge_mautrix_twitter_provisioning_shared_secret: disable
# Valid values: fatal, error, warn, info, debug, trace
matrix_bridge_mautrix_twitter_logging_level: 'warn'

# Whether or not metrics endpoint should be enabled.
# Enabling them is usually enough for a local (in-container) Prometheus to consume them.
# If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_bridge_mautrix_twitter_metrics_proxying_enabled`.
matrix_bridge_mautrix_twitter_metrics_enabled: false

# Controls whether metrics should be exposed on a public URL.
matrix_bridge_mautrix_twitter_metrics_proxying_enabled: false
matrix_bridge_mautrix_twitter_metrics_proxying_hostname: ''
matrix_bridge_mautrix_twitter_metrics_proxying_path_prefix: ''

# Controls whether mautrix-twitter's HTTP API is exposed publicly (used by tools like mautrix-manager for bridge login).
matrix_bridge_mautrix_twitter_exposure_enabled: false
matrix_bridge_mautrix_twitter_exposure_hostname: ''


+ 12
- 2
roles/custom/matrix-bridge-mautrix-twitter/tasks/validate_config.yml View File

@@ -29,6 +29,18 @@
- {'old': 'matrix_bridge_mautrix_twitter_docker_image_registry_prefix_upstream_default', 'new': 'matrix_bridge_mautrix_twitter_container_image_registry_prefix_upstream_default'}
- {'old': 'matrix_bridge_mautrix_twitter_docker_src_files_path', 'new': 'matrix_bridge_mautrix_twitter_container_src_files_path'}
- {'old': 'matrix_bridge_mautrix_twitter_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
- {'old': 'matrix_bridge_mautrix_twitter_metrics_enabled', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_metrics_proxying_enabled', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_metrics_proxying_hostname', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_metrics_proxying_path_prefix', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_enabled', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_rule', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_priority', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_entrypoints', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls_certResolver', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_enabled', 'new': '<removed> (mautrix-twitter does not support metrics)'}
- {'old': 'matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_users', 'new': '<removed> (mautrix-twitter does not support metrics)'}

- name: Fail if required mautrix-twitter settings not defined
ansible.builtin.fail:
@@ -41,5 +53,3 @@
- {'name': 'matrix_bridge_mautrix_twitter_homeserver_token', when: true}
- {'name': 'matrix_bridge_mautrix_twitter_database_hostname', when: "{{ matrix_bridge_mautrix_twitter_database_engine == 'postgres' }}"}
- {'name': 'matrix_bridge_mautrix_twitter_container_network', when: true}
- {'name': 'matrix_bridge_mautrix_twitter_metrics_proxying_hostname', when: "{{ matrix_bridge_mautrix_twitter_metrics_proxying_enabled }}"}
- {'name': 'matrix_bridge_mautrix_twitter_metrics_proxying_path_prefix', when: "{{ matrix_bridge_mautrix_twitter_metrics_proxying_enabled }}"}

+ 0
- 35
roles/custom/matrix-bridge-mautrix-twitter/templates/labels.j2 View File

@@ -11,41 +11,6 @@ traefik.enable=true
traefik.docker.network={{ matrix_bridge_mautrix_twitter_container_labels_traefik_docker_network }}
{% endif %}

traefik.http.services.matrix-mautrix-twitter-metrics.loadbalancer.server.port=8000

{% if matrix_bridge_mautrix_twitter_container_labels_metrics_enabled %}
############################################################
# #
# Metrics #
# #
############################################################

{% if matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_enabled %}
traefik.http.middlewares.matrix-mautrix-twitter-metrics-basic-auth.basicauth.users={{ matrix_bridge_mautrix_twitter_container_labels_metrics_middleware_basic_auth_users }}
traefik.http.routers.matrix-mautrix-twitter-metrics.middlewares=matrix-mautrix-twitter-metrics-basic-auth
{% endif %}

traefik.http.routers.matrix-mautrix-twitter-metrics.rule={{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_rule }}

{% if matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_priority | int > 0 %}
traefik.http.routers.matrix-mautrix-twitter-metrics.priority={{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_priority }}
{% endif %}

traefik.http.routers.matrix-mautrix-twitter-metrics.service=matrix-mautrix-twitter-metrics
traefik.http.routers.matrix-mautrix-twitter-metrics.entrypoints={{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_entrypoints }}

traefik.http.routers.matrix-mautrix-twitter-metrics.tls={{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls | to_json }}
{% if matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls %}
traefik.http.routers.matrix-mautrix-twitter-metrics.tls.certResolver={{ matrix_bridge_mautrix_twitter_container_labels_metrics_traefik_tls_certResolver }}
{% endif %}

############################################################
# #
# /Metrics #
# #
############################################################
{% endif %}

{% if matrix_bridge_mautrix_twitter_container_labels_exposure_enabled %}
############################################################
# #


Loading…
Cancel
Save