add deprecation notice for haproxy_exporter

voxpupuli · Jun 30, 2024 · 83f671d · 83f671d
1 parent 8346eec
commit 83f671d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -4627,6 +4627,8 @@ Default value: `undef`
 
 This module manages prometheus haproxy_exporter
 
+* **Note** This class is deprecated.
+
 #### Parameters
 
 The following parameters are available in the `prometheus::haproxy_exporter` class:

diff --git a/manifests/haproxy_exporter.pp b/manifests/haproxy_exporter.pp
@@ -55,6 +55,8 @@
 #  Path of file where the web-config will be saved to
 # @param web_config_content
 #  Unless empty the content of the web-config yaml which will handed over as option to the exporter
+# @note
+#    This class is deprecated.
 class prometheus::haproxy_exporter (
   Variant[Stdlib::HTTPUrl, Pattern[/unix:(?:\/.+)+/]] $cnf_scrape_uri,
   String $download_extension,
@@ -95,6 +97,7 @@
     true    => Service[$service_name],
     default => undef,
   }
+  deprecation('prometheus::haproxy_exporter', 'haproxy exporter is deprecated and will be remove in the next major release. See https://github.com/prometheus/haproxy_exporter?tab=readme-ov-file#official-prometheus-exporter')
 
   $_web_config_ensure = $web_config_content.empty ? {
     true    => absent,