prometheus-blackbox-exporter

docs/services/prometheus-blackbox-exporter.md

@@ -0,0 +1,31 @@
+# Prometheus Blackbox Expoter
+
+This playbook can configure [Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter).
+
+## Configuration
+
+To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
+
+```yaml
+########################################################################
+#                                                                      #
+# prometheus-blackbox-exporter                                         #
+#                                                                      #
+########################################################################
+
+prometheus_blackbox_exporter_enabled: true
+prometheus_blackbox_exporter_hostname: mash.example.com
+prometheus_blackbox_exporter_path_prefix: /metrics/blackbox-exporter
+prometheus_blackbox_exporter_basicauth_user: your_username
+prometheus_blackbox_exporter_basicauth_password: your password
+
+########################################################################
+#                                                                      #
+# /prometheus-blackbox-exporter                                        #
+#                                                                      #
+########################################################################
+```
+
+## Usage
+
+After you installed the blackbox exporter, your blackbox prober will be available on `mash.example.com/metrics/blackbox-exporter` with basic auth credentials you configured

docs/supported-services.md

@@ -11,7 +11,8 @@
 | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) |
 | [Nextcloud](https://nextcloud.com/) | The most popular self-hosted collaboration solution for tens of millions of users at thousands of organizations across the globe. | [Link](services/nextcloud.md) |
 | [PeerTube](https://joinpeertube.org/) | A tool for sharing online videos | [Link](services/peertube.md) |
-| [Prometheus Node Exporter](https://github.com/prometheus/node_exporter) | Exporter for machine metrics  | [Link](services/prometheus-node-exporter.md) |
+| [Prometheus Node Exporter](https://github.com/prometheus/node_exporter) | Exporter for machine metrics | [Link](services/prometheus-node-exporter.md) |
+| [Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) | Blackbox probing of HTTP/HTTPS/DNS/TCP/ICMP and gRPC endpoints | [Link](services/prometheus-blackbox-exporter.md) |
 | [Postgres](https://www.postgresql.org) | A powerful, open source object-relational database system | [Link](services/postgres.md) |
 | [Postgres Backup](https://github.com/prodrigestivill/docker-postgres-backup-local) | A solution for backing up PostgresSQL to local filesystem with periodic backups. | [Link](services/postgres-backup.md) |
 | [Radicale](https://radicale.org/) | A Free and Open-Source CalDAV and CardDAV Server (solution for hosting contacts and calendars) | [Link](services/radicale.md) |

group_vars/mash_servers

@@ -75,6 +75,8 @@ devture_systemd_service_manager_services_list_auto: |
     +
     ([{'name': (peertube_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'peertube']}] if peertube_enabled else [])
     +
+    ([{'name': (prometheus_blackbox_exporter_identifier + '.service'), 'priority': 500, 'groups': ['mash', 'metrics', 'prometheus-blackbox-exporter']}] if prometheus_blackbox_exporter_enabled else [])
+    +
     ([{'name': (prometheus_node_exporter_identifier + '.service'), 'priority': 500, 'groups': ['mash', 'metrics', 'prometheus-node-exporter']}] if prometheus_node_exporter_enabled else [])
     +
     ([{'name': (radicale_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'radicale']}] if radicale_enabled else [])
@@ -651,6 +653,42 @@ peertube_systemd_required_services_list: |
 ########################################################################
 
 
+########################################################################
+#                                                                      #
+# prometheus_blackbox_exporter                                         #
+#                                                                      #
+########################################################################
+
+prometheus_blackbox_exporter_enabled: false
+
+prometheus_blackbox_exporter_identifier: "{{ mash_playbook_service_identifier_prefix }}prometheus-blackbox-exporter"
+
+prometheus_blackbox_exporter_base_path: "{{ mash_playbook_base_path }}/prometheus-blackbox-exporter"
+
+prometheus_blackbox_exporter_uid: "{{ mash_playbook_uid }}"
+prometheus_blackbox_exporter_gid: "{{ mash_playbook_gid }}"
+
+prometheus_blackbox_exporter_basicauth_enabled: true
+prometheus_blackbox_exporter_basicauth_user: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'blackbox.user', rounds=655555) | to_uuid }}"
+prometheus_blackbox_exporter_basicauth_password: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'blackbox.password', rounds=655555) | to_uuid }}"
+
+prometheus_blackbox_exporter_container_additional_networks: |
+  {{
+    ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else [])
+  }}
+
+prometheus_blackbox_exporter_container_labels_traefik_enabled: "{{ mash_playbook_traefik_labels_enabled }}"
+prometheus_blackbox_exporter_container_labels_traefik_docker_network: "{{ mash_playbook_reverse_proxyable_services_additional_network }}"
+prometheus_blackbox_exporter_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}"
+prometheus_blackbox_exporter_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}"
+
+########################################################################
+#                                                                      #
+# /prometheus_blackbox_exporter                                        #
+#                                                                      #
+########################################################################
+
+
 ########################################################################
 #                                                                      #
 # prometheus_node_exporter                                             #

requirements.yml

@@ -66,6 +66,9 @@
 - src: git+https://gitlab.com/etke.cc/roles/prometheus_node_exporter.git
   version: v1.5.0-4
 
+- src: git+https://gitlab.com/etke.cc/roles/prometheus_blackbox_exporter.git
+  version: v0.23.0-0
+
 - src: git+https://gitlab.com/etke.cc/roles/redmine.git
   version: v5.0.5-1