From f30cf4f55738efe38d2fbd69e6c3a7f6f13f8ebc Mon Sep 17 00:00:00 2001 From: Jakob Kartschall Date: Tue, 22 Feb 2022 09:59:19 +0100 Subject: [PATCH] add php-fpm exporter --- REFERENCE.md | 4818 +++++++++++++++------- manifests/nginx_prometheus_exporter.pp | 2 +- manifests/php_fpm_exporter.pp | 159 + spec/acceptance/php_fpm_exporter_spec.rb | 33 + spec/classes/php_fpm_exporter_spec.rb | 87 + 5 files changed, 3567 insertions(+), 1532 deletions(-) create mode 100644 manifests/php_fpm_exporter.pp create mode 100644 spec/acceptance/php_fpm_exporter_spec.rb create mode 100644 spec/classes/php_fpm_exporter_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index ec6c4545a..79ad904ad 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -38,6 +38,7 @@ The package method needs specific yum or apt repo settings which are not made ye * [`prometheus::node_exporter`](#prometheusnode_exporter): This module manages prometheus node node_exporter * [`prometheus::openldap_exporter`](#prometheusopenldap_exporter): This module manages prometheus openldap_exporter * [`prometheus::openvpn_exporter`](#prometheusopenvpn_exporter): This module manages prometheus node openvpn_exporter +* [`prometheus::php_fpm_exporter`](#prometheusphp_fpm_exporter): This module manages prometheus php-fpm exporter * [`prometheus::postfix_exporter`](#prometheuspostfix_exporter): manages prometheus postfix_exporter * [`prometheus::postgres_exporter`](#prometheuspostgres_exporter): This module manages prometheus node postgres_exporter * [`prometheus::process_exporter`](#prometheusprocess_exporter): This module manages prometheus process_exporter @@ -80,15 +81,100 @@ This can be used to make prometheus find instances of your running service or ap ## Classes -### `prometheus` +### `prometheus` This module manages prometheus #### Parameters -The following parameters are available in the `prometheus` class. - -##### `configname` +The following parameters are available in the `prometheus` class: + +* [`configname`](#configname) +* [`manage_user`](#manage_user) +* [`user`](#user) +* [`manage_group`](#manage_group) +* [`purge_config_dir`](#purge_config_dir) +* [`group`](#group) +* [`bin_dir`](#bin_dir) +* [`shared_dir`](#shared_dir) +* [`arch`](#arch) +* [`version`](#version) +* [`install_method`](#install_method) +* [`os`](#os) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`download_extension`](#download_extension) +* [`package_name`](#package_name) +* [`package_ensure`](#package_ensure) +* [`config_dir`](#config_dir) +* [`localstorage`](#localstorage) +* [`extra_options`](#extra_options) +* [`config_hash`](#config_hash) +* [`config_defaults`](#config_defaults) +* [`config_template`](#config_template) +* [`config_mode`](#config_mode) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`manage_service`](#manage_service) +* [`restart_on_change`](#restart_on_change) +* [`init_style`](#init_style) +* [`global_config`](#global_config) +* [`rule_files`](#rule_files) +* [`scrape_configs`](#scrape_configs) +* [`include_default_scrape_configs`](#include_default_scrape_configs) +* [`remote_read_configs`](#remote_read_configs) +* [`remote_write_configs`](#remote_write_configs) +* [`alerts`](#alerts) +* [`extra_alerts`](#extra_alerts) +* [`alert_relabel_config`](#alert_relabel_config) +* [`alertmanagers_config`](#alertmanagers_config) +* [`storage_retention`](#storage_retention) +* [`external_url`](#external_url) +* [`extract_command`](#extract_command) +* [`collect_tag`](#collect_tag) +* [`collect_scrape_jobs`](#collect_scrape_jobs) +* [`max_open_files`](#max_open_files) +* [`usershell`](#usershell) +* [`web_listen_address`](#web_listen_address) +* [`web_read_timeout`](#web_read_timeout) +* [`web_max_connections`](#web_max_connections) +* [`web_route_prefix`](#web_route_prefix) +* [`web_user_assets`](#web_user_assets) +* [`web_enable_lifecycle`](#web_enable_lifecycle) +* [`web_enable_admin_api`](#web_enable_admin_api) +* [`web_page_title`](#web_page_title) +* [`web_cors_origin`](#web_cors_origin) +* [`storage_retention_size`](#storage_retention_size) +* [`storage_no_lockfile`](#storage_no_lockfile) +* [`storage_allow_overlapping_blocks`](#storage_allow_overlapping_blocks) +* [`storage_wal_compression`](#storage_wal_compression) +* [`storage_flush_deadline`](#storage_flush_deadline) +* [`storage_read_sample_limit`](#storage_read_sample_limit) +* [`storage_read_concurrent_limit`](#storage_read_concurrent_limit) +* [`storage_read_max_bytes_in_frame`](#storage_read_max_bytes_in_frame) +* [`alert_for_outage_tolerance`](#alert_for_outage_tolerance) +* [`alert_for_grace_period`](#alert_for_grace_period) +* [`alert_resend_delay`](#alert_resend_delay) +* [`alertmanager_notification_queue_capacity`](#alertmanager_notification_queue_capacity) +* [`alertmanager_timeout`](#alertmanager_timeout) +* [`alertmanager_url`](#alertmanager_url) +* [`query_lookback_delta`](#query_lookback_delta) +* [`query_timeout`](#query_timeout) +* [`query_max_concurrency`](#query_max_concurrency) +* [`query_max_samples`](#query_max_samples) +* [`query_staleness_delta`](#query_staleness_delta) +* [`web_telemetry_path`](#web_telemetry_path) +* [`web_enable_remote_shutdown`](#web_enable_remote_shutdown) +* [`log_level`](#log_level) +* [`log_format`](#log_format) +* [`config_show_diff`](#config_show_diff) +* [`extra_groups`](#extra_groups) +* [`env_file_path`](#env_file_path) +* [`manage_prometheus_server`](#manage_prometheus_server) +* [`manage_config`](#manage_config) + +##### `configname` Data type: `String[1]` @@ -96,7 +182,7 @@ the name of the configfile, defaults to prometheus.yaml or prometheus.yml on mos Default value: `'prometheus.yaml'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -104,13 +190,13 @@ Whether to create user for prometheus or rely on external code for that Default value: ``true`` -##### `user` +##### `user` Data type: `String` User running prometheus -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -118,7 +204,7 @@ Whether to create user for prometheus or rely on external code for that Default value: ``true`` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -126,25 +212,25 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `group` +##### `group` Data type: `String` Group under which prometheus is running -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` Directory where binaries are located -##### `shared_dir` +##### `shared_dir` Data type: `Stdlib::Absolutepath` Directory where shared files are located -##### `arch` +##### `arch` Data type: `String[1]` @@ -152,19 +238,19 @@ Architecture (amd64 or i386) Default value: `$facts['os']['architecture']` -##### `version` +##### `version` Data type: `String` Prometheus release -##### `install_method` +##### `install_method` Data type: `String` Installation method: url or package (only url is supported currently) -##### `os` +##### `os` Data type: `String[1]` @@ -172,55 +258,55 @@ Operating system (linux is supported) Default value: `downcase($facts['kernel'])` -##### `download_url` +##### `download_url` Data type: `Optional[String]` Complete URL corresponding to the Prometheus release, default to undef -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for prometheus -##### `download_extension` +##### `download_extension` Data type: `String` Extension of Prometheus binaries archive -##### `package_name` +##### `package_name` Data type: `String` Prometheus package name - not available yet -##### `package_ensure` +##### `package_ensure` Data type: `String` If package, then use this for package ensurel default 'latest' -##### `config_dir` +##### `config_dir` Data type: `String` Prometheus configuration directory (default /etc/prometheus) -##### `localstorage` +##### `localstorage` Data type: `Stdlib::Absolutepath` Location of prometheus local storage (storage.local argument) -##### `extra_options` +##### `extra_options` Data type: `Optional[String[1]]` Extra options added to prometheus startup command -##### `config_hash` +##### `config_hash` Data type: `Hash` @@ -228,7 +314,7 @@ Startup config hash Default value: `{}` -##### `config_defaults` +##### `config_defaults` Data type: `Hash` @@ -236,19 +322,19 @@ Startup config defaults Default value: `{}` -##### `config_template` +##### `config_template` Data type: `String` Configuration template to use (template/prometheus.yaml.erb) -##### `config_mode` +##### `config_mode` Data type: `String` Configuration file mode (default 0660) -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -256,7 +342,7 @@ Whether to enable or not prometheus service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -264,13 +350,13 @@ State ensured from prometheus service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` Name of the prometheus service (default 'prometheus') -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -278,7 +364,7 @@ Should puppet manage the prometheus service? (default true) Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -288,7 +374,7 @@ options are always *reloaded* without restarting. Default value: ``true`` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -296,25 +382,25 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `global_config` +##### `global_config` Data type: `Hash` Prometheus global configuration variables -##### `rule_files` +##### `rule_files` Data type: `Array` Prometheus rule files -##### `scrape_configs` +##### `scrape_configs` Data type: `Array` Prometheus scrape configs -##### `include_default_scrape_configs` +##### `include_default_scrape_configs` Data type: `Boolean` @@ -322,25 +408,25 @@ Include the module default scrape configs Default value: ``true`` -##### `remote_read_configs` +##### `remote_read_configs` Data type: `Array` Prometheus remote_read config to scrape prometheus 1.8+ instances -##### `remote_write_configs` +##### `remote_write_configs` Data type: `Array` Prometheus remote_write config to scrape prometheus 1.8+ instances -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` alert rules to put in alerts.rules -##### `extra_alerts` +##### `extra_alerts` Data type: `Hash` @@ -348,19 +434,19 @@ Hash with extra alert rules to put in separate files. Default value: `{}` -##### `alert_relabel_config` +##### `alert_relabel_config` Data type: `Array` Prometheus alert relabel config under alerting -##### `alertmanagers_config` +##### `alertmanagers_config` Data type: `Array` Prometheus managers config under alerting -##### `storage_retention` +##### `storage_retention` Data type: `String` @@ -368,7 +454,7 @@ How long to keep timeseries data. This is given as a duration like "100h" or "14 prometheus 1.8.*, only durations understood by golang's time.ParseDuration are supported. Starting with prometheus 2, durations can also be given in days, weeks and years. -##### `external_url` +##### `external_url` Data type: `Optional[Variant[Stdlib::HTTPUrl, Stdlib::Unixpath, String[1]]]` @@ -378,13 +464,13 @@ If omitted, relevant URL components will be derived automatically. Default value: ``undef`` -##### `extract_command` +##### `extract_command` Data type: `Optional[String[1]]` Custom command passed to the archive resource to extract the downloaded archive. -##### `collect_tag` +##### `collect_tag` Data type: `Optional[String[1]]` @@ -392,7 +478,7 @@ Only collect scrape jobs tagged with this label. Allowing to split jobs over mul Default value: ``undef`` -##### `collect_scrape_jobs` +##### `collect_scrape_jobs` Data type: `Array[Hash[String[1], Any]]` @@ -405,7 +491,7 @@ options can be passed as hash elements. Only the job_name is mandatory. Default value: `[]` -##### `max_open_files` +##### `max_open_files` Data type: `Optional[Integer]` @@ -415,14 +501,14 @@ Currently only implemented for systemd based service. Default value: ``undef`` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` if requested, we create a user for prometheus or the exporters. The default shell is nologin. It can be overwritten to any valid path. -##### `web_listen_address` +##### `web_listen_address` Data type: `Optional[String[1]]` @@ -431,7 +517,7 @@ Address to listen on for UI, API, and telemetry. Default value: ``undef`` -##### `web_read_timeout` +##### `web_read_timeout` Data type: `Optional[String[1]]` @@ -440,7 +526,7 @@ Maximum duration before timing out read of the request, and closing idle connect Default value: ``undef`` -##### `web_max_connections` +##### `web_max_connections` Data type: `Optional[String[1]]` @@ -449,7 +535,7 @@ Maximum number of simultaneous connections. Default value: ``undef`` -##### `web_route_prefix` +##### `web_route_prefix` Data type: `Optional[String[1]]` @@ -458,7 +544,7 @@ Prefix for the internal routes of web endpoints. Defaults to path of --web.exter Default value: ``undef`` -##### `web_user_assets` +##### `web_user_assets` Data type: `Optional[String[1]]` @@ -467,7 +553,7 @@ Path to static asset directory, available at /user. Default value: ``undef`` -##### `web_enable_lifecycle` +##### `web_enable_lifecycle` Data type: `Boolean` @@ -476,7 +562,7 @@ Enable shutdown and reload via HTTP request Default value: ``false`` -##### `web_enable_admin_api` +##### `web_enable_admin_api` Data type: `Boolean` @@ -485,7 +571,7 @@ Enable API endpoints for admin control actions. Default value: ``false`` -##### `web_page_title` +##### `web_page_title` Data type: `Optional[String[1]]` @@ -494,7 +580,7 @@ Document title of Prometheus instance. Default value: ``undef`` -##### `web_cors_origin` +##### `web_cors_origin` Data type: `Optional[String[1]]` @@ -503,7 +589,7 @@ Regex for CORS origin. It is fully anchored. Example: 'https?://(domain1|domain2 Default value: ``undef`` -##### `storage_retention_size` +##### `storage_retention_size` Data type: `Optional[String[1]]` @@ -513,7 +599,7 @@ MB, GB, TB, PB. This flag is experimental and can be changed in future releases. Default value: ``undef`` -##### `storage_no_lockfile` +##### `storage_no_lockfile` Data type: `Boolean` @@ -522,7 +608,7 @@ Do not create lockfile in data directory. Default value: ``false`` -##### `storage_allow_overlapping_blocks` +##### `storage_allow_overlapping_blocks` Data type: `Boolean` @@ -532,7 +618,7 @@ vertical query merge. Default value: ``false`` -##### `storage_wal_compression` +##### `storage_wal_compression` Data type: `Boolean` @@ -541,7 +627,7 @@ Compress the tsdb WAL. Default value: ``false`` -##### `storage_flush_deadline` +##### `storage_flush_deadline` Data type: `Optional[String[1]]` @@ -550,7 +636,7 @@ How long to wait flushing sample on shutdown or config reload. Default value: ``undef`` -##### `storage_read_sample_limit` +##### `storage_read_sample_limit` Data type: `Optional[String[1]]` @@ -560,7 +646,7 @@ query. 0 means no limit. This limit is ignored for streamed response types. Default value: ``undef`` -##### `storage_read_concurrent_limit` +##### `storage_read_concurrent_limit` Data type: `Optional[String[1]]` @@ -569,7 +655,7 @@ Maximum number of concurrent remote read calls. 0 means no limit. Default value: ``undef`` -##### `storage_read_max_bytes_in_frame` +##### `storage_read_max_bytes_in_frame` Data type: `Optional[String[1]]` @@ -580,7 +666,7 @@ by protobuf by default. Default value: ``undef`` -##### `alert_for_outage_tolerance` +##### `alert_for_outage_tolerance` Data type: `Optional[String[1]]` @@ -589,7 +675,7 @@ Max time to tolerate prometheus outage for restoring "for" state of alert. Default value: ``undef`` -##### `alert_for_grace_period` +##### `alert_for_grace_period` Data type: `Optional[String[1]]` @@ -599,7 +685,7 @@ alerts with configured "for" time greater than grace period. Default value: ``undef`` -##### `alert_resend_delay` +##### `alert_resend_delay` Data type: `Optional[String[1]]` @@ -608,7 +694,7 @@ Minimum amount of time to wait before resending an alert to Alertmanager. Default value: ``undef`` -##### `alertmanager_notification_queue_capacity` +##### `alertmanager_notification_queue_capacity` Data type: `Optional[String[1]]` @@ -617,7 +703,7 @@ The capacity of the queue for pending Alertmanager notifications. Default value: ``undef`` -##### `alertmanager_timeout` +##### `alertmanager_timeout` Data type: `Optional[String[1]]` @@ -626,7 +712,7 @@ Timeout for sending alerts to Alertmanager. Default value: ``undef`` -##### `alertmanager_url` +##### `alertmanager_url` Data type: `Optional[String[1]]` @@ -636,7 +722,7 @@ In Prometheus v2, Alertmanager must be discovered via service discovery Default value: ``undef`` -##### `query_lookback_delta` +##### `query_lookback_delta` Data type: `Optional[String[1]]` @@ -645,7 +731,7 @@ The maximum lookback duration for retrieving metrics during expression evaluatio Default value: ``undef`` -##### `query_timeout` +##### `query_timeout` Data type: `Optional[String[1]]` @@ -654,7 +740,7 @@ Maximum time a query may take before being aborted. Default value: ``undef`` -##### `query_max_concurrency` +##### `query_max_concurrency` Data type: `Optional[String[1]]` @@ -663,7 +749,7 @@ Maximum number of queries executed concurrently. Default value: ``undef`` -##### `query_max_samples` +##### `query_max_samples` Data type: `Optional[String[1]]` @@ -674,7 +760,7 @@ samples a query can return. Default value: ``undef`` -##### `query_staleness_delta` +##### `query_staleness_delta` Data type: `Optional[String[1]]` @@ -683,7 +769,7 @@ Staleness delta allowance during expression evaluations. Default value: ``undef`` -##### `web_telemetry_path` +##### `web_telemetry_path` Data type: `Optional[String[1]]` @@ -692,7 +778,7 @@ Path under which to expose metrics Default value: ``undef`` -##### `web_enable_remote_shutdown` +##### `web_enable_remote_shutdown` Data type: `Boolean` @@ -701,7 +787,7 @@ Enable remote service shutdown. Default value: ``false`` -##### `log_level` +##### `log_level` Data type: `Optional[Enum['debug', 'info', 'warn', 'error', 'fatal']]` @@ -711,7 +797,7 @@ Value of 'fatal' is also allowed in prometheus v1 Default value: ``undef`` -##### `log_format` +##### `log_format` Data type: `Optional[Enum['logfmt', 'json']]` @@ -720,7 +806,7 @@ Output format of log messages. One of: [logfmt, json] Default value: ``undef`` -##### `config_show_diff` +##### `config_show_diff` Data type: `Boolean` @@ -728,39 +814,76 @@ Whether to show prometheus configuration file diff in the Puppet logs. Default value: ``true`` -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups of which the user should be a part -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` -##### `manage_prometheus_server` +##### `manage_prometheus_server` Data type: `Boolean` -##### `manage_config` +##### `manage_config` Data type: `Boolean` -### `prometheus::alertmanager` +### `prometheus::alertmanager` This module manages prometheus alertmanager #### Parameters -The following parameters are available in the `prometheus::alertmanager` class. - -##### `arch` +The following parameters are available in the `prometheus::alertmanager` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`global`](#global) +* [`group`](#group) +* [`inhibit_rules`](#inhibit_rules) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`mute_time_intervals`](#mute_time_intervals) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`manage_config`](#manage_config) +* [`validate_config`](#validate_config) +* [`receivers`](#receivers) +* [`restart_on_change`](#restart_on_change) +* [`route`](#route) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`storage_path`](#storage_path) +* [`templates`](#templates) +* [`user`](#user) +* [`version`](#version) +* [`config_dir`](#config_dir) +* [`reload_on_change`](#reload_on_change) + +##### `arch` Data type: `String[1]` @@ -768,7 +891,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -776,13 +899,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` The path to put the configuration file -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -790,13 +913,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -804,19 +927,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -824,7 +947,7 @@ Extra options added to the startup command Default value: `''` -##### `global` +##### `global` Data type: `Hash` @@ -834,13 +957,13 @@ prometheus::alertmanager::global: smtp_smarthost: 'localhost:25' smtp_from: 'alertmanager@localhost' -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `inhibit_rules` +##### `inhibit_rules` Data type: `Array` @@ -856,7 +979,7 @@ prometheus::alertmanager::inhibit_rules: - 'cluster' - 'service' -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -864,7 +987,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -872,7 +995,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -880,7 +1003,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -888,7 +1011,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -896,7 +1019,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `mute_time_intervals` +##### `mute_time_intervals` Data type: `Array[Hash]` @@ -906,7 +1029,7 @@ prometheus::alertmanager::mute_time_intervals: - name: weekend weekdays: ['saturday','sunday'] -##### `os` +##### `os` Data type: `String[1]` @@ -914,19 +1037,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -934,7 +1057,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `manage_config` +##### `manage_config` Data type: `Boolean` @@ -942,7 +1065,7 @@ Whether Puppet should manage Alertmanager config Default value: ``true`` -##### `validate_config` +##### `validate_config` Data type: `Boolean` @@ -950,7 +1073,7 @@ Whether Puppet should validate the config with amtool when it is not installed w Default value: ``false`` -##### `receivers` +##### `receivers` Data type: `Array` @@ -961,7 +1084,7 @@ prometheus::alertmanager::receivers: email_configs: - to: 'root@localhost' -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -969,7 +1092,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `route` +##### `route` Data type: `Hash` @@ -985,7 +1108,7 @@ prometheus::alertmanager::route: repeat_interval: '3h' receiver: 'Admin' -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -993,7 +1116,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1001,7 +1124,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1009,37 +1132,37 @@ Name of the alertmanager service (default 'alertmanager') Default value: `'alertmanager'` -##### `storage_path` +##### `storage_path` Data type: `Stdlib::Absolutepath` The storage path to pass to the alertmanager. Defaults to '/var/lib/alertmanager' -##### `templates` +##### `templates` Data type: `Array` The array of template files. Defaults to [ "${config_dir}/*.tmpl" ] -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Absolutepath` -##### `reload_on_change` +##### `reload_on_change` Data type: `Boolean` @@ -1047,15 +1170,46 @@ Data type: `Boolean` Default value: ``false`` -### `prometheus::apache_exporter` +### `prometheus::apache_exporter` This module manages prometheus apache_exporter #### Parameters -The following parameters are available in the `prometheus::apache_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::apache_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`scrape_uri`](#scrape_uri) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -1063,7 +1217,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1071,7 +1225,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -1079,13 +1233,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -1093,19 +1247,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1113,13 +1267,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1127,7 +1281,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1135,7 +1289,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1143,7 +1297,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1151,7 +1305,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1159,7 +1313,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1167,19 +1321,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1187,7 +1341,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1195,13 +1349,13 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `scrape_uri` +##### `scrape_uri` Data type: `String[1]` The URI for the Apache status page -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1209,7 +1363,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1217,7 +1371,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1225,19 +1379,19 @@ Name of the node exporter service (default 'apache_exporter') Default value: `'apache_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1245,7 +1399,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -1253,7 +1407,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1261,7 +1415,7 @@ Data type: `Stdlib::Port` Default value: `9117` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1269,7 +1423,7 @@ Data type: `String[1]` Default value: `'apache'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1277,15 +1431,48 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::beanstalkd_exporter` +### `prometheus::beanstalkd_exporter` This module manages prometheus beanstalkd_exporter #### Parameters -The following parameters are available in the `prometheus::beanstalkd_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::beanstalkd_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config`](#config) +* [`mapping_config`](#mapping_config) +* [`beanstalkd_address`](#beanstalkd_address) +* [`exporter_listen`](#exporter_listen) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -1293,7 +1480,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1301,37 +1488,37 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config` +##### `config` Data type: `String[1]` Path to configuration file that stores beanstalkd address -##### `mapping_config` +##### `mapping_config` Data type: `String[1]` Path to configuration file with tubes mappings (not implemented) -##### `beanstalkd_address` +##### `beanstalkd_address` Data type: `String[1]` Address of beanstalkd, defaults to localhost -##### `exporter_listen` +##### `exporter_listen` Data type: `String[1]` Address to bind beanstalkd_exporter to. Default is different than upstream (*:9371) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Variant[Undef,String]` @@ -1339,19 +1526,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1359,13 +1546,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1373,7 +1560,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1381,7 +1568,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1389,7 +1576,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1397,7 +1584,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1405,7 +1592,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1413,19 +1600,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1433,7 +1620,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1441,7 +1628,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1449,7 +1636,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1457,25 +1644,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the beanstalkd exporter service (default 'beanstalkd_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1483,7 +1670,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -1491,7 +1678,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1499,7 +1686,7 @@ Data type: `Stdlib::Port` Default value: `8080` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1507,7 +1694,7 @@ Data type: `String[1]` Default value: `'beanstalkd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1515,7 +1702,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::bind_exporter` +### `prometheus::bind_exporter` Class: prometheus::bind_exporter @@ -1523,9 +1710,39 @@ This module manages prometheus bind_exporter #### Parameters -The following parameters are available in the `prometheus::bind_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::bind_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`env_vars`](#env_vars) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_port`](#scrape_port) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -1533,7 +1750,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1541,7 +1758,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -1549,7 +1766,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -1557,7 +1774,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Stdlib::HTTPSUrl]` @@ -1565,7 +1782,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Stdlib::HTTPSUrl` @@ -1573,7 +1790,7 @@ Base URL for the binary archive Default value: `'https://github.com/prometheus-community/bind_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -1581,7 +1798,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -1589,7 +1806,7 @@ Extra options added to the startup command Default value: `''` -##### `env_vars` +##### `env_vars` Data type: `Hash[String, Scalar]` @@ -1597,7 +1814,7 @@ The environment variable to pass to the daemon Default value: `{}` -##### `group` +##### `group` Data type: `String[1]` @@ -1605,7 +1822,7 @@ Group under which the binary is running Default value: `'bind-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1613,7 +1830,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1621,7 +1838,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1629,7 +1846,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1637,7 +1854,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1645,7 +1862,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1653,7 +1870,7 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -1661,7 +1878,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -1669,7 +1886,7 @@ The binary package name - not available yet Default value: `'bind_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1677,7 +1894,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1685,7 +1902,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1693,7 +1910,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `String[1]` @@ -1701,7 +1918,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` @@ -1709,7 +1926,7 @@ Name of the node exporter service (default 'bind_exporter') Default value: `'bind_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -1717,7 +1934,7 @@ User which runs the service Default value: `'bind-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -1725,7 +1942,7 @@ The binary release version Default value: `'0.4.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1734,7 +1951,7 @@ collecting on your prometheus server. Default value: ``false`` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -1744,7 +1961,7 @@ puppet module, the jobs to be collected are configured with Default value: `'bind'` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -1754,7 +1971,7 @@ overriding `extra_options`. Default value: `9119` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -1764,7 +1981,7 @@ be used. Default value: ``undef`` -### `prometheus::bird_exporter` +### `prometheus::bird_exporter` This module manages prometheus bird exporter @@ -1784,9 +2001,41 @@ class { 'prometheus::bird_exporter': #### Parameters -The following parameters are available in the `prometheus::bird_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::bird_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`env_vars`](#env_vars) +* [`env_file_path`](#env_file_path) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -1794,7 +2043,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -1802,7 +2051,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -1810,7 +2059,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -1818,7 +2067,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -1826,7 +2075,7 @@ Base URL for the binary archive Default value: `'https://github.com/czerwonk/bird_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -1834,7 +2083,7 @@ Extra groups to add the binary user to Default value: `['bird']` -##### `extra_options` +##### `extra_options` Data type: `String[1]` @@ -1842,7 +2091,7 @@ Extra options added to the startup command Default value: `'-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true'` -##### `group` +##### `group` Data type: `String[1]` @@ -1850,7 +2099,7 @@ Group under which the binary is running Default value: `'bird-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -1858,7 +2107,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -1866,7 +2115,7 @@ Installation method: url or package (only url is supported currently) Default value: `'url'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -1874,7 +2123,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -1882,7 +2131,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -1890,7 +2139,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -1898,7 +2147,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -1906,7 +2155,7 @@ If package, then use this for package ensure default 'latest' Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -1914,7 +2163,7 @@ The binary package name - not available yet Default value: `'bird_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -1922,7 +2171,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -1930,7 +2179,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1938,7 +2187,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1946,7 +2195,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1954,7 +2203,7 @@ Name of the bird exporter service (default 'bird_exporter') Default value: `'bird_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -1962,7 +2211,7 @@ User which runs the service Default value: `'bird-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -1970,7 +2219,7 @@ The binary release version Default value: `'1.2.5'` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -1978,7 +2227,7 @@ hash with custom environment variables thats passed to the exporter via init scr Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -1986,7 +2235,7 @@ The path to the file with the environmetn variable that is read from the init sc Default value: `$prometheus::env_file_path` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -1994,7 +2243,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2002,7 +2251,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2010,7 +2259,7 @@ Data type: `Stdlib::Port` Default value: `9324` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2018,7 +2267,7 @@ Data type: `String[1]` Default value: `'bird'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2026,7 +2275,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -2034,7 +2283,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::blackbox_exporter` +### `prometheus::blackbox_exporter` Example for configuring named blackbox modules via hiera details of the format: https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md @@ -2051,9 +2300,40 @@ prometheus::blackbox_exporter::modules: #### Parameters -The following parameters are available in the `prometheus::blackbox_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::blackbox_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`modules`](#modules) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`config_mode`](#config_mode) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -2061,7 +2341,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2069,19 +2349,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `String[1]` Absolute path to configuration file (blackbox module definitions) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2089,19 +2369,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -2109,13 +2389,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2123,7 +2403,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2131,7 +2411,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2139,7 +2419,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2147,7 +2427,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2155,7 +2435,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -2163,7 +2443,7 @@ Structured, array of blackbox module definitions for different probe types Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -2171,19 +2451,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2191,7 +2471,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2199,7 +2479,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2207,7 +2487,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -2215,19 +2495,19 @@ Name of the node exporter service (default 'blackbox_exporter') Default value: `'blackbox_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -2235,7 +2515,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2243,7 +2523,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2251,7 +2531,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2259,7 +2539,7 @@ Data type: `Stdlib::Port` Default value: `9115` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2267,7 +2547,7 @@ Data type: `String[1]` Default value: `'blackbox'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2275,15 +2555,43 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::collectd_exporter` +### `prometheus::collectd_exporter` This module manages prometheus node collectd_exporter #### Parameters -The following parameters are available in the `prometheus::collectd_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::collectd_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`options`](#options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -2291,7 +2599,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2299,13 +2607,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String[1]]` @@ -2313,25 +2621,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `options` +##### `options` Data type: `String` Options added to the startup command -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2339,7 +2647,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2347,7 +2655,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2355,7 +2663,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2363,7 +2671,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2371,7 +2679,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2379,19 +2687,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2399,7 +2707,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2407,7 +2715,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2415,7 +2723,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2423,25 +2731,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the collectd exporter service (default 'collectd_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2449,7 +2757,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2457,7 +2765,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2465,7 +2773,7 @@ Data type: `Stdlib::Port` Default value: `9103` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2473,7 +2781,7 @@ Data type: `String[1]` Default value: `'collectd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2481,19 +2789,53 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::config` +### `prometheus::config` Configuration class for prometheus monitoring system -### `prometheus::consul_exporter` +### `prometheus::consul_exporter` This module manages prometheus node consul_exporter #### Parameters -The following parameters are available in the `prometheus::consul_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::consul_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`consul_server`](#consul_server) +* [`consul_health_summary`](#consul_health_summary) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`log_level`](#log_level) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`web_listen_address`](#web_listen_address) +* [`web_telemetry_path`](#web_telemetry_path) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -2501,7 +2843,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2509,25 +2851,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `consul_server` +##### `consul_server` Data type: `String[1]` HTTP API address of a Consul server or agent. (prefix with https:// to connect over HTTPS) (default "http://localhost:8500") -##### `consul_health_summary` +##### `consul_health_summary` Data type: `Boolean` Generate a health summary for each service instance. Needs n+1 queries to collect all information. (default true) -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2535,19 +2877,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -2555,13 +2897,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2569,7 +2911,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2577,13 +2919,13 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `log_level` +##### `log_level` Data type: `String[1]` Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default "info") -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2591,7 +2933,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2599,7 +2941,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2607,7 +2949,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2615,19 +2957,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2635,7 +2977,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2643,7 +2985,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2651,7 +2993,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2659,37 +3001,37 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the consul exporter service (default 'consul_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `web_listen_address` +##### `web_listen_address` Data type: `String[1]` Address to listen on for web interface and telemetry. (default ":9107") -##### `web_telemetry_path` +##### `web_telemetry_path` Data type: `String[1]` Path under which to expose metrics. (default "/metrics") -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2697,7 +3039,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2705,7 +3047,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2713,7 +3055,7 @@ Data type: `Stdlib::Port` Default value: `9107` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2721,7 +3063,7 @@ Data type: `String[1]` Default value: `'consul'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2729,15 +3071,47 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::dellhw_exporter` +### `prometheus::dellhw_exporter` This module manages prometheus node dellhw_exporter #### Parameters -The following parameters are available in the `prometheus::dellhw_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::dellhw_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`omreport_path`](#omreport_path) +* [`scrape_ipadress`](#scrape_ipadress) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -2745,7 +3119,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -2753,7 +3127,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -2761,7 +3135,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -2769,7 +3143,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -2777,7 +3151,7 @@ Base URL for the binary archive Default value: `'https://github.com/galexrt/dellhw_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -2785,7 +3159,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -2793,7 +3167,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -2801,7 +3175,7 @@ Group under which the binary is running Default value: `'dellhw-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -2809,7 +3183,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -2817,7 +3191,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -2825,7 +3199,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2833,7 +3207,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -2841,7 +3215,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -2849,7 +3223,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -2857,7 +3231,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -2865,7 +3239,7 @@ The binary package name - not available yet Default value: `'dellhw_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -2873,7 +3247,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -2881,7 +3255,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -2889,7 +3263,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -2897,7 +3271,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -2905,7 +3279,7 @@ Name of the dellhw exporter service (default 'dellhw_exporter') Default value: `'dellhw_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -2913,7 +3287,7 @@ User which runs the service Default value: `'dellhw-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -2921,7 +3295,7 @@ The binary release version Default value: `'1.6.0'` -##### `omreport_path` +##### `omreport_path` Data type: `Stdlib::Unixpath` @@ -2929,7 +3303,7 @@ The file path to the omReport executable (default "/opt/dell/srvadmin/bin/omrepo Default value: `'/opt/dell/srvadmin/bin/omreport'` -##### `scrape_ipadress` +##### `scrape_ipadress` Data type: `String` @@ -2937,7 +3311,7 @@ The ip address that the exporter will to listen to (default '') Default value: `''` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -2945,7 +3319,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -2953,7 +3327,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -2961,7 +3335,7 @@ Data type: `Stdlib::Port` Default value: `9137` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -2969,7 +3343,7 @@ Data type: `String[1]` Default value: `'dellhw'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -2977,7 +3351,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -2985,15 +3359,47 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::elasticsearch_exporter` +### `prometheus::elasticsearch_exporter` This module manages prometheus elasticsearch_exporter #### Parameters -The following parameters are available in the `prometheus::elasticsearch_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::elasticsearch_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`cnf_uri`](#cnf_uri) +* [`cnf_timeout`](#cnf_timeout) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`user`](#user) +* [`version`](#version) +* [`use_kingpin`](#use_kingpin) +* [`service_name`](#service_name) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -3001,7 +3407,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3009,25 +3415,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_uri` +##### `cnf_uri` Data type: `String[1]` The URI to obtain elasticsearch stats from -##### `cnf_timeout` +##### `cnf_timeout` Data type: `String[1]` Timeout for trying to get stats from elasticsearch URI -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3035,19 +3441,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3055,13 +3461,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3069,7 +3475,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3077,7 +3483,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3085,7 +3491,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3093,7 +3499,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3101,7 +3507,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3109,19 +3515,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3129,7 +3535,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3137,7 +3543,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3145,7 +3551,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3153,19 +3559,19 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `use_kingpin` +##### `use_kingpin` Data type: `Boolean` @@ -3173,13 +3579,13 @@ Since version 1.1.0, the elasticsearch exporter uses kingpin, thus this param to define how we call the es.uri and es.timeout in the $options https://github.com/justwatchcom/elasticsearch_exporter/blob/v1.1.0/CHANGELOG.md -##### `service_name` +##### `service_name` Data type: `String[1]` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3187,7 +3593,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3195,7 +3601,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3203,7 +3609,7 @@ Data type: `Stdlib::Port` Default value: `9114` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3211,7 +3617,7 @@ Data type: `String[1]` Default value: `'elasticsearch'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3219,15 +3625,43 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::graphite_exporter` +### `prometheus::graphite_exporter` This module manages prometheus node graphite_exporter #### Parameters -The following parameters are available in the `prometheus::graphite_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::graphite_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`options`](#options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -3235,7 +3669,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3243,13 +3677,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3257,25 +3691,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `options` +##### `options` Data type: `String` Options added to the startup command -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3283,7 +3717,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3291,7 +3725,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3299,7 +3733,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3307,7 +3741,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3315,7 +3749,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3323,19 +3757,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3343,7 +3777,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3351,7 +3785,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3359,7 +3793,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3367,25 +3801,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the graphite exporter service (default 'graphite_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3393,7 +3827,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3401,7 +3835,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3409,7 +3843,7 @@ Data type: `Stdlib::Port` Default value: `9108` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3417,7 +3851,7 @@ Data type: `String[1]` Default value: `'graphite'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3425,15 +3859,47 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::grok_exporter` +### `prometheus::grok_exporter` This module manages prometheus grok_exporter #### Parameters -The following parameters are available in the `prometheus::grok_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::grok_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config`](#config) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -3441,7 +3907,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3449,20 +3915,20 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config` +##### `config` Data type: `Hash` Hash of configuration, see https://github.com/fstab/grok_exporter/blob/master/CONFIG.md for available options -##### `config_file` +##### `config_file` Data type: `String[1]` Path to config file, it will be generated from config param -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -3470,13 +3936,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3484,19 +3950,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3504,13 +3970,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3518,7 +3984,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3526,7 +3992,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3534,7 +4000,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3542,7 +4008,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3550,7 +4016,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3558,19 +4024,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3578,7 +4044,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3586,7 +4052,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3594,7 +4060,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3602,7 +4068,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -3610,19 +4076,19 @@ Name of the node exporter service (default 'grok_exporter') Default value: `'grok_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3630,7 +4096,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3638,7 +4104,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3646,7 +4112,7 @@ Data type: `Stdlib::Port` Default value: `9144` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3654,7 +4120,7 @@ Data type: `String[1]` Default value: `'grok'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3662,15 +4128,45 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::haproxy_exporter` +### `prometheus::haproxy_exporter` This module manages prometheus haproxy_exporter #### Parameters -The following parameters are available in the `prometheus::haproxy_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::haproxy_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`cnf_scrape_uri`](#cnf_scrape_uri) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -3678,7 +4174,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3686,19 +4182,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_scrape_uri` +##### `cnf_scrape_uri` Data type: `Variant[Stdlib::HTTPUrl, Pattern[/unix:(?:\/.+)+/]]` The URI to obtain HAProxy stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3706,19 +4202,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3726,13 +4222,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3740,7 +4236,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3748,7 +4244,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -3756,7 +4252,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -3764,7 +4260,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -3772,7 +4268,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -3780,19 +4276,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -3800,7 +4296,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -3808,7 +4304,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -3816,7 +4312,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -3824,25 +4320,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the haproxy exporter service (default 'haproxy_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -3850,7 +4346,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -3858,7 +4354,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -3866,7 +4362,7 @@ Data type: `Stdlib::Port` Default value: `9101` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -3874,7 +4370,7 @@ Data type: `String[1]` Default value: `'haproxy'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -3882,22 +4378,57 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::install` +### `prometheus::install` Install prometheus via different methods with parameters from init Currently only the install from url is implemented, when Prometheus will deliver packages for some Linux distros I will implement the package install method as well The package method needs specific yum or apt repo settings which are not made yet by the module -### `prometheus::ipmi_exporter` +### `prometheus::ipmi_exporter` This module manages prometheus node ipmi_exporter (https://github.com/soundcloud/ipmi_exporter) #### Parameters -The following parameters are available in the `prometheus::ipmi_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::ipmi_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`modules`](#modules) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`scrape_host`](#scrape_host) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) +* [`unprivileged`](#unprivileged) +* [`script_dir`](#script_dir) + +##### `arch` Data type: `String[1]` @@ -3905,7 +4436,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -3913,7 +4444,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -3921,7 +4452,7 @@ Path to IPMI exporter configuration file Default value: `'/etc/ipmi_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -3929,7 +4460,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -3937,7 +4468,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -3945,7 +4476,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -3953,7 +4484,7 @@ Base URL for the binary archive Default value: `'https://github.com/soundcloud/ipmi_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -3961,7 +4492,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -3969,7 +4500,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -3977,7 +4508,7 @@ Group under which the binary is running Default value: `'ipmi-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -3985,7 +4516,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -3993,7 +4524,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4001,7 +4532,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4009,7 +4540,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4017,7 +4548,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -4025,7 +4556,7 @@ Hash of IPMI exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -4033,7 +4564,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -4041,7 +4572,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -4049,7 +4580,7 @@ The binary package name - not available yet Default value: `'ipmi_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4057,7 +4588,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4065,7 +4596,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4073,7 +4604,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4081,7 +4612,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4089,7 +4620,7 @@ Name of the node exporter service (default 'ipmi_exporter') Default value: `'ipmi_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -4097,7 +4628,7 @@ User which runs the service Default value: `'ipmi-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -4105,7 +4636,7 @@ The binary release version Default value: `'1.4.0'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4113,7 +4644,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4121,7 +4652,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4129,7 +4660,7 @@ Data type: `Stdlib::Port` Default value: `9290` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4137,7 +4668,7 @@ Data type: `String[1]` Default value: `'ipmi'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4145,7 +4676,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -4153,7 +4684,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -##### `unprivileged` +##### `unprivileged` Data type: `Boolean` @@ -4161,7 +4692,7 @@ Data type: `Boolean` Default value: ``true`` -##### `script_dir` +##### `script_dir` Data type: `Stdlib::Absolutepath` @@ -4169,15 +4700,44 @@ Data type: `Stdlib::Absolutepath` Default value: `'/usr/local/bin'` -### `prometheus::ipsec_exporter` +### `prometheus::ipsec_exporter` This module manages prometheus node ipsec_exporter #### Parameters -The following parameters are available in the `prometheus::ipsec_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::ipsec_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`options`](#options) +* [`extra_groups`](#extra_groups) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -4185,7 +4745,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::AbsolutePath` @@ -4193,7 +4753,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String[1]` @@ -4201,7 +4761,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4209,7 +4769,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -4217,7 +4777,7 @@ Base URL for the binary archive Default value: `'https://github.com/dennisstritzke/ipsec_exporter/releases'` -##### `options` +##### `options` Data type: `String` @@ -4225,7 +4785,7 @@ Options added to the startup command Default value: `''` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -4233,7 +4793,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `group` +##### `group` Data type: `String[1]` @@ -4241,7 +4801,7 @@ Group under which the binary is running Default value: `'ipsec-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4249,7 +4809,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4257,7 +4817,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4265,7 +4825,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4273,7 +4833,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4281,7 +4841,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4289,7 +4849,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -4297,7 +4857,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -4305,7 +4865,7 @@ The binary package name - not available yet Default value: `'ipsec_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4313,7 +4873,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4321,7 +4881,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4329,7 +4889,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4337,7 +4897,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4345,7 +4905,7 @@ Name of the ipsec exporter service (default 'ipsec_exporter') Default value: `'ipsec_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -4353,7 +4913,7 @@ User which runs the service Default value: `'ipsec-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -4361,7 +4921,7 @@ The binary release version Default value: `'0.3.2'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4369,7 +4929,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4377,7 +4937,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4385,7 +4945,7 @@ Data type: `Stdlib::Port` Default value: `9536` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4393,7 +4953,7 @@ Data type: `String[1]` Default value: `'ipsec'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4401,15 +4961,45 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::memcached_exporter` +### `prometheus::memcached_exporter` This module manages prometheus node memcached_exporter #### Parameters -The following parameters are available in the `prometheus::memcached_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::memcached_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -4417,7 +5007,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -4425,7 +5015,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -4433,7 +5023,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4441,7 +5031,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -4449,7 +5039,7 @@ Base URL for the binary archive Default value: `'https://github.com/prometheus/memcached_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -4457,7 +5047,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -4465,7 +5055,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -4473,7 +5063,7 @@ Group under which the binary is running Default value: `'memcached-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4481,7 +5071,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4489,7 +5079,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4497,7 +5087,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4505,7 +5095,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4513,7 +5103,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4521,7 +5111,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -4529,7 +5119,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -4537,7 +5127,7 @@ The binary package name - not available yet Default value: `'memcached_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4545,7 +5135,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4553,7 +5143,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4561,7 +5151,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4569,7 +5159,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -4577,7 +5167,7 @@ Name of the memcached exporter service (default 'memcached_exporter') Default value: `'memcached_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -4585,7 +5175,7 @@ User which runs the service Default value: `'memcached-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -4593,7 +5183,7 @@ The binary release version Default value: `'0.6.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4601,7 +5191,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4609,7 +5199,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4617,7 +5207,7 @@ Data type: `Stdlib::Port` Default value: `9150` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4625,7 +5215,7 @@ Data type: `String[1]` Default value: `'memcached'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4633,7 +5223,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -4641,15 +5231,46 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::mesos_exporter` +### `prometheus::mesos_exporter` This module manages prometheus mesos_exporter #### Parameters -The following parameters are available in the `prometheus::mesos_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::mesos_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`server_type`](#server_type) +* [`cnf_scrape_uri`](#cnf_scrape_uri) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -4657,7 +5278,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -4665,25 +5286,25 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `server_type` +##### `server_type` Data type: `String[1]` Specify target type master or slave -##### `cnf_scrape_uri` +##### `cnf_scrape_uri` Data type: `String[1]` The URI to obtain mesos stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4691,19 +5312,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -4711,13 +5332,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4725,7 +5346,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4733,7 +5354,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4741,7 +5362,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4749,7 +5370,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4757,7 +5378,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4765,19 +5386,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -4785,7 +5406,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -4793,7 +5414,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -4801,7 +5422,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -4809,25 +5430,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the mesos exporter service (default 'mesos_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -4835,7 +5456,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -4843,7 +5464,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -4851,7 +5472,7 @@ Data type: `Stdlib::Port` Default value: `9105` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -4859,7 +5480,7 @@ Data type: `String[1]` Default value: `'mesos'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -4867,15 +5488,46 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::mongodb_exporter` +### `prometheus::mongodb_exporter` This module manages prometheus mongodb_exporter #### Parameters -The following parameters are available in the `prometheus::mongodb_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::mongodb_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`cnf_uri`](#cnf_uri) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`use_kingpin`](#use_kingpin) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -4883,7 +5535,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -4891,7 +5543,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `cnf_uri` +##### `cnf_uri` Data type: `String[1]` @@ -4899,7 +5551,7 @@ The URI to obtain MongoDB stats from Default value: `'mongodb://localhost:27017'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -4907,7 +5559,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -4915,7 +5567,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -4923,7 +5575,7 @@ Base URL for the binary archive Default value: `'https://github.com/percona/mongodb_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -4931,7 +5583,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -4939,7 +5591,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -4947,7 +5599,7 @@ Group under which the binary is running Default value: `'mongodb-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -4955,7 +5607,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -4963,7 +5615,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -4971,7 +5623,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -4979,7 +5631,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -4987,7 +5639,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -4995,7 +5647,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -5003,7 +5655,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -5011,7 +5663,7 @@ The binary package name - not available yet Default value: `'mongodb_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5019,7 +5671,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5027,7 +5679,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5035,7 +5687,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5043,7 +5695,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -5051,7 +5703,7 @@ Name of the mongodb exporter service (default 'mongodb_exporter') Default value: `'mongodb_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -5059,7 +5711,7 @@ User which runs the service Default value: `'mongodb-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -5067,7 +5719,7 @@ The binary release version Default value: `'0.20.4'` -##### `use_kingpin` +##### `use_kingpin` Data type: `Boolean` @@ -5077,7 +5729,7 @@ https://github.com/percona/mongodb_exporter/blob/v0.7.0/CHANGELOG.md Default value: ``true`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5085,7 +5737,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5093,7 +5745,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5101,7 +5753,7 @@ Data type: `Stdlib::Port` Default value: `9216` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5109,7 +5761,7 @@ Data type: `String[1]` Default value: `'mongodb'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5117,7 +5769,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::mysqld_exporter` +### `prometheus::mysqld_exporter` manages prometheus mysqld_exporter @@ -5126,9 +5778,45 @@ manages prometheus mysqld_exporter #### Parameters -The following parameters are available in the `prometheus::mysqld_exporter` class. - -##### `cnf_config_path` +The following parameters are available in the `prometheus::mysqld_exporter` class: + +* [`cnf_config_path`](#cnf_config_path) +* [`cnf_host`](#cnf_host) +* [`cnf_password`](#cnf_password) +* [`cnf_port`](#cnf_port) +* [`cnf_socket`](#cnf_socket) +* [`cnf_user`](#cnf_user) +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `cnf_config_path` Data type: `Stdlib::Absolutepath` @@ -5136,7 +5824,7 @@ The path to put the my.cnf file Default value: `'/etc/.my.cnf'` -##### `cnf_host` +##### `cnf_host` Data type: `Stdlib::Host` @@ -5144,7 +5832,7 @@ The mysql host. Default value: `localhost` -##### `cnf_password` +##### `cnf_password` Data type: `Variant[Sensitive[String],String]` @@ -5152,7 +5840,7 @@ The mysql user password. Default value: `'password'` -##### `cnf_port` +##### `cnf_port` Data type: `Stdlib::Port` @@ -5160,7 +5848,7 @@ The port for which the mysql host is running. Default value: `3306` -##### `cnf_socket` +##### `cnf_socket` Data type: `Optional[Stdlib::Absolutepath]` @@ -5168,7 +5856,7 @@ The socket which the mysql host is running. If defined, host and port are not us Default value: ``undef`` -##### `cnf_user` +##### `cnf_user` Data type: `String[1]` @@ -5176,7 +5864,7 @@ The mysql user to use when connecting. Default value: `login` -##### `arch` +##### `arch` Data type: `String[1]` @@ -5184,7 +5872,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5192,7 +5880,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -5200,13 +5888,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5214,19 +5902,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5234,13 +5922,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5248,7 +5936,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5256,7 +5944,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5264,7 +5952,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5272,7 +5960,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5280,7 +5968,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5288,19 +5976,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5308,7 +5996,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5316,7 +6004,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5324,7 +6012,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5332,25 +6020,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the mysqld exporter service (default 'mysqld_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5358,7 +6046,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5366,7 +6054,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5374,7 +6062,7 @@ Data type: `Stdlib::Port` Default value: `9104` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5382,7 +6070,7 @@ Data type: `String[1]` Default value: `'mysql'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5390,15 +6078,49 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::nginx_prometheus_exporter` +### `prometheus::nginx_prometheus_exporter` This module manages prometheus nginx exporter #### Parameters -The following parameters are available in the `prometheus::nginx_prometheus_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::nginx_prometheus_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`scrape_uri`](#scrape_uri) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) +* [`env_vars`](#env_vars) +* [`env_file_path`](#env_file_path) + +##### `arch` Data type: `String[1]` @@ -5406,7 +6128,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5414,7 +6136,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -5422,7 +6144,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -5430,7 +6152,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5438,7 +6160,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -5446,7 +6168,7 @@ Base URL for the binary archive Default value: `'https://github.com/nginxinc/nginx-prometheus-exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -5454,7 +6176,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5462,7 +6184,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -5470,7 +6192,7 @@ Group under which the binary is running Default value: `'nginx-prometheus-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5478,7 +6200,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5486,7 +6208,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5494,7 +6216,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5502,7 +6224,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5510,7 +6232,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -5518,7 +6240,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -5526,7 +6248,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -5534,7 +6256,7 @@ The binary package name - not available yet Default value: `'nginx-prometheus-exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5542,7 +6264,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5550,7 +6272,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `scrape_uri` +##### `scrape_uri` Data type: `String[1]` @@ -5558,7 +6280,7 @@ The URI for the nginx status or nginx plus api page Default value: `'http://localhost:8080/stub_status'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5566,7 +6288,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -5574,15 +6296,15 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` -Name of the node exporter service (default 'nginx_prometheus_exporter') +Name of the nginx prometheus exporter service (default 'nginx_prometheus_exporter') Default value: `'nginx_prometheus_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -5590,7 +6312,7 @@ User which runs the service Default value: `'nginx-prometheus-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -5598,7 +6320,7 @@ The binary release version Default value: `'0.9.0'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5606,7 +6328,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5614,7 +6336,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5622,7 +6344,7 @@ Data type: `Stdlib::Port` Default value: `9113` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5630,7 +6352,7 @@ Data type: `String[1]` Default value: `'nginx'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5638,7 +6360,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `String[1]` @@ -5646,7 +6368,7 @@ Data type: `String[1]` Default value: `'nginx-prometheus-exporter'` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -5654,7 +6376,7 @@ Data type: `Hash[String[1], Scalar]` Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -5662,15 +6384,45 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -### `prometheus::nginx_vts_exporter` +### `prometheus::nginx_vts_exporter` This module manages prometheus nginx_vts_exporter #### Parameters -The following parameters are available in the `prometheus::nginx_vts_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::nginx_vts_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`nginx_scrape_uri`](#nginx_scrape_uri) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String` @@ -5678,7 +6430,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `String` @@ -5686,19 +6438,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `nginx_scrape_uri` +##### `nginx_scrape_uri` Data type: `String` The URI to obtain nginx JSON stats from -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5706,19 +6458,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `String` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5726,13 +6478,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5740,7 +6492,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5748,7 +6500,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5756,7 +6508,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -5764,7 +6516,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -5772,7 +6524,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String` @@ -5780,19 +6532,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -5800,7 +6552,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -5808,7 +6560,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -5816,7 +6568,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `String` @@ -5824,25 +6576,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the nginx-vts exporter service (default 'nginx-vts-exporter') -##### `user` +##### `user` Data type: `String` User which runs the service -##### `version` +##### `version` Data type: `String` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -5850,7 +6602,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -5858,7 +6610,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -5866,7 +6618,7 @@ Data type: `Stdlib::Port` Default value: `9913` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -5874,7 +6626,7 @@ Data type: `String[1]` Default value: `'nginx_vts'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -5882,15 +6634,50 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::node_exporter` +### `prometheus::node_exporter` This module manages prometheus node node_exporter #### Parameters -The following parameters are available in the `prometheus::node_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::node_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`collectors`](#collectors) +* [`collectors_enable`](#collectors_enable) +* [`collectors_disable`](#collectors_disable) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`env_vars`](#env_vars) +* [`env_file_path`](#env_file_path) +* [`scrape_host`](#scrape_host) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -5898,7 +6685,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -5906,7 +6693,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `collectors` +##### `collectors` Data type: `Optional[Array[String]]` @@ -5915,7 +6702,7 @@ will be removed in next release Default value: ``undef`` -##### `collectors_enable` +##### `collectors_enable` Data type: `Array[String]` @@ -5924,7 +6711,7 @@ https://github.com/prometheus/node_exporter#enabled-by-default Default value: `[]` -##### `collectors_disable` +##### `collectors_disable` Data type: `Array[String]` @@ -5933,13 +6720,13 @@ https://github.com/prometheus/node_exporter#enabled-by-default Default value: `[]` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -5947,19 +6734,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -5967,13 +6754,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -5981,7 +6768,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -5989,7 +6776,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -5997,7 +6784,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6005,7 +6792,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6013,7 +6800,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6021,19 +6808,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6041,7 +6828,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6049,7 +6836,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6057,7 +6844,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6065,7 +6852,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6073,19 +6860,19 @@ Name of the node exporter service (default 'node_exporter') Default value: `'node_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -6093,7 +6880,7 @@ hash with custom environment variables thats passed to the exporter via init scr Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -6101,7 +6888,7 @@ The path to the file with the environmetn variable that is read from the init sc Default value: `$prometheus::env_file_path` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6109,7 +6896,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6117,7 +6904,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6125,7 +6912,7 @@ Data type: `Stdlib::Port` Default value: `9100` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6133,7 +6920,7 @@ Data type: `String[1]` Default value: `'node'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6141,7 +6928,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -6149,15 +6936,44 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::openldap_exporter` +### `prometheus::openldap_exporter` This module manages prometheus openldap_exporter #### Parameters -The following parameters are available in the `prometheus::openldap_exporter` class. - -##### `bin_dir` +The following parameters are available in the `prometheus::openldap_exporter` class: + +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`options`](#options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`ldap_binddn`](#ldap_binddn) +* [`ldap_password`](#ldap_password) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6165,7 +6981,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -6173,7 +6989,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6181,7 +6997,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -6189,7 +7005,7 @@ Base URL for the binary archive Default value: `'https://github.com/tomcz/openldap_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -6197,7 +7013,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `options` +##### `options` Data type: `String` @@ -6206,7 +7022,7 @@ Do not use for user/password authentication Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -6214,7 +7030,7 @@ Group under which the binary is running Default value: `'openldap-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6222,7 +7038,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6230,7 +7046,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6238,7 +7054,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6246,7 +7062,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6254,7 +7070,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6262,7 +7078,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -6270,7 +7086,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -6278,7 +7094,7 @@ The binary package name - not available yet Default value: `'openldap_exporter'` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6286,7 +7102,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6294,7 +7110,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6302,7 +7118,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6310,7 +7126,7 @@ Name of the node exporter service (default 'openldap_exporter') Default value: `'openldap_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -6318,7 +7134,7 @@ User which runs the service Default value: `'openldap-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -6326,7 +7142,7 @@ The binary release version Default value: `'2.1'` -##### `ldap_binddn` +##### `ldap_binddn` Data type: `Optional[String[1]]` @@ -6334,7 +7150,7 @@ DN (LDAP User) used to authenticate to openldap cn=monitor tree Default value: ``undef`` -##### `ldap_password` +##### `ldap_password` Data type: `Optional[String[1]]` @@ -6342,7 +7158,7 @@ Password used to authenticate to openldap cn=monitor tree Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6350,7 +7166,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6358,7 +7174,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6366,7 +7182,7 @@ Data type: `Stdlib::Port` Default value: `9330` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6374,7 +7190,7 @@ Data type: `String[1]` Default value: `'openldap'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6382,15 +7198,46 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::openvpn_exporter` +### `prometheus::openvpn_exporter` This module manages prometheus node openvpn_exporter #### Parameters -The following parameters are available in the `prometheus::openvpn_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::openvpn_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`status_paths`](#status_paths) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`scrape_host`](#scrape_host) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -6398,7 +7245,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6406,7 +7253,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `status_paths` +##### `status_paths` Data type: `Array[Stdlib::Absolutepath]` @@ -6414,7 +7261,7 @@ The openvpn status files to monitor with this exporter Default value: `[]` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -6422,7 +7269,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6430,7 +7277,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -6438,7 +7285,7 @@ Base URL for the binary archive Default value: `'https://github.com/wandera/openvpn_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -6446,7 +7293,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -6454,7 +7301,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -6462,7 +7309,7 @@ Group under which the binary is running Default value: `'openvpn-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6470,7 +7317,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6478,7 +7325,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6486,7 +7333,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6494,7 +7341,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6502,7 +7349,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6510,7 +7357,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -6518,7 +7365,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -6526,7 +7373,7 @@ The binary package name - not available yet Default value: `'openvpn_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6534,7 +7381,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6542,7 +7389,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6550,7 +7397,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6558,7 +7405,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6566,7 +7413,7 @@ Name of the openvpn exporter service (default 'openvpn_exporter') Default value: `'openvpn_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -6574,7 +7421,7 @@ User which runs the service Default value: `'openvpn-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -6582,7 +7429,7 @@ The binary release version Default value: `'v0.3.0.3'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6590,7 +7437,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6598,7 +7445,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6606,7 +7453,7 @@ Data type: `Stdlib::Port` Default value: `9176` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6614,7 +7461,7 @@ Data type: `String[1]` Default value: `'node'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6622,7 +7469,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -6630,7 +7477,313 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::postfix_exporter` +### `prometheus::php_fpm_exporter` + +This module manages prometheus php-fpm exporter + +#### Parameters + +The following parameters are available in the `prometheus::php_fpm_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`scrape_uri`](#scrape_uri) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) +* [`env_vars`](#env_vars) +* [`env_file_path`](#env_file_path) + +##### `arch` + +Data type: `String[1]` + +Architecture (amd64 or i386) + +Default value: `$prometheus::real_arch` + +##### `bin_dir` + +Data type: `Stdlib::Absolutepath` + +Directory where binaries are located + +Default value: `$prometheus::bin_dir` + +##### `config_mode` + +Data type: `String[1]` + +The permissions of the configuration files + +Default value: `$prometheus::config_mode` + +##### `download_extension` + +Data type: `String` + +Extension for the release binary archive + +Default value: `'tar.gz'` + +##### `download_url` + +Data type: `Optional[Prometheus::Uri]` + +Complete URL corresponding to the where the release binary archive can be downloaded + +Default value: ``undef`` + +##### `download_url_base` + +Data type: `Prometheus::Uri` + +Base URL for the binary archive + +Default value: `'https://github.com/hipages/php-fpm_exporter/releases'` + +##### `extra_groups` + +Data type: `Array[String[1]]` + +Extra groups to add the binary user to + +Default value: `[]` + +##### `extra_options` + +Data type: `String` + +Extra options added to the startup command + +Default value: `''` + +##### `group` + +Data type: `String[1]` + +Group under which the binary is running + +Default value: `'php-fpm_exporter'` + +##### `init_style` + +Data type: `Prometheus::Initstyle` + +Service startup scripts style (e.g. rc, upstart or systemd) + +Default value: `$facts['service_provider']` + +##### `install_method` + +Data type: `Prometheus::Install` + +Installation method: url or package (only url is supported currently) + +Default value: `$prometheus::install_method` + +##### `manage_group` + +Data type: `Boolean` + +Whether to create a group for or rely on external code for that + +Default value: ``true`` + +##### `manage_service` + +Data type: `Boolean` + +Should puppet manage the service? (default true) + +Default value: ``true`` + +##### `manage_user` + +Data type: `Boolean` + +Whether to create user or rely on external code for that + +Default value: ``true`` + +##### `os` + +Data type: `String[1]` + +Operating system (linux is the only one supported) + +Default value: `downcase($facts['kernel'])` + +##### `package_ensure` + +Data type: `String[1]` + +If package, then use this for package ensure default 'latest' + +Default value: `'latest'` + +##### `package_name` + +Data type: `String[1]` + +The binary package name - not available yet + +Default value: `'php-fpm_exporter'` + +##### `purge_config_dir` + +Data type: `Boolean` + +Purge config files no longer generated by Puppet + +Default value: ``true`` + +##### `restart_on_change` + +Data type: `Boolean` + +Should puppet restart the service on configuration change? (default true) + +Default value: ``true`` + +##### `scrape_uri` + +Data type: `String[1]` + +The URI for the nginx status or nginx plus api page + +Default value: `'tcp://127.0.0.1:9000/status'` + +##### `service_enable` + +Data type: `Boolean` + +Whether to enable the service from puppet (default true) + +Default value: ``true`` + +##### `service_ensure` + +Data type: `Stdlib::Ensure::Service` + +State ensured for the service (default 'running') + +Default value: `'running'` + +##### `service_name` + +Data type: `String[1]` + +Name of the php-fpm exporter service (default 'php-fpm_exporter') + +Default value: `'php-fpm_exporter'` + +##### `user` + +Data type: `String[1]` + +User which runs the service + +Default value: `'php-fpm_exporter'` + +##### `version` + +Data type: `String[1]` + +The binary release version + +Default value: `'2.0.4'` + +##### `export_scrape_job` + +Data type: `Boolean` + + + +Default value: ``false`` + +##### `scrape_host` + +Data type: `Optional[Stdlib::Host]` + + + +Default value: ``undef`` + +##### `scrape_port` + +Data type: `Stdlib::Port` + + + +Default value: `9253` + +##### `scrape_job_name` + +Data type: `String[1]` + + + +Default value: `'php-fpm'` + +##### `scrape_job_labels` + +Data type: `Optional[Hash]` + + + +Default value: ``undef`` + +##### `bin_name` + +Data type: `String[1]` + + + +Default value: `'php-fpm_exporter'` + +##### `env_vars` + +Data type: `Hash[String[1], Scalar]` + + + +Default value: `{}` + +##### `env_file_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$prometheus::env_file_path` + +### `prometheus::postfix_exporter` manages prometheus postfix_exporter @@ -6647,9 +7800,34 @@ include prometheus::postfix_exporter #### Parameters -The following parameters are available in the `prometheus::postfix_exporter` class. - -##### `install_method` +The following parameters are available in the `prometheus::postfix_exporter` class: + +* [`install_method`](#install_method) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`download_extension`](#download_extension) +* [`version`](#version) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`manage_user`](#manage_user) +* [`user`](#user) +* [`manage_group`](#manage_group) +* [`group`](#group) +* [`extra_groups`](#extra_groups) +* [`manage_service`](#manage_service) +* [`init_style`](#init_style) +* [`service_name`](#service_name) +* [`service_ensure`](#service_ensure) +* [`service_enable`](#service_enable) +* [`extra_options`](#extra_options) +* [`restart_on_change`](#restart_on_change) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`scrape_host`](#scrape_host) + +##### `install_method` Data type: `Prometheus::Install` @@ -6657,7 +7835,7 @@ Installation method: `url` or `package`. (Note `package` is not available on mos Default value: `'url'` -##### `download_url` +##### `download_url` Data type: `Optional[Stdlib::HTTPUrl]` @@ -6665,7 +7843,7 @@ Complete URL corresponding to the where the release can be downloaded. (This opt Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Stdlib::HTTPUrl` @@ -6673,7 +7851,7 @@ Base URL for the binary archive. (This option is only relevant when `install_met Default value: `'https://github.com/kumina/postfix_exporter/releases'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -6681,7 +7859,7 @@ Extension for the release binary archive. (This option is only relevant when `in Default value: `''` -##### `version` +##### `version` Data type: `String[1]` @@ -6689,7 +7867,7 @@ The binary release version. (This option is only relevant when `install_method` Default value: `'0.2.0'` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -6697,7 +7875,7 @@ Used when `install_method` is `package`. Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -6705,7 +7883,7 @@ Used when `install_method` is `package`. Default value: `'postfix_exporter'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6713,7 +7891,7 @@ Whether to create and manage the exporter's user. This can eg. be set to `false` Default value: ``true`` -##### `user` +##### `user` Data type: `String[1]` @@ -6721,7 +7899,7 @@ User which runs the service. Default value: `'postfix-exporter'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6729,7 +7907,7 @@ Whether to create and manage the exporter's group. This can eg. be set to `false Default value: ``true`` -##### `group` +##### `group` Data type: `String[1]` @@ -6737,7 +7915,7 @@ Group to run the service as. Default value: `'postfix-exporter'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` @@ -6745,7 +7923,7 @@ Extra groups to add the exporter user to. Default value: `[]` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6753,7 +7931,7 @@ Should puppet manage the service? Default value: ``true`` -##### `init_style` +##### `init_style` Data type: `Optional[Prometheus::Initstyle]` @@ -6763,7 +7941,7 @@ Typically this can be used when a package is already providing the file. Default value: ``undef`` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -6771,7 +7949,7 @@ The name of the service. Default value: `'postfix_exporter'` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6779,7 +7957,7 @@ Desired state for the service. Default value: `'running'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6787,7 +7965,7 @@ Whether to enable the service from puppet. Default value: ``true`` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -6795,7 +7973,7 @@ Extra options added to the startup command. Override these if you want to monito Default value: `'--systemd.enable --systemd.unit=\'postfix.service\' --postfix.logfile_path=\'\''` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6803,7 +7981,7 @@ Should puppet restart the service on configuration change? Default value: ``true`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -6811,7 +7989,7 @@ Whether to export a `prometheus::scrape_job` to puppetDB for collecting on your Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -6819,7 +7997,7 @@ The port to use in the scrape job. This won't normally need to be changed unles Default value: `9154` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -6827,7 +8005,7 @@ The name of the scrape job. When configuring prometheus with this puppet module, Default value: `'postfix'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -6835,7 +8013,7 @@ Labels to configure on the scrape job. If not set, the `prometheus::daemon` defa Default value: ``undef`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -6843,15 +8021,49 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -### `prometheus::postgres_exporter` +### `prometheus::postgres_exporter` This module manages prometheus node postgres_exporter #### Parameters -The following parameters are available in the `prometheus::postgres_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::postgres_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`data_source_custom`](#data_source_custom) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`postgres_user`](#postgres_user) +* [`postgres_pass`](#postgres_pass) +* [`postgres_auth_method`](#postgres_auth_method) +* [`data_source_uri`](#data_source_uri) +* [`options`](#options) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -6859,7 +8071,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -6867,7 +8079,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `data_source_custom` +##### `data_source_custom` Data type: `Hash[String[1],String[1]]` @@ -6875,13 +8087,13 @@ Hash of key:value pair to use for alternate environment variables when using par Default value: `{}` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -6889,25 +8101,25 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -6915,7 +8127,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -6923,7 +8135,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -6931,7 +8143,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -6939,7 +8151,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -6947,7 +8159,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -6955,19 +8167,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -6975,7 +8187,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -6983,7 +8195,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -6991,7 +8203,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -6999,7 +8211,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7007,19 +8219,19 @@ Name of the node exporter service (default 'postgres_exporter') Default value: `'postgres_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `postgres_user` +##### `postgres_user` Data type: `Optional[String]` @@ -7027,7 +8239,7 @@ User to authenticate against postgres Default value: ``undef`` -##### `postgres_pass` +##### `postgres_pass` Data type: `Optional[String]` @@ -7035,7 +8247,7 @@ Password to authenticate against postgres Default value: ``undef`` -##### `postgres_auth_method` +##### `postgres_auth_method` Data type: `Enum['custom', 'env', 'file']` @@ -7043,13 +8255,13 @@ method for presenting username and password to the exporter This can be file, or env (default 'env') Using 'custom' requires 'data_source_custom' values -##### `data_source_uri` +##### `data_source_uri` Data type: `String[1]` Uri on howto connect to the database -##### `options` +##### `options` Data type: `String` @@ -7057,7 +8269,7 @@ Data type: `String` Default value: `''` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7065,7 +8277,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7073,7 +8285,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7081,7 +8293,7 @@ Data type: `Stdlib::Port` Default value: `9187` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7089,7 +8301,7 @@ Data type: `String[1]` Default value: `'postgres'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7097,7 +8309,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::process_exporter` +### `prometheus::process_exporter` This module manages prometheus process_exporter @@ -7128,9 +8340,42 @@ class { 'prometheus::process_exporter': #### Parameters -The following parameters are available in the `prometheus::process_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::process_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`hash_watched_processes`](#hash_watched_processes) +* [`watched_processes`](#watched_processes) +* [`config_path`](#config_path) +* [`config_mode`](#config_mode) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -7138,7 +8383,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -7146,13 +8391,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -7160,19 +8405,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7180,13 +8425,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7194,7 +8439,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -7202,7 +8447,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7210,7 +8455,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7218,7 +8463,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7226,7 +8471,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7234,19 +8479,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -7254,7 +8499,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7262,7 +8507,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7270,7 +8515,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7278,25 +8523,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the process exporter service (default 'process-exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `hash_watched_processes` +##### `hash_watched_processes` Data type: `Hash` @@ -7305,7 +8550,7 @@ Don't set if you want to use only the Array version of it (watched_processes) Default value: `{}` -##### `watched_processes` +##### `watched_processes` Data type: `Array` @@ -7314,13 +8559,13 @@ Has no effect if hash_watched_processes is set Default value: `[]` -##### `config_path` +##### `config_path` Data type: `Stdlib::Absolutepath` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -7328,7 +8573,7 @@ Data type: `String[1]` Default value: `$prometheus::config_mode` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7336,7 +8581,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7344,7 +8589,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7352,7 +8597,7 @@ Data type: `Stdlib::Port` Default value: `9256` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7360,7 +8605,7 @@ Data type: `String[1]` Default value: `'process'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7368,15 +8613,46 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::puppetdb_exporter` +### `prometheus::puppetdb_exporter` This module manages prometheus node puppetdb_exporter #### Parameters -The following parameters are available in the `prometheus::puppetdb_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::puppetdb_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`puppetdb_url`](#puppetdb_url) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -7384,7 +8660,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -7392,7 +8668,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -7400,7 +8676,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -7408,7 +8684,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -7416,7 +8692,7 @@ Base URL for the binary archive Default value: `'https://github.com/camptocamp/prometheus-puppetdb-exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -7424,7 +8700,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7432,7 +8708,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -7440,7 +8716,7 @@ Group under which the binary is running Default value: `'puppetdb-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7448,7 +8724,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -7456,7 +8732,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7464,7 +8740,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7472,7 +8748,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7480,7 +8756,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7488,7 +8764,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -7496,7 +8772,7 @@ If package, then use this for package ensure default 'latest' Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -7504,7 +8780,7 @@ The binary package name - not available yet Default value: `'puppetdb_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -7512,7 +8788,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7520,7 +8796,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7528,7 +8804,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7536,7 +8812,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7544,7 +8820,7 @@ Name of the puppetdb exporter service (default 'puppetdb_exporter') Default value: `'puppetdb_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -7552,7 +8828,7 @@ User which runs the service Default value: `'puppetdb-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -7560,7 +8836,7 @@ The binary release version Default value: `'1.1.0'` -##### `puppetdb_url` +##### `puppetdb_url` Data type: `Stdlib::HTTPUrl` @@ -7568,7 +8844,7 @@ The URI to PuppetDB with http/https protocol at the beginning and `/pdb/query` a Default value: `'http://127.0.0.1:8080/pdb/query'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -7576,7 +8852,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -7584,7 +8860,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -7592,7 +8868,7 @@ Data type: `Stdlib::Port` Default value: `9635` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -7600,7 +8876,7 @@ Data type: `String[1]` Default value: `'puppetdb'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -7608,7 +8884,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -7616,15 +8892,38 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::pushgateway` +### `prometheus::pushgateway` This module manages prometheus node pushgateway #### Parameters -The following parameters are available in the `prometheus::pushgateway` class. - -##### `arch` +The following parameters are available in the `prometheus::pushgateway` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) + +##### `arch` Data type: `String[1]` @@ -7632,7 +8931,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `String[1]` @@ -7640,13 +8939,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -7654,19 +8953,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `String[1]` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7674,13 +8973,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7688,7 +8987,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -7696,7 +8995,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7704,7 +9003,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7712,7 +9011,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7720,7 +9019,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7728,19 +9027,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7748,7 +9047,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7756,7 +9055,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7764,7 +9063,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7772,27 +9071,54 @@ Name of the node exporter service (default 'pushgateway') Default value: `'pushgateway'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -### `prometheus::pushprox_client` +### `prometheus::pushprox_client` This module manages prometheus pushprox_client #### Parameters -The following parameters are available in the `prometheus::pushprox_client` class. - -##### `arch` +The following parameters are available in the `prometheus::pushprox_client` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`env_vars`](#env_vars) +* [`proxy_url`](#proxy_url) + +##### `arch` Data type: `String[1]` @@ -7800,7 +9126,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -7808,7 +9134,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -7816,13 +9142,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -7830,19 +9156,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -7850,13 +9176,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -7864,7 +9190,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -7872,7 +9198,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -7880,7 +9206,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -7888,7 +9214,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -7896,7 +9222,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -7904,19 +9230,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -7924,7 +9250,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -7932,7 +9258,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -7940,7 +9266,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -7948,7 +9274,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -7956,19 +9282,19 @@ Name of the pushprox_client service (default 'pushprox_client') Default value: `'pushprox_client'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `env_vars` +##### `env_vars` Data type: `Hash[String, Scalar]` @@ -7976,21 +9302,46 @@ The environment variable to pass to the daemon Default value: `{}` -##### `proxy_url` +##### `proxy_url` Data type: `String[1]` -### `prometheus::pushprox_proxy` +### `prometheus::pushprox_proxy` This module manages prometheus pushprox_proxy #### Parameters -The following parameters are available in the `prometheus::pushprox_proxy` class. - -##### `arch` +The following parameters are available in the `prometheus::pushprox_proxy` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) + +##### `arch` Data type: `String[1]` @@ -7998,7 +9349,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8006,7 +9357,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -8014,13 +9365,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String[1]` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -8028,19 +9379,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String[1]]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8048,13 +9399,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8062,7 +9413,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `String[1]` @@ -8070,7 +9421,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8078,7 +9429,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8086,7 +9437,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8094,7 +9445,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8102,19 +9453,19 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8122,7 +9473,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8130,7 +9481,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8138,7 +9489,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8146,7 +9497,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8154,27 +9505,64 @@ Name of the pushprox_proxy service (default 'pushprox_proxy') Default value: `'pushprox_proxy'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -### `prometheus::rabbitmq_exporter` +### `prometheus::rabbitmq_exporter` This module manages prometheus rabbitmq_exporter #### Parameters -The following parameters are available in the `prometheus::rabbitmq_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::rabbitmq_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`rabbit_url`](#rabbit_url) +* [`rabbit_user`](#rabbit_user) +* [`rabbit_password`](#rabbit_password) +* [`queues_include_regex`](#queues_include_regex) +* [`queues_exclude_regex`](#queues_exclude_regex) +* [`rabbit_capabilities`](#rabbit_capabilities) +* [`rabbit_exporters`](#rabbit_exporters) +* [`extra_env_vars`](#extra_env_vars) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -8182,7 +9570,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8190,13 +9578,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -8204,19 +9592,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8224,13 +9612,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8238,7 +9626,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -8246,7 +9634,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8254,7 +9642,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8262,7 +9650,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8270,7 +9658,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8278,19 +9666,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8298,7 +9686,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8306,7 +9694,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8314,7 +9702,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8322,69 +9710,69 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the rabbitmq exporter service (default 'rabbitmq_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `rabbit_url` +##### `rabbit_url` Data type: `String[1]` URL of the RabbitMQ management plugin -##### `rabbit_user` +##### `rabbit_user` Data type: `String[1]` User to authenticate against RabbitMQ -##### `rabbit_password` +##### `rabbit_password` Data type: `String[1]` Password to authenticate against RabbitMQ -##### `queues_include_regex` +##### `queues_include_regex` Data type: `String[1]` Regular expression used by the exported to chose which queues to export -##### `queues_exclude_regex` +##### `queues_exclude_regex` Data type: `String[1]` Regular expression used by the exported to chose which queues NOT to export -##### `rabbit_capabilities` +##### `rabbit_capabilities` Data type: `Array[String]` Special capabilities supported by the RabbitMQ version. See README for more details. (default '') -##### `rabbit_exporters` +##### `rabbit_exporters` Data type: `Array[String]` Which exporter modules should be loaded by default (default 'exchange,node,overview,queue') -##### `extra_env_vars` +##### `extra_env_vars` Data type: `Hash[String,String]` @@ -8393,7 +9781,7 @@ Additional environment variables that should be supplied to the exporter, as a h Default value: `{}` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -8401,7 +9789,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -8409,7 +9797,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -8417,7 +9805,7 @@ Data type: `Stdlib::Port` Default value: `9090` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -8425,7 +9813,7 @@ Data type: `String[1]` Default value: `'rabbitmq'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -8433,15 +9821,46 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::redis_exporter` +### `prometheus::redis_exporter` This module manages prometheus node redis_exporter #### Parameters -The following parameters are available in the `prometheus::redis_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::redis_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`addr`](#addr) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`namespace`](#namespace) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -8449,7 +9868,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8457,19 +9876,19 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `addr` +##### `addr` Data type: `Array[String]` Array of address of one or more redis nodes. Defaults to redis://localhost:6379 -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -8477,19 +9896,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8499,13 +9918,13 @@ please refer to https://github.com/oliver006/redis_exporter Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8513,7 +9932,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -8521,7 +9940,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8529,7 +9948,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8537,7 +9956,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8545,7 +9964,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `namespace` +##### `namespace` Data type: `String[1]` @@ -8553,7 +9972,7 @@ Namespace for the metrics, defaults to `redis`. Default value: `'redis'` -##### `os` +##### `os` Data type: `String[1]` @@ -8561,19 +9980,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8581,7 +10000,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8589,7 +10008,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8597,7 +10016,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8605,7 +10024,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8613,19 +10032,19 @@ Name of the node exporter service (default 'redis_exporter') Default value: `'redis_exporter'` -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -8633,7 +10052,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -8641,7 +10060,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -8649,7 +10068,7 @@ Data type: `Stdlib::Port` Default value: `9121` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -8657,7 +10076,7 @@ Data type: `String[1]` Default value: `'redis'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -8665,19 +10084,51 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::run_service` +### `prometheus::run_service` This class is meant to be called from prometheus. It ensure the service is running -### `prometheus::sachet` +### `prometheus::sachet` This module manages prometheus sachet (https://github.com/messagebird/sachet) #### Parameters -The following parameters are available in the `prometheus::sachet` class. - -##### `arch` +The following parameters are available in the `prometheus::sachet` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`templates`](#templates) +* [`receivers`](#receivers) +* [`providers`](#providers) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`config_dir`](#config_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`listen_port`](#listen_port) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -8685,7 +10136,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -8693,7 +10144,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -8701,7 +10152,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -8709,7 +10160,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -8717,7 +10168,7 @@ Base URL for the binary archive Default value: `'https://github.com/messagebird/sachet/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -8725,7 +10176,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -8733,7 +10184,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -8741,7 +10192,7 @@ Group under which the binary is running Default value: `'sachet'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -8749,7 +10200,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$prometheus::init_style` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -8757,7 +10208,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -8765,7 +10216,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -8773,7 +10224,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -8781,7 +10232,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -8789,7 +10240,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -8797,7 +10248,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -8805,7 +10256,7 @@ The binary package name - not available yet Default value: `'sachet'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -8813,7 +10264,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `templates` +##### `templates` Data type: `Array` @@ -8839,7 +10290,7 @@ prometheus::sachet::templates: Default value: `[]` -##### `receivers` +##### `receivers` Data type: `Array` @@ -8852,7 +10303,7 @@ prometheus::sachet::receivers: Default value: `[]` -##### `providers` +##### `providers` Data type: `Hash` @@ -8865,7 +10316,7 @@ prometheus::sachet::providers: Default value: `{}` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -8873,7 +10324,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -8881,7 +10332,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -8889,7 +10340,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -8897,7 +10348,7 @@ Name of the node exporter service (default 'sachet') Default value: `'sachet'` -##### `user` +##### `user` Data type: `String[1]` @@ -8905,7 +10356,7 @@ User which runs the service Default value: `'sachet'` -##### `version` +##### `version` Data type: `String[1]` @@ -8913,7 +10364,7 @@ The binary release version Default value: `'0.2.6'` -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Absolutepath` @@ -8921,7 +10372,7 @@ Data type: `Stdlib::Absolutepath` Default value: `'/etc/sachet'` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -8929,7 +10380,7 @@ Data type: `Stdlib::Absolutepath` Default value: `'/etc/sachet/sachet.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -8937,7 +10388,7 @@ Data type: `String[1]` Default value: `$prometheus::config_mode` -##### `listen_port` +##### `listen_port` Data type: `Stdlib::Port` @@ -8945,7 +10396,7 @@ Data type: `Stdlib::Port` Default value: `9876` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -8953,15 +10404,65 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::server` +### `prometheus::server` class to manage the actual prometheus server. This class gets called from the init.pp #### Parameters -The following parameters are available in the `prometheus::server` class. - -##### `configname` +The following parameters are available in the `prometheus::server` class: + +* [`configname`](#configname) +* [`user`](#user) +* [`group`](#group) +* [`extra_groups`](#extra_groups) +* [`bin_dir`](#bin_dir) +* [`shared_dir`](#shared_dir) +* [`version`](#version) +* [`install_method`](#install_method) +* [`download_url_base`](#download_url_base) +* [`download_extension`](#download_extension) +* [`package_name`](#package_name) +* [`package_ensure`](#package_ensure) +* [`config_dir`](#config_dir) +* [`localstorage`](#localstorage) +* [`config_template`](#config_template) +* [`config_mode`](#config_mode) +* [`global_config`](#global_config) +* [`rule_files`](#rule_files) +* [`scrape_configs`](#scrape_configs) +* [`include_default_scrape_configs`](#include_default_scrape_configs) +* [`remote_read_configs`](#remote_read_configs) +* [`remote_write_configs`](#remote_write_configs) +* [`alerts`](#alerts) +* [`alert_relabel_config`](#alert_relabel_config) +* [`alertmanagers_config`](#alertmanagers_config) +* [`storage_retention`](#storage_retention) +* [`env_file_path`](#env_file_path) +* [`extra_alerts`](#extra_alerts) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`manage_service`](#manage_service) +* [`restart_on_change`](#restart_on_change) +* [`init_style`](#init_style) +* [`extra_options`](#extra_options) +* [`config_hash`](#config_hash) +* [`config_defaults`](#config_defaults) +* [`os`](#os) +* [`download_url`](#download_url) +* [`arch`](#arch) +* [`manage_group`](#manage_group) +* [`purge_config_dir`](#purge_config_dir) +* [`manage_user`](#manage_user) +* [`manage_config`](#manage_config) +* [`external_url`](#external_url) +* [`collect_scrape_jobs`](#collect_scrape_jobs) +* [`collect_tag`](#collect_tag) +* [`max_open_files`](#max_open_files) +* [`usershell`](#usershell) + +##### `configname` Data type: `String` @@ -8969,7 +10470,7 @@ Data type: `String` Default value: `$prometheus::configname` -##### `user` +##### `user` Data type: `String` @@ -8977,7 +10478,7 @@ Data type: `String` Default value: `$prometheus::user` -##### `group` +##### `group` Data type: `String` @@ -8985,7 +10486,7 @@ Data type: `String` Default value: `$prometheus::group` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -8993,7 +10494,7 @@ Data type: `Array` Default value: `$prometheus::extra_groups` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9001,7 +10502,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::bin_dir` -##### `shared_dir` +##### `shared_dir` Data type: `Stdlib::Absolutepath` @@ -9009,7 +10510,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::shared_dir` -##### `version` +##### `version` Data type: `String` @@ -9017,7 +10518,7 @@ Data type: `String` Default value: `$prometheus::version` -##### `install_method` +##### `install_method` Data type: `String` @@ -9025,7 +10526,7 @@ Data type: `String` Default value: `$prometheus::install_method` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -9033,7 +10534,7 @@ Data type: `Prometheus::Uri` Default value: `$prometheus::download_url_base` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -9041,7 +10542,7 @@ Data type: `String` Default value: `$prometheus::download_extension` -##### `package_name` +##### `package_name` Data type: `String` @@ -9049,7 +10550,7 @@ Data type: `String` Default value: `$prometheus::package_name` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -9057,7 +10558,7 @@ Data type: `String` Default value: `$prometheus::package_ensure` -##### `config_dir` +##### `config_dir` Data type: `String` @@ -9065,7 +10566,7 @@ Data type: `String` Default value: `$prometheus::config_dir` -##### `localstorage` +##### `localstorage` Data type: `Variant[Stdlib::Absolutepath, Boolean[false]]` @@ -9073,7 +10574,7 @@ Data type: `Variant[Stdlib::Absolutepath, Boolean[false]]` Default value: `$prometheus::localstorage` -##### `config_template` +##### `config_template` Data type: `String` @@ -9081,7 +10582,7 @@ Data type: `String` Default value: `$prometheus::config_template` -##### `config_mode` +##### `config_mode` Data type: `String` @@ -9089,7 +10590,7 @@ Data type: `String` Default value: `$prometheus::config_mode` -##### `global_config` +##### `global_config` Data type: `Hash` @@ -9097,7 +10598,7 @@ Data type: `Hash` Default value: `$prometheus::global_config` -##### `rule_files` +##### `rule_files` Data type: `Array` @@ -9105,7 +10606,7 @@ Data type: `Array` Default value: `$prometheus::rule_files` -##### `scrape_configs` +##### `scrape_configs` Data type: `Array` @@ -9113,7 +10614,7 @@ Data type: `Array` Default value: `$prometheus::scrape_configs` -##### `include_default_scrape_configs` +##### `include_default_scrape_configs` Data type: `Boolean` @@ -9121,7 +10622,7 @@ Data type: `Boolean` Default value: `$prometheus::include_default_scrape_configs` -##### `remote_read_configs` +##### `remote_read_configs` Data type: `Array` @@ -9129,7 +10630,7 @@ Data type: `Array` Default value: `$prometheus::remote_read_configs` -##### `remote_write_configs` +##### `remote_write_configs` Data type: `Array` @@ -9137,7 +10638,7 @@ Data type: `Array` Default value: `$prometheus::remote_write_configs` -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` @@ -9145,7 +10646,7 @@ Data type: `Variant[Array,Hash]` Default value: `$prometheus::alerts` -##### `alert_relabel_config` +##### `alert_relabel_config` Data type: `Array` @@ -9153,7 +10654,7 @@ Data type: `Array` Default value: `$prometheus::alert_relabel_config` -##### `alertmanagers_config` +##### `alertmanagers_config` Data type: `Array` @@ -9161,7 +10662,7 @@ Data type: `Array` Default value: `$prometheus::alertmanagers_config` -##### `storage_retention` +##### `storage_retention` Data type: `Variant[String, Boolean[false]]` @@ -9169,7 +10670,7 @@ Data type: `Variant[String, Boolean[false]]` Default value: `$prometheus::storage_retention` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -9177,7 +10678,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -##### `extra_alerts` +##### `extra_alerts` Data type: `Hash` @@ -9185,7 +10686,7 @@ Data type: `Hash` Default value: `$prometheus::extra_alerts` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9193,7 +10694,7 @@ Data type: `Boolean` Default value: `$prometheus::service_enable` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9201,7 +10702,7 @@ Data type: `Stdlib::Ensure::Service` Default value: `$prometheus::service_ensure` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -9209,7 +10710,7 @@ Data type: `String[1]` Default value: `$prometheus::service_name` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9217,7 +10718,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_service` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9225,7 +10726,7 @@ Data type: `Boolean` Default value: `$prometheus::restart_on_change` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9233,7 +10734,7 @@ Data type: `Prometheus::Initstyle` Default value: `$facts['service_provider']` -##### `extra_options` +##### `extra_options` Data type: `Optional[String[1]]` @@ -9241,7 +10742,7 @@ Data type: `Optional[String[1]]` Default value: `$prometheus::extra_options` -##### `config_hash` +##### `config_hash` Data type: `Hash` @@ -9249,7 +10750,7 @@ Data type: `Hash` Default value: `$prometheus::config_hash` -##### `config_defaults` +##### `config_defaults` Data type: `Hash` @@ -9257,7 +10758,7 @@ Data type: `Hash` Default value: `$prometheus::config_defaults` -##### `os` +##### `os` Data type: `String[1]` @@ -9265,7 +10766,7 @@ Data type: `String[1]` Default value: `$prometheus::os` -##### `download_url` +##### `download_url` Data type: `Optional[String]` @@ -9273,7 +10774,7 @@ Data type: `Optional[String]` Default value: `$prometheus::download_url` -##### `arch` +##### `arch` Data type: `String[1]` @@ -9281,7 +10782,7 @@ Data type: `String[1]` Default value: `$prometheus::real_arch` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9289,7 +10790,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_group` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9297,7 +10798,7 @@ Data type: `Boolean` Default value: `$prometheus::purge_config_dir` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9305,7 +10806,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_user` -##### `manage_config` +##### `manage_config` Data type: `Boolean` @@ -9313,7 +10814,7 @@ Data type: `Boolean` Default value: `$prometheus::manage_config` -##### `external_url` +##### `external_url` Data type: `Optional[Variant[Stdlib::HTTPurl, Stdlib::Unixpath, String[1]]]` @@ -9321,7 +10822,7 @@ Data type: `Optional[Variant[Stdlib::HTTPurl, Stdlib::Unixpath, String[1]]]` Default value: `$prometheus::external_url` -##### `collect_scrape_jobs` +##### `collect_scrape_jobs` Data type: `Optional[Array[Hash[String[1], Any]]]` @@ -9329,7 +10830,7 @@ Data type: `Optional[Array[Hash[String[1], Any]]]` Default value: `$prometheus::collect_scrape_jobs` -##### `collect_tag` +##### `collect_tag` Data type: `Optional[String[1]]` @@ -9337,7 +10838,7 @@ Data type: `Optional[String[1]]` Default value: `$prometheus::collect_tag` -##### `max_open_files` +##### `max_open_files` Data type: `Optional[Integer]` @@ -9345,7 +10846,7 @@ Data type: `Optional[Integer]` Default value: `$prometheus::max_open_files` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` @@ -9353,15 +10854,47 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::usershell` -### `prometheus::snmp_exporter` +### `prometheus::snmp_exporter` This module manages prometheus snmp_exporter #### Parameters -The following parameters are available in the `prometheus::snmp_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::snmp_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`config_template`](#config_template) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -9369,7 +10902,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9377,13 +10910,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `String[1]` Absolute path to configuration file -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -9391,19 +10924,19 @@ Configuration file mode (default 0660) Default value: `$prometheus::config_mode` -##### `config_template` +##### `config_template` Data type: `String` Configuration template to use. If empty, uses upstream config (default "") -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9411,19 +10944,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9431,13 +10964,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9445,7 +10978,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9453,7 +10986,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9461,7 +10994,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9469,7 +11002,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9477,7 +11010,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -9485,19 +11018,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9505,7 +11038,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9513,7 +11046,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9521,7 +11054,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9529,25 +11062,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the snmp exporter service (default 'snmp_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -9555,7 +11088,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -9563,7 +11096,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -9571,7 +11104,7 @@ Data type: `Stdlib::Port` Default value: `9116` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -9579,7 +11112,7 @@ Data type: `String[1]` Default value: `'snmp'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -9587,15 +11120,48 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::ssh_exporter` +### `prometheus::ssh_exporter` This module manages prometheus ssh_exporter (https://github.com/treydock/ssh_exporter) #### Parameters -The following parameters are available in the `prometheus::ssh_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::ssh_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`modules`](#modules) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`scrape_host`](#scrape_host) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -9603,7 +11169,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9611,7 +11177,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -9619,7 +11185,7 @@ Path to SSH exporter configuration file Default value: `'/etc/ssh_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -9627,7 +11193,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -9635,7 +11201,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9643,7 +11209,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -9651,7 +11217,7 @@ Base URL for the binary archive Default value: `'https://github.com/treydock/ssh_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -9659,7 +11225,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9667,7 +11233,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -9675,7 +11241,7 @@ Group under which the binary is running Default value: `'ssh-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9683,7 +11249,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9691,7 +11257,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9699,7 +11265,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9707,7 +11273,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9715,7 +11281,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -9723,7 +11289,7 @@ Hash of SSH exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -9731,7 +11297,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -9739,7 +11305,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -9747,7 +11313,7 @@ The binary package name - not available yet Default value: `'ssh_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -9755,7 +11321,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -9763,7 +11329,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -9771,7 +11337,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -9779,7 +11345,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -9787,7 +11353,7 @@ Name of the node exporter service (default 'ssh_exporter') Default value: `'ssh_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -9795,7 +11361,7 @@ User which runs the service Default value: `'ssh-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -9803,7 +11369,7 @@ The binary release version Default value: `'1.2.0'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -9811,7 +11377,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -9819,7 +11385,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -9827,7 +11393,7 @@ Data type: `Stdlib::Port` Default value: `9312` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -9835,7 +11401,7 @@ Data type: `String[1]` Default value: `'ssh'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -9843,7 +11409,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -9851,15 +11417,48 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::ssl_exporter` +### `prometheus::ssl_exporter` This module manages prometheus ssl_exporter (https://github.com/ribbybibby/ssl_exporter) #### Parameters -The following parameters are available in the `prometheus::ssl_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::ssl_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_file`](#config_file) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`modules`](#modules) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`scrape_host`](#scrape_host) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) + +##### `arch` Data type: `String[1]` @@ -9867,7 +11466,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -9875,7 +11474,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_file` +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -9883,7 +11482,7 @@ Path to SSL exporter configuration file Default value: `'/etc/ssl_exporter.yaml'` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -9891,7 +11490,7 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -9899,7 +11498,7 @@ Extension for the release binary archive Default value: `'tar.gz'` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -9907,7 +11506,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -9915,7 +11514,7 @@ Base URL for the binary archive Default value: `'https://github.com/ribbybibby/ssl_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -9923,7 +11522,7 @@ Extra groups to add the binary user to Default value: `[]` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -9931,7 +11530,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -9939,7 +11538,7 @@ Group under which the binary is running Default value: `'ssl-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -9947,7 +11546,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -9955,7 +11554,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -9963,7 +11562,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -9971,7 +11570,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -9979,7 +11578,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `modules` +##### `modules` Data type: `Hash` @@ -9987,7 +11586,7 @@ Hash of SSL exporter modules Default value: `{}` -##### `os` +##### `os` Data type: `String[1]` @@ -9995,7 +11594,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -10003,7 +11602,7 @@ If package, then use this for package ensure default 'latest' Default value: `'latest'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -10011,7 +11610,7 @@ The binary package name - not available yet Default value: `'ssl_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10019,7 +11618,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10027,7 +11626,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10035,7 +11634,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10043,7 +11642,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -10051,7 +11650,7 @@ Name of the node exporter service (default 'ssk_exporter') Default value: `'ssl_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -10059,7 +11658,7 @@ User which runs the service Default value: `'ssl-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -10067,7 +11666,7 @@ The binary release version Default value: `'2.2.1'` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -10075,7 +11674,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -10083,7 +11682,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -10091,7 +11690,7 @@ Data type: `Stdlib::Port` Default value: `9219` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -10099,7 +11698,7 @@ Data type: `String[1]` Default value: `'ssl'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -10107,7 +11706,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -10115,15 +11714,47 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -### `prometheus::statsd_exporter` +### `prometheus::statsd_exporter` This module manages prometheus statsd_exporter #### Parameters -The following parameters are available in the `prometheus::statsd_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::statsd_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`config_mode`](#config_mode) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`mappings`](#mappings) +* [`user`](#user) +* [`version`](#version) +* [`mapping_config_path`](#mapping_config_path) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -10131,7 +11762,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10139,7 +11770,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `config_mode` +##### `config_mode` Data type: `String[1]` @@ -10147,13 +11778,13 @@ The permissions of the configuration files Default value: `$prometheus::config_mode` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -10161,19 +11792,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -10181,13 +11812,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10195,7 +11826,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10203,7 +11834,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10211,7 +11842,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10219,7 +11850,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10227,7 +11858,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -10235,19 +11866,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10255,7 +11886,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10263,7 +11894,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10271,7 +11902,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10279,13 +11910,13 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the statsd exporter service (default 'statsd_exporter') -##### `mappings` +##### `mappings` Data type: `Array[Hash]` @@ -10296,25 +11927,25 @@ The hiera array for mappings: processor: '$2' action: '$1' -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `mapping_config_path` +##### `mapping_config_path` Data type: `Stdlib::Absolutepath` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -10322,7 +11953,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -10330,7 +11961,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -10338,7 +11969,7 @@ Data type: `Stdlib::Port` Default value: `9102` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -10346,7 +11977,7 @@ Data type: `String[1]` Default value: `'statsd'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -10354,7 +11985,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -### `prometheus::unbound_exporter` +### `prometheus::unbound_exporter` This module manages prometheus unbound exporter. The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21) @@ -10363,9 +11994,39 @@ This module manages prometheus unbound exporter. The exporter needs to be compil #### Parameters -The following parameters are available in the `prometheus::unbound_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::unbound_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`bin_name`](#bin_name) +* [`env_vars`](#env_vars) + +##### `arch` Data type: `String[1]` @@ -10373,7 +12034,7 @@ Architecture Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10381,7 +12042,7 @@ Directory where binaries are located Default value: `'/usr/local/bin'` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -10389,7 +12050,7 @@ Extension for the release binary archive Default value: `''` -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -10397,7 +12058,7 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` @@ -10405,7 +12066,7 @@ Base URL for the binary archive Default value: `'https://github.com/kumina/unbound_exporter/releases'` -##### `extra_groups` +##### `extra_groups` Data type: `Array[String]` @@ -10413,7 +12074,7 @@ Extra groups to add the binary user to Default value: `['unbound']` -##### `extra_options` +##### `extra_options` Data type: `String` @@ -10421,7 +12082,7 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` @@ -10429,7 +12090,7 @@ Group under which the binary is running Default value: `'unbound-exporter'` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10437,7 +12098,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10445,7 +12106,7 @@ Installation method: url or package (only url is supported currently) Default value: `'none'` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10453,7 +12114,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10461,7 +12122,7 @@ Should puppet manage the service? Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10469,7 +12130,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -10477,7 +12138,7 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -10485,7 +12146,7 @@ If package, then use this for package ensure Default value: `'installed'` -##### `package_name` +##### `package_name` Data type: `String[1]` @@ -10493,7 +12154,7 @@ The binary package name - not available yet Default value: `'unbound_exporter'` -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10501,7 +12162,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10509,7 +12170,7 @@ Should puppet restart the service on configuration change? Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10517,7 +12178,7 @@ Whether to enable the service from puppet Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10525,7 +12186,7 @@ State ensured for the service Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -10533,7 +12194,7 @@ Name of the unbound exporter service Default value: `'unbound_exporter'` -##### `user` +##### `user` Data type: `String[1]` @@ -10541,7 +12202,7 @@ User which runs the service Default value: `'unbound-exporter'` -##### `version` +##### `version` Data type: `String[1]` @@ -10549,7 +12210,7 @@ The binary release version Default value: `'0.3'` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -10557,7 +12218,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -10565,7 +12226,7 @@ Data type: `Stdlib::Port` Default value: `9167` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -10573,7 +12234,7 @@ Data type: `String[1]` Default value: `'unbound'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -10581,7 +12242,7 @@ Data type: `Optional[Hash]` Default value: ``undef`` -##### `bin_name` +##### `bin_name` Data type: `Optional[String[1]]` @@ -10589,7 +12250,7 @@ Data type: `Optional[String[1]]` Default value: ``undef`` -##### `env_vars` +##### `env_vars` Data type: `Hash` @@ -10597,15 +12258,44 @@ Data type: `Hash` Default value: `{ 'GODEBUG' => 'x509ignoreCN=0' }` -### `prometheus::varnish_exporter` +### `prometheus::varnish_exporter` This module manages prometheus varnish_exporter #### Parameters -The following parameters are available in the `prometheus::varnish_exporter` class. - -##### `arch` +The following parameters are available in the `prometheus::varnish_exporter` class: + +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`download_extension`](#download_extension) +* [`download_url`](#download_url) +* [`download_url_base`](#download_url_base) +* [`extra_groups`](#extra_groups) +* [`extra_options`](#extra_options) +* [`group`](#group) +* [`init_style`](#init_style) +* [`install_method`](#install_method) +* [`manage_group`](#manage_group) +* [`manage_service`](#manage_service) +* [`manage_user`](#manage_user) +* [`os`](#os) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`purge_config_dir`](#purge_config_dir) +* [`restart_on_change`](#restart_on_change) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`user`](#user) +* [`version`](#version) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) + +##### `arch` Data type: `String[1]` @@ -10613,7 +12303,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10621,13 +12311,13 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `download_extension` +##### `download_extension` Data type: `String` Extension for the release binary archive -##### `download_url` +##### `download_url` Data type: `Optional[Prometheus::Uri]` @@ -10635,19 +12325,19 @@ Complete URL corresponding to the where the release binary archive can be downlo Default value: ``undef`` -##### `download_url_base` +##### `download_url_base` Data type: `Prometheus::Uri` Base URL for the binary archive -##### `extra_groups` +##### `extra_groups` Data type: `Array` Extra groups to add the binary user to -##### `extra_options` +##### `extra_options` Data type: `String` @@ -10655,13 +12345,13 @@ Extra options added to the startup command Default value: `''` -##### `group` +##### `group` Data type: `String[1]` Group under which the binary is running -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -10669,7 +12359,7 @@ Service startup scripts style (e.g. rc, upstart or systemd) Default value: `$facts['service_provider']` -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10677,7 +12367,7 @@ Installation method: url or package (only url is supported currently) Default value: `$prometheus::install_method` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10685,7 +12375,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -10693,7 +12383,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10701,7 +12391,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `os` +##### `os` Data type: `String[1]` @@ -10709,19 +12399,19 @@ Operating system (linux is the only one supported) Default value: `downcase($facts['kernel'])` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` If package, then use this for package ensure default 'latest' -##### `package_name` +##### `package_name` Data type: `String[1]` The binary package name - not available yet -##### `purge_config_dir` +##### `purge_config_dir` Data type: `Boolean` @@ -10729,7 +12419,7 @@ Purge config files no longer generated by Puppet Default value: ``true`` -##### `restart_on_change` +##### `restart_on_change` Data type: `Boolean` @@ -10737,7 +12427,7 @@ Should puppet restart the service on configuration change? (default true) Default value: ``true`` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -10745,7 +12435,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10753,25 +12443,25 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String[1]` Name of the varnish exporter service (default 'varnish_exporter') -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `version` +##### `version` Data type: `String[1]` The binary release version -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -10779,7 +12469,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Optional[Stdlib::Host]` @@ -10787,7 +12477,7 @@ Data type: `Optional[Stdlib::Host]` Default value: ``undef`` -##### `scrape_port` +##### `scrape_port` Data type: `Stdlib::Port` @@ -10795,7 +12485,7 @@ Data type: `Stdlib::Port` Default value: `9131` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -10803,7 +12493,7 @@ Data type: `String[1]` Default value: `'varnish'` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Optional[Hash]` @@ -10813,21 +12503,28 @@ Default value: ``undef`` ## Defined types -### `prometheus::alerts` +### `prometheus::alerts` This module manages prometheus alert files for prometheus #### Parameters -The following parameters are available in the `prometheus::alerts` defined type. +The following parameters are available in the `prometheus::alerts` defined type: + +* [`alerts`](#alerts) +* [`location`](#location) +* [`version`](#version) +* [`user`](#user) +* [`group`](#group) +* [`bin_dir`](#bin_dir) -##### `alerts` +##### `alerts` Data type: `Variant[Array,Hash]` Array (< prometheus 2.0.0) or Hash (>= prometheus 2.0.0) of alerts (see README). -##### `location` +##### `location` Data type: `String[1]` @@ -10835,7 +12532,7 @@ Where to create the alert file for prometheus Default value: `"${prometheus::config_dir}/rules"` -##### `version` +##### `version` Data type: `String[1]` @@ -10843,7 +12540,7 @@ Data type: `String[1]` Default value: `$prometheus::version` -##### `user` +##### `user` Data type: `String[1]` @@ -10851,7 +12548,7 @@ Data type: `String[1]` Default value: `$prometheus::user` -##### `group` +##### `group` Data type: `String[1]` @@ -10859,7 +12556,7 @@ Data type: `String[1]` Default value: `$prometheus::group` -##### `bin_dir` +##### `bin_dir` Data type: `String[1]` @@ -10867,39 +12564,73 @@ Data type: `String[1]` Default value: `$prometheus::bin_dir` -### `prometheus::daemon` +### `prometheus::daemon` This define managed prometheus daemons that don't have their own class #### Parameters -The following parameters are available in the `prometheus::daemon` defined type. - -##### `version` +The following parameters are available in the `prometheus::daemon` defined type: + +* [`version`](#version) +* [`real_download_url`](#real_download_url) +* [`notify_service`](#notify_service) +* [`user`](#user) +* [`install_method`](#install_method) +* [`download_extension`](#download_extension) +* [`os`](#os) +* [`arch`](#arch) +* [`bin_dir`](#bin_dir) +* [`bin_name`](#bin_name) +* [`package_name`](#package_name) +* [`package_ensure`](#package_ensure) +* [`manage_user`](#manage_user) +* [`extra_groups`](#extra_groups) +* [`manage_group`](#manage_group) +* [`service_ensure`](#service_ensure) +* [`service_enable`](#service_enable) +* [`manage_service`](#manage_service) +* [`extract_command`](#extract_command) +* [`extract_path`](#extract_path) +* [`archive_bin_path`](#archive_bin_path) +* [`init_style`](#init_style) +* [`group`](#group) +* [`purge`](#purge) +* [`options`](#options) +* [`env_vars`](#env_vars) +* [`env_file_path`](#env_file_path) +* [`export_scrape_job`](#export_scrape_job) +* [`scrape_host`](#scrape_host) +* [`scrape_port`](#scrape_port) +* [`scrape_job_name`](#scrape_job_name) +* [`scrape_job_labels`](#scrape_job_labels) +* [`usershell`](#usershell) + +##### `version` Data type: `String[1]` The binary release version -##### `real_download_url` +##### `real_download_url` Data type: `Prometheus::Uri` Complete URL corresponding to the where the release binary archive can be downloaded -##### `notify_service` +##### `notify_service` Data type: `Any` The service to notify when something changes in this define -##### `user` +##### `user` Data type: `String[1]` User which runs the service -##### `install_method` +##### `install_method` Data type: `Prometheus::Install` @@ -10907,7 +12638,7 @@ Installation method: url or package Default value: `$prometheus::install_method` -##### `download_extension` +##### `download_extension` Data type: `String` @@ -10915,7 +12646,7 @@ Extension for the release binary archive Default value: `$prometheus::download_extension` -##### `os` +##### `os` Data type: `String[1]` @@ -10923,7 +12654,7 @@ Operating system (linux is the only one supported) Default value: `$prometheus::os` -##### `arch` +##### `arch` Data type: `String[1]` @@ -10931,7 +12662,7 @@ Architecture (amd64 or i386) Default value: `$prometheus::real_arch` -##### `bin_dir` +##### `bin_dir` Data type: `Stdlib::Absolutepath` @@ -10939,7 +12670,7 @@ Directory where binaries are located Default value: `$prometheus::bin_dir` -##### `bin_name` +##### `bin_name` Data type: `String[1]` @@ -10947,7 +12678,7 @@ The name of the binary to execute Default value: `$name` -##### `package_name` +##### `package_name` Data type: `Optional[String]` @@ -10955,7 +12686,7 @@ The binary package name Default value: ``undef`` -##### `package_ensure` +##### `package_ensure` Data type: `String[1]` @@ -10963,7 +12694,7 @@ If package, then use this for package ensure default 'installed' Default value: `'installed'` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -10971,7 +12702,7 @@ Whether to create user or rely on external code for that Default value: ``true`` -##### `extra_groups` +##### `extra_groups` Data type: `Array` @@ -10979,7 +12710,7 @@ Extra groups of which the user should be a part Default value: `[]` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -10987,7 +12718,7 @@ Whether to create a group for or rely on external code for that Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -10995,7 +12726,7 @@ State ensured for the service (default 'running') Default value: `'running'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -11003,7 +12734,7 @@ Whether to enable the service from puppet (default true) Default value: ``true`` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -11011,7 +12742,7 @@ Should puppet manage the service? (default true) Default value: ``true`` -##### `extract_command` +##### `extract_command` Data type: `Optional[String[1]]` @@ -11019,7 +12750,7 @@ Custom command passed to the archive resource to extract the downloaded archive. Default value: `$prometheus::extract_command` -##### `extract_path` +##### `extract_path` Data type: `Stdlib::Absolutepath` @@ -11027,7 +12758,7 @@ Path where to find extracted binary Default value: `'/opt'` -##### `archive_bin_path` +##### `archive_bin_path` Data type: `Stdlib::Absolutepath` @@ -11035,7 +12766,7 @@ Path to the binary in the downloaded archive. Default value: `"/opt/${name}-${version}.${os}-${arch}/${name}"` -##### `init_style` +##### `init_style` Data type: `Prometheus::Initstyle` @@ -11045,13 +12776,13 @@ Typically this can be used when a package is already providing the file. Default value: `$facts['service_provider']` -##### `group` +##### `group` Data type: `String[1]` -##### `purge` +##### `purge` Data type: `Boolean` @@ -11059,7 +12790,7 @@ Data type: `Boolean` Default value: ``true`` -##### `options` +##### `options` Data type: `String` @@ -11067,7 +12798,7 @@ Data type: `String` Default value: `''` -##### `env_vars` +##### `env_vars` Data type: `Hash[String[1], Scalar]` @@ -11075,7 +12806,7 @@ Data type: `Hash[String[1], Scalar]` Default value: `{}` -##### `env_file_path` +##### `env_file_path` Data type: `Stdlib::Absolutepath` @@ -11083,7 +12814,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::env_file_path` -##### `export_scrape_job` +##### `export_scrape_job` Data type: `Boolean` @@ -11091,7 +12822,7 @@ Data type: `Boolean` Default value: ``false`` -##### `scrape_host` +##### `scrape_host` Data type: `Stdlib::Host` @@ -11099,7 +12830,7 @@ Data type: `Stdlib::Host` Default value: `$facts['networking']['fqdn']` -##### `scrape_port` +##### `scrape_port` Data type: `Optional[Stdlib::Port]` @@ -11107,7 +12838,7 @@ Data type: `Optional[Stdlib::Port]` Default value: ``undef`` -##### `scrape_job_name` +##### `scrape_job_name` Data type: `String[1]` @@ -11115,7 +12846,7 @@ Data type: `String[1]` Default value: `$name` -##### `scrape_job_labels` +##### `scrape_job_labels` Data type: `Hash` @@ -11123,7 +12854,7 @@ Data type: `Hash` Default value: `{ 'alias' => $scrape_host }` -##### `usershell` +##### `usershell` Data type: `Stdlib::Absolutepath` @@ -11131,7 +12862,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$prometheus::usershell` -### `prometheus::scrape_job` +### `prometheus::scrape_job` This define is used to export prometheus scrape settings from nodes to be scraped to the node running prometheus itself. @@ -11139,22 +12870,27 @@ This can be used to make prometheus find instances of your running service or ap #### Parameters -The following parameters are available in the `prometheus::scrape_job` defined type. +The following parameters are available in the `prometheus::scrape_job` defined type: + +* [`job_name`](#job_name) +* [`targets`](#targets) +* [`labels`](#labels) +* [`collect_dir`](#collect_dir) -##### `job_name` +##### `job_name` Data type: `String[1]` The name of the scrape job. This will be used when collecting resources on the prometheus node. Corresponds to the prometheus::collect_scrape_jobs parameter. -##### `targets` +##### `targets` Data type: `Array[String[1]]` Array of hosts and ports in the form "host:port" -##### `labels` +##### `labels` Data type: `Hash[String[1], String[1]]` @@ -11162,7 +12898,7 @@ Labels added to the scraped metrics on the prometheus side, as label:values pair Default value: `{}` -##### `collect_dir` +##### `collect_dir` Data type: `Stdlib::Absolutepath` @@ -11173,33 +12909,53 @@ Default value: ``undef`` ## Data types -### `Prometheus::GsUri` +### `Prometheus::GsUri` The Prometheus::GsUri data type. -Alias of `Pattern[/^gs:\/\//]` +Alias of + +```puppet +Pattern[/^gs:\/\//] +``` -### `Prometheus::Initstyle` +### `Prometheus::Initstyle` The Prometheus::Initstyle data type. -Alias of `Enum['sysv', 'systemd', 'sles', 'launchd', 'upstart', 'none']` +Alias of -### `Prometheus::Install` +```puppet +Enum['sysv', 'systemd', 'sles', 'launchd', 'upstart', 'none'] +``` + +### `Prometheus::Install` type to enforce the different installation methods for our exporters. -Alias of `Enum['url', 'package', 'none']` +Alias of -### `Prometheus::S3Uri` +```puppet +Enum['url', 'package', 'none'] +``` + +### `Prometheus::S3Uri` The Prometheus::S3Uri data type. -Alias of `Pattern[/^s3:\/\//]` +Alias of + +```puppet +Pattern[/^s3:\/\//] +``` -### `Prometheus::Uri` +### `Prometheus::Uri` The Prometheus::Uri data type. -Alias of `Variant[Stdlib::Filesource, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Prometheus::S3Uri, Prometheus::GsUri]` +Alias of + +```puppet +Variant[Stdlib::Filesource, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Prometheus::S3Uri, Prometheus::GsUri] +``` diff --git a/manifests/nginx_prometheus_exporter.pp b/manifests/nginx_prometheus_exporter.pp index 33f8cd94d..5c3aefcb0 100644 --- a/manifests/nginx_prometheus_exporter.pp +++ b/manifests/nginx_prometheus_exporter.pp @@ -44,7 +44,7 @@ # @param service_ensure # State ensured for the service (default 'running') # @param service_name -# Name of the node exporter service (default 'nginx_prometheus_exporter') +# Name of the nginx prometheus exporter service (default 'nginx_prometheus_exporter') # @param user # User which runs the service # @param version diff --git a/manifests/php_fpm_exporter.pp b/manifests/php_fpm_exporter.pp new file mode 100644 index 000000000..3db19b534 --- /dev/null +++ b/manifests/php_fpm_exporter.pp @@ -0,0 +1,159 @@ +# @summary This module manages prometheus php-fpm exporter +# @param arch +# Architecture (amd64 or i386) +# @param bin_dir +# Directory where binaries are located +# @param config_mode +# The permissions of the configuration files +# @param download_extension +# Extension for the release binary archive +# @param download_url +# Complete URL corresponding to the where the release binary archive can be downloaded +# @param download_url_base +# Base URL for the binary archive +# @param extra_groups +# Extra groups to add the binary user to +# @param extra_options +# Extra options added to the startup command +# @param group +# Group under which the binary is running +# @param init_style +# Service startup scripts style (e.g. rc, upstart or systemd) +# @param install_method +# Installation method: url or package (only url is supported currently) +# @param manage_group +# Whether to create a group for or rely on external code for that +# @param manage_service +# Should puppet manage the service? (default true) +# @param manage_user +# Whether to create user or rely on external code for that +# @param os +# Operating system (linux is the only one supported) +# @param package_ensure +# If package, then use this for package ensure default 'latest' +# @param package_name +# The binary package name - not available yet +# @param purge_config_dir +# Purge config files no longer generated by Puppet +# @param restart_on_change +# Should puppet restart the service on configuration change? (default true) +# @param scrape_uri +# The URI for the nginx status or nginx plus api page +# @param service_enable +# Whether to enable the service from puppet (default true) +# @param service_ensure +# State ensured for the service (default 'running') +# @param service_name +# Name of the php-fpm exporter service (default 'php-fpm_exporter') +# @param user +# User which runs the service +# @param version +# The binary release version +class prometheus::php_fpm_exporter ( + String[1] $scrape_uri = 'tcp://127.0.0.1:9000/status', + String $download_extension = 'tar.gz', + Prometheus::Uri $download_url_base = 'https://github.com/hipages/php-fpm_exporter/releases', + Array[String[1]] $extra_groups = [], + String[1] $group = 'php-fpm_exporter', + String[1] $package_ensure = 'latest', + String[1] $package_name = 'php-fpm_exporter', + String[1] $user = 'php-fpm_exporter', + String[1] $version = '2.0.4', + Boolean $purge_config_dir = true, + Boolean $restart_on_change = true, + Boolean $service_enable = true, + Stdlib::Ensure::Service $service_ensure = 'running', + String[1] $service_name = 'php-fpm_exporter', + Prometheus::Initstyle $init_style = $facts['service_provider'], + Prometheus::Install $install_method = $prometheus::install_method, + Boolean $manage_group = true, + Boolean $manage_service = true, + Boolean $manage_user = true, + String[1] $os = downcase($facts['kernel']), + String $extra_options = '', + Optional[Prometheus::Uri] $download_url = undef, + String[1] $config_mode = $prometheus::config_mode, + String[1] $arch = $prometheus::real_arch, + Stdlib::Absolutepath $bin_dir = $prometheus::bin_dir, + Boolean $export_scrape_job = false, + Optional[Stdlib::Host] $scrape_host = undef, + Stdlib::Port $scrape_port = 9253, + String[1] $scrape_job_name = 'php-fpm', + Optional[Hash] $scrape_job_labels = undef, + String[1] $bin_name = 'php-fpm_exporter', + Hash[String[1], Scalar] $env_vars = {}, + Stdlib::Absolutepath $env_file_path = $prometheus::env_file_path, +) inherits prometheus { + $real_download_url = pick($download_url,"${download_url_base}/download/v${version}/${package_name}_${version}_${os}_${arch}.${download_extension}") + + $notify_service = $restart_on_change ? { + true => Service[$service_name], + default => undef, + } + + $options = "server --phpfpm.scrape-uri '${scrape_uri}' ${extra_options}" + + if $install_method == 'url' { + # Not a big fan of copypasting but prometheus::daemon takes for granted + # a specific path embedded in the prometheus *_exporter tarball, which + # php-fpm_exporter lacks currently as of version 2.0.4 + # TODO: patch prometheus::daemon to support custom extract directories + $real_install_method = 'none' + $install_dir = "/opt/${package_name}-${version}.${os}-${arch}" + file { $install_dir: + ensure => 'directory', + owner => 'root', + group => 0, # 0 instead of root because OS X uses "wheel". + mode => '0555', + } + -> archive { "/tmp/${package_name}-${version}.${download_extension}": + ensure => present, + extract => true, + extract_path => $install_dir, + source => $real_download_url, + checksum_verify => false, + creates => "${install_dir}/${package_name}", + cleanup => true, + } + -> file { "${bin_dir}/${package_name}": + ensure => link, + notify => $notify_service, + target => "${install_dir}/${package_name}", + before => Prometheus::Daemon[$service_name], + } + } else { + $real_install_method = $install_method + } + + prometheus::daemon { $service_name: + install_method => $real_install_method, + version => $version, + download_extension => $download_extension, + os => $os, + arch => $arch, + real_download_url => $real_download_url, + bin_dir => $bin_dir, + notify_service => $notify_service, + package_name => $package_name, + package_ensure => $package_ensure, + manage_user => $manage_user, + user => $user, + extra_groups => $extra_groups, + group => $group, + manage_group => $manage_group, + purge => $purge_config_dir, + options => $options, + init_style => $init_style, + service_ensure => $service_ensure, + service_enable => $service_enable, + manage_service => $manage_service, + export_scrape_job => $export_scrape_job, + scrape_host => $scrape_host, + scrape_port => $scrape_port, + scrape_job_name => $scrape_job_name, + scrape_job_labels => $scrape_job_labels, + bin_name => $bin_name, + env_vars => $env_vars, + env_file_path => $env_file_path, + } +} diff --git a/spec/acceptance/php_fpm_exporter_spec.rb b/spec/acceptance/php_fpm_exporter_spec.rb new file mode 100644 index 000000000..ee2188fb0 --- /dev/null +++ b/spec/acceptance/php_fpm_exporter_spec.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +require 'spec_helper_acceptance' + +describe 'php-fpm exporter' do + it 'php-fpm-exporter works idempotently with no errors' do + pp = 'include prometheus::php_fpm_exporter' + apply_manifest(pp, catch_failures: true) + apply_manifest(pp, catch_changes: true) + end + + describe 'default install' do + describe service('php-fpm_exporter') do + it { is_expected.to be_running } + it { is_expected.to be_enabled } + end + + describe port(9253) do + it { is_expected.to be_listening.with('tcp6') } + end + + # the describe process uses `ps -C` which truncates the cmd output to 15 characters on newer versions. + if os == 'centos-7-x86_64' + describe process('php-fpm_exporter') do + its(:args) { is_expected.to match %r{\ server --phpfpm.scrape-uri tcp://127.0.0.1:9000/status} } + end + else + describe process('php-fpm_exporte') do + its(:args) { is_expected.to match %r{\ server --phpfpm.scrape-uri tcp://127.0.0.1:9000/status} } + end + end + end +end diff --git a/spec/classes/php_fpm_exporter_spec.rb b/spec/classes/php_fpm_exporter_spec.rb new file mode 100644 index 000000000..678b3d069 --- /dev/null +++ b/spec/classes/php_fpm_exporter_spec.rb @@ -0,0 +1,87 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'prometheus::php_fpm_exporter' do + on_supported_os.each do |os, facts| + context "on #{os}" do + let(:facts) do + facts.merge(os_specific_facts(facts)) + end + + context 'with all defaults' do + it { is_expected.to compile.with_all_deps } + + if facts[:os]['release']['major'].to_i == 6 + it { is_expected.to contain_file('/etc/init.d/php-fpm_exporter') } + else + it { is_expected.to contain_systemd__unit_file('php-fpm_exporter.service') } + end + + if facts[:os]['name'] == 'Archlinux' + it { is_expected.to contain_package('php-fpm_exporter') } + it { is_expected.not_to contain_archive('/tmp/php-fpm_exporter-2.0.4.tar.gz') } + it { is_expected.not_to contain_file('/opt/php-fpm_exporter-2.0.4.linux-amd64') } + else + it { is_expected.not_to contain_package('php-fpm_exporter') } + it { is_expected.to contain_archive('/tmp/php-fpm_exporter-2.0.4.tar.gz') } + it { is_expected.to contain_file('/opt/php-fpm_exporter-2.0.4.linux-amd64') } + end + end + + context 'with some params' do + let(:params) do + { + arch: 'amd64', + os: 'linux', + bin_dir: '/usr/local/bin', + install_method: 'url' + } + end + + describe 'with specific params' do + it { is_expected.to compile.with_all_deps } + it { is_expected.to contain_archive('/tmp/php-fpm_exporter-2.0.4.tar.gz') } + it { is_expected.to contain_class('prometheus') } + it { is_expected.to contain_group('php-fpm_exporter') } + it { is_expected.to contain_user('php-fpm_exporter') } + it { is_expected.to contain_prometheus__daemon('php-fpm_exporter').with('options' => "server --phpfpm.scrape-uri 'tcp://127.0.0.1:9000/status' ") } + it { is_expected.to contain_service('php-fpm_exporter') } + end + + describe 'install correct binary' do + it { is_expected.to contain_file('/usr/local/bin/php-fpm_exporter').with('target' => '/opt/php-fpm_exporter-2.0.4.linux-amd64/php-fpm_exporter') } + it { is_expected.to contain_file('/opt/php-fpm_exporter-2.0.4.linux-amd64') } + end + end + + context 'with scrape_uri and extra options specified' do + let(:params) do + { + scrape_uri: 'tcp://localhost:9000/status', + extra_options: '-test', + arch: 'amd64', + os: 'linux', + bin_dir: '/usr/local/bin', + install_method: 'url' + } + end + + describe 'with specific params' do + it { is_expected.to compile.with_all_deps } + it { is_expected.to contain_archive('/tmp/php-fpm_exporter-2.0.4.tar.gz') } + it { is_expected.to contain_class('prometheus') } + it { is_expected.to contain_group('php-fpm_exporter') } + it { is_expected.to contain_user('php-fpm_exporter') } + it { is_expected.to contain_prometheus__daemon('php-fpm_exporter').with('options' => "server --phpfpm.scrape-uri 'tcp://localhost:9000/status' -test") } + it { is_expected.to contain_service('php-fpm_exporter') } + end + + describe 'install correct binary' do + it { is_expected.to contain_file('/usr/local/bin/php-fpm_exporter').with('target' => '/opt/php-fpm_exporter-2.0.4.linux-amd64/php-fpm_exporter') } + it { is_expected.to contain_file('/opt/php-fpm_exporter-2.0.4.linux-amd64') } + end + end + end + end +end