Merge pull request #320 from speechmatics/weakcamel/pushgateway_extra…

…_cli_params feat: pushgateway extra parameters
prometheus-community · Jan 12, 2025 · 00dbdcb · 00dbdcb
2 parents 07fa4b6 + 8c201a7
commit 00dbdcb
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/roles/pushgateway/defaults/main.yml b/roles/pushgateway/defaults/main.yml
@@ -7,6 +7,14 @@ pushgateway_checksums_url: "https://github.com/{{ _pushgateway_repo }}/releases/
 pushgateway_web_listen_address: "0.0.0.0:9091"
 pushgateway_web_telemetry_path: "/metrics"
 
+# External address on which pushgateway is available.
+# Useful when behind reverse proxy, e.g.: https://example.org/pushgateway
+pushgateway_web_external_url: ""
+
+# Optional extra flags to be passed to pushgateway binary, e.g.
+# ['--log.level=debug', '--log.format=json', '--web.enable-admin-api']
+pushgateway_config_flags_extra: []
+
 pushgateway_tls_server_config: {}
 
 pushgateway_http_server_config: {}

diff --git a/roles/pushgateway/meta/argument_specs.yml b/roles/pushgateway/meta/argument_specs.yml
@@ -23,6 +23,16 @@ argument_specs:
       pushgateway_web_telemetry_path:
         description: "Path under which to expose metrics"
         default: "/metrics"
+      pushgateway_web_external_url:
+        description: >
+          External address on which pushgateway is available.
+          Useful when behind reverse proxy, e.g.: https://example.org/pushgateway
+        default: ""
+      pushgateway_config_flags_extra:
+        description: >
+          Optional extra flags to be passed to pushgateway binary, e.g.
+          ['--log.level=debug', '--log.format=json', '--web.enable-admin-api']
+        default: []
       pushgateway_tls_server_config:
         description:
           - "Configuration for TLS authentication."

diff --git a/roles/pushgateway/templates/pushgateway.service.j2 b/roles/pushgateway/templates/pushgateway.service.j2
@@ -25,6 +25,17 @@ ExecStart={{ pushgateway_binary_install_dir }}/pushgateway \
 {%   endfor %}
 {% else %}
     '--web.listen-address={{ pushgateway_web_listen_address }}' \
+{% endif %}
+{% if pushgateway_web_external_url %}
+    '--web.external-url={{ pushgateway_web_external_url }}' \
+{% endif %}
+{% if pushgateway_config_flags_extra and
+      pushgateway_config_flags_extra is iterable and
+      pushgateway_config_flags_extra is not mapping and
+      pushgateway_config_flags_extra is not string %}
+{%   for extra_flag in pushgateway_config_flags_extra %}
+    '{{ extra_flag }}' \
+{%   endfor %}
 {% endif %}
     '--web.telemetry-path={{ pushgateway_web_telemetry_path }}'