REFERENCE.md

# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

### Classes

#### Public Classes

* [`prometheus`](#prometheus): This module manages prometheus
* [`prometheus::alertmanager`](#prometheus--alertmanager): This module manages prometheus alertmanager
* [`prometheus::apache_exporter`](#prometheus--apache_exporter): This module manages prometheus apache_exporter
* [`prometheus::beanstalkd_exporter`](#prometheus--beanstalkd_exporter): This module manages prometheus beanstalkd_exporter
* [`prometheus::bind_exporter`](#prometheus--bind_exporter): Class: prometheus::bind_exporter  This module manages prometheus bind_exporter
* [`prometheus::bird_exporter`](#prometheus--bird_exporter): This module manages prometheus bird exporter
* [`prometheus::blackbox_exporter`](#prometheus--blackbox_exporter): This module manages prometheus blackbox_exporter
* [`prometheus::cgroup_exporter`](#prometheus--cgroup_exporter): This module manages prometheus cgroup_exporter (https://github.com/treydock/cgroup_exporter)
* [`prometheus::collectd_exporter`](#prometheus--collectd_exporter): This module manages prometheus node collectd_exporter
* [`prometheus::config`](#prometheus--config): Configuration class for prometheus monitoring system
* [`prometheus::consul_exporter`](#prometheus--consul_exporter): This module manages prometheus node consul_exporter
* [`prometheus::dellhw_exporter`](#prometheus--dellhw_exporter): This module manages prometheus node dellhw_exporter
* [`prometheus::elasticsearch_exporter`](#prometheus--elasticsearch_exporter): This module manages prometheus elasticsearch_exporter
* [`prometheus::frr_exporter`](#prometheus--frr_exporter): This module manages prometheus FRR exporter
* [`prometheus::graphite_exporter`](#prometheus--graphite_exporter): This module manages prometheus node graphite_exporter
* [`prometheus::grok_exporter`](#prometheus--grok_exporter): This module manages prometheus grok_exporter
* [`prometheus::install`](#prometheus--install): Install prometheus
* [`prometheus::iperf3_exporter`](#prometheus--iperf3_exporter): This module manages prometheus node iperf3_exporter
* [`prometheus::ipmi_exporter`](#prometheus--ipmi_exporter): This module manages prometheus node ipmi_exporter (https://github.com/soundcloud/ipmi_exporter)
* [`prometheus::ipsec_exporter`](#prometheus--ipsec_exporter): This module manages prometheus node ipsec_exporter
* [`prometheus::jmx_exporter`](#prometheus--jmx_exporter): Installs and configures the Prometheus JMX exporter
* [`prometheus::memcached_exporter`](#prometheus--memcached_exporter): This module manages prometheus node memcached_exporter
* [`prometheus::mesos_exporter`](#prometheus--mesos_exporter): This module manages prometheus mesos_exporter
* [`prometheus::mongodb_exporter`](#prometheus--mongodb_exporter): This module manages prometheus mongodb_exporter
* [`prometheus::mysqld_exporter`](#prometheus--mysqld_exporter): manages prometheus mysqld_exporter
* [`prometheus::nginx_prometheus_exporter`](#prometheus--nginx_prometheus_exporter): This module manages prometheus nginx exporter
* [`prometheus::node_exporter`](#prometheus--node_exporter): This module manages prometheus node node_exporter
* [`prometheus::openldap_exporter`](#prometheus--openldap_exporter): This module manages prometheus openldap_exporter
* [`prometheus::openvpn_exporter`](#prometheus--openvpn_exporter): This module manages prometheus node openvpn_exporter
* [`prometheus::php_fpm_exporter`](#prometheus--php_fpm_exporter): This module manages prometheus php-fpm exporter
* [`prometheus::postfix_exporter`](#prometheus--postfix_exporter): manages prometheus postfix_exporter
* [`prometheus::postgres_exporter`](#prometheus--postgres_exporter): This module manages prometheus node postgres_exporter
* [`prometheus::process_exporter`](#prometheus--process_exporter): This module manages prometheus process_exporter
* [`prometheus::puppetdb_exporter`](#prometheus--puppetdb_exporter): This module manages prometheus node puppetdb_exporter
* [`prometheus::pushgateway`](#prometheus--pushgateway): This module manages prometheus node pushgateway
* [`prometheus::pushprox_client`](#prometheus--pushprox_client): This module manages prometheus pushprox_client
* [`prometheus::pushprox_proxy`](#prometheus--pushprox_proxy): This module manages prometheus pushprox_proxy
* [`prometheus::redis_exporter`](#prometheus--redis_exporter): This module manages prometheus node redis_exporter
* [`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)
* [`prometheus::server`](#prometheus--server): class to manage the actual prometheus server. This class gets called from the init.pp
* [`prometheus::snmp_exporter`](#prometheus--snmp_exporter): This module manages prometheus snmp_exporter
* [`prometheus::ssh_exporter`](#prometheus--ssh_exporter): This module manages prometheus ssh_exporter (https://github.com/treydock/ssh_exporter)
* [`prometheus::ssl_exporter`](#prometheus--ssl_exporter): This module manages prometheus ssl_exporter (https://github.com/ribbybibby/ssl_exporter)
* [`prometheus::statsd_exporter`](#prometheus--statsd_exporter): This module manages prometheus statsd_exporter
* [`prometheus::systemd_exporter`](#prometheus--systemd_exporter): This module manages prometheus systemd_exporter
* [`prometheus::unbound_exporter`](#prometheus--unbound_exporter): This module manages prometheus unbound exporter.
* [`prometheus::varnish_exporter`](#prometheus--varnish_exporter): This module manages prometheus varnish_exporter
* [`prometheus::wireguard_exporter`](#prometheus--wireguard_exporter): This module manages prometheus wireguard_exporter

#### Private Classes

* `prometheus::service_reload`: This class implements prometheus service reload without
restarting the whole service when a config changes

### Defined types

* [`prometheus::alerts`](#prometheus--alerts): This module manages prometheus alert files for prometheus
* [`prometheus::daemon`](#prometheus--daemon): This define managed prometheus daemons that don't have their own class
* [`prometheus::scrape_job`](#prometheus--scrape_job): This module manages prometheus scrape jobs.

### Data types

* [`Prometheus::GsUri`](#Prometheus--GsUri): Type for a Google Cloud Storage URI
* [`Prometheus::Initstyle`](#Prometheus--Initstyle): A type to represent the init style of a Prometheus service
* [`Prometheus::Install`](#Prometheus--Install): type to enforce the different installation methods for our exporters.
* [`Prometheus::S3Uri`](#Prometheus--S3Uri): Type for S3 URIs
* [`Prometheus::Uri`](#Prometheus--Uri): A URI that can be used to fetch a Prometheus configuration file
* [`Prometheus::Web_config`](#Prometheus--Web_config): webconfig for the exporter
* [`Prometheus::Web_config::Http_server_config`](#Prometheus--Web_config--Http_server_config): http_server_config of a exporter webconfig
* [`Prometheus::Web_config::Tls_server_config`](#Prometheus--Web_config--Tls_server_config): tls_server_config of a exporter webconfig

## Classes

### <a name="prometheus"></a>`prometheus`

This module manages prometheus

#### Parameters

The following parameters are available in the `prometheus` class:

* [`configname`](#-prometheus--configname)
* [`manage_user`](#-prometheus--manage_user)
* [`user`](#-prometheus--user)
* [`manage_group`](#-prometheus--manage_group)
* [`purge_config_dir`](#-prometheus--purge_config_dir)
* [`group`](#-prometheus--group)
* [`bin_dir`](#-prometheus--bin_dir)
* [`shared_dir`](#-prometheus--shared_dir)
* [`arch`](#-prometheus--arch)
* [`version`](#-prometheus--version)
* [`install_method`](#-prometheus--install_method)
* [`os`](#-prometheus--os)
* [`download_url`](#-prometheus--download_url)
* [`download_url_base`](#-prometheus--download_url_base)
* [`download_extension`](#-prometheus--download_extension)
* [`package_name`](#-prometheus--package_name)
* [`package_ensure`](#-prometheus--package_ensure)
* [`config_dir`](#-prometheus--config_dir)
* [`localstorage`](#-prometheus--localstorage)
* [`extra_options`](#-prometheus--extra_options)
* [`config_hash`](#-prometheus--config_hash)
* [`config_defaults`](#-prometheus--config_defaults)
* [`config_template`](#-prometheus--config_template)
* [`config_mode`](#-prometheus--config_mode)
* [`service_enable`](#-prometheus--service_enable)
* [`service_ensure`](#-prometheus--service_ensure)
* [`service_name`](#-prometheus--service_name)
* [`manage_service`](#-prometheus--manage_service)
* [`restart_on_change`](#-prometheus--restart_on_change)
* [`init_style`](#-prometheus--init_style)
* [`global_config`](#-prometheus--global_config)
* [`rule_files`](#-prometheus--rule_files)
* [`scrape_configs`](#-prometheus--scrape_configs)
* [`scrape_config_files`](#-prometheus--scrape_config_files)
* [`include_default_scrape_configs`](#-prometheus--include_default_scrape_configs)
* [`remote_read_configs`](#-prometheus--remote_read_configs)
* [`remote_write_configs`](#-prometheus--remote_write_configs)
* [`enable_tracing`](#-prometheus--enable_tracing)
* [`tracing_config`](#-prometheus--tracing_config)
* [`alerts`](#-prometheus--alerts)
* [`extra_alerts`](#-prometheus--extra_alerts)
* [`alert_relabel_config`](#-prometheus--alert_relabel_config)
* [`alertmanagers_config`](#-prometheus--alertmanagers_config)
* [`storage_retention`](#-prometheus--storage_retention)
* [`external_url`](#-prometheus--external_url)
* [`extract_command`](#-prometheus--extract_command)
* [`collect_tag`](#-prometheus--collect_tag)
* [`collect_scrape_jobs`](#-prometheus--collect_scrape_jobs)
* [`max_open_files`](#-prometheus--max_open_files)
* [`usershell`](#-prometheus--usershell)
* [`web_listen_address`](#-prometheus--web_listen_address)
* [`web_read_timeout`](#-prometheus--web_read_timeout)
* [`web_max_connections`](#-prometheus--web_max_connections)
* [`web_route_prefix`](#-prometheus--web_route_prefix)
* [`web_user_assets`](#-prometheus--web_user_assets)
* [`web_enable_lifecycle`](#-prometheus--web_enable_lifecycle)
* [`web_enable_admin_api`](#-prometheus--web_enable_admin_api)
* [`web_page_title`](#-prometheus--web_page_title)
* [`web_cors_origin`](#-prometheus--web_cors_origin)
* [`storage_retention_size`](#-prometheus--storage_retention_size)
* [`storage_no_lockfile`](#-prometheus--storage_no_lockfile)
* [`storage_allow_overlapping_blocks`](#-prometheus--storage_allow_overlapping_blocks)
* [`storage_wal_compression`](#-prometheus--storage_wal_compression)
* [`storage_flush_deadline`](#-prometheus--storage_flush_deadline)
* [`storage_read_sample_limit`](#-prometheus--storage_read_sample_limit)
* [`storage_read_concurrent_limit`](#-prometheus--storage_read_concurrent_limit)
* [`storage_read_max_bytes_in_frame`](#-prometheus--storage_read_max_bytes_in_frame)
* [`alert_for_outage_tolerance`](#-prometheus--alert_for_outage_tolerance)
* [`alert_for_grace_period`](#-prometheus--alert_for_grace_period)
* [`alert_resend_delay`](#-prometheus--alert_resend_delay)
* [`alertmanager_notification_queue_capacity`](#-prometheus--alertmanager_notification_queue_capacity)
* [`alertmanager_timeout`](#-prometheus--alertmanager_timeout)
* [`query_lookback_delta`](#-prometheus--query_lookback_delta)
* [`query_timeout`](#-prometheus--query_timeout)
* [`query_max_concurrency`](#-prometheus--query_max_concurrency)
* [`query_max_samples`](#-prometheus--query_max_samples)
* [`log_level`](#-prometheus--log_level)
* [`log_format`](#-prometheus--log_format)
* [`config_show_diff`](#-prometheus--config_show_diff)
* [`extra_groups`](#-prometheus--extra_groups)
* [`proxy_server`](#-prometheus--proxy_server)
* [`proxy_type`](#-prometheus--proxy_type)
* [`systemd_service_options`](#-prometheus--systemd_service_options)
* [`systemd_unit_options`](#-prometheus--systemd_unit_options)
* [`systemd_install_options`](#-prometheus--systemd_install_options)
* [`env_file_path`](#-prometheus--env_file_path)
* [`manage_config_dir`](#-prometheus--manage_config_dir)
* [`manage_init_file`](#-prometheus--manage_init_file)
* [`manage_config`](#-prometheus--manage_config)
* [`manage_localstorage`](#-prometheus--manage_localstorage)
* [`manage_prometheus_server`](#-prometheus--manage_prometheus_server)

##### <a name="-prometheus--configname"></a>`configname`

Data type: `String[1]`

the name of the configfile, defaults to prometheus.yaml or prometheus.yml on most operating systems

Default value: `'prometheus.yaml'`

##### <a name="-prometheus--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user for prometheus or rely on external code for that

Default value: `true`

##### <a name="-prometheus--user"></a>`user`

Data type: `String`

User running prometheus

Default value: `'prometheus'`

##### <a name="-prometheus--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create user for prometheus or rely on external code for that

Default value: `true`

##### <a name="-prometheus--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--group"></a>`group`

Data type: `String`

Group under which prometheus is running

Default value: `'prometheus'`

##### <a name="-prometheus--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `'/usr/local/bin'`

##### <a name="-prometheus--shared_dir"></a>`shared_dir`

Data type: `Stdlib::Absolutepath`

Directory where shared files are located

Default value: `'/usr/local/share/prometheus'`

##### <a name="-prometheus--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$facts['os']['architecture']`

##### <a name="-prometheus--version"></a>`version`

Data type: `String`

Prometheus release

Default value: `'2.52.0'`

##### <a name="-prometheus--install_method"></a>`install_method`

Data type: `String`

Installation method: url or package (only url is supported currently)

Default value: `'url'`

##### <a name="-prometheus--os"></a>`os`

Data type: `String[1]`

Operating system (linux is supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the Prometheus release, default to undef

Default value: `undef`

##### <a name="-prometheus--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for prometheus

Default value: `'https://github.com/prometheus/prometheus/releases'`

##### <a name="-prometheus--download_extension"></a>`download_extension`

Data type: `String`

Extension of Prometheus binaries archive

Default value: `'tar.gz'`

##### <a name="-prometheus--package_name"></a>`package_name`

Data type: `String`

Prometheus package name - not available yet

Default value: `'prometheus'`

##### <a name="-prometheus--package_ensure"></a>`package_ensure`

Data type: `String`

If package, then use this for package ensurel default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--config_dir"></a>`config_dir`

Data type: `String`

Prometheus configuration directory (default /etc/prometheus)

Default value: `'/etc/prometheus'`

##### <a name="-prometheus--localstorage"></a>`localstorage`

Data type: `Stdlib::Absolutepath`

Location of prometheus local storage (storage.local argument)

Default value: `'/var/lib/prometheus'`

##### <a name="-prometheus--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to prometheus startup command

Default value: `undef`

##### <a name="-prometheus--config_hash"></a>`config_hash`

Data type: `Hash`

Startup config hash

Default value: `{}`

##### <a name="-prometheus--config_defaults"></a>`config_defaults`

Data type: `Hash`

Startup config defaults

Default value: `{}`

##### <a name="-prometheus--config_template"></a>`config_template`

Data type: `String`

Configuration template to use (template/prometheus.yaml.erb)

Default value: `'prometheus/prometheus.yaml.erb'`

##### <a name="-prometheus--config_mode"></a>`config_mode`

Data type: `String`

Configuration file mode (default 0660)

Default value: `'0640'`

##### <a name="-prometheus--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable or not prometheus service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured from prometheus service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--service_name"></a>`service_name`

Data type: `String`

Name of the prometheus service (default 'prometheus')

Default value: `'prometheus'`

##### <a name="-prometheus--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the prometheus service? (default true)

Default value: `true`

##### <a name="-prometheus--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart prometheus on configuration change? (default true)
Note: this applies only to command-line options changes. Configuration
options are always *reloaded* without restarting.

Default value: `true`

##### <a name="-prometheus--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$facts['service_provider']`

##### <a name="-prometheus--global_config"></a>`global_config`

Data type: `Hash`

Prometheus global configuration variables

Default value: `{ 'scrape_interval' => '15s', 'evaluation_interval' => '15s', 'external_labels' => { 'monitor' => 'master' } }`

##### <a name="-prometheus--rule_files"></a>`rule_files`

Data type: `Array`

Prometheus rule files

Default value: `[]`

##### <a name="-prometheus--scrape_configs"></a>`scrape_configs`

Data type: `Array`

Prometheus scrape configs

Default value: `[]`

##### <a name="-prometheus--scrape_config_files"></a>`scrape_config_files`

Data type: `Optional[Array]`

Specifies an Array of file globs. Scrape configs are read from all matching files and appended to
the list of scrape configs.

Default value: `undef`

##### <a name="-prometheus--include_default_scrape_configs"></a>`include_default_scrape_configs`

Data type: `Boolean`

Include the module default scrape configs

Default value: `true`

##### <a name="-prometheus--remote_read_configs"></a>`remote_read_configs`

Data type: `Array`

Prometheus remote_read config to scrape prometheus 1.8+ instances

Default value: `[]`

##### <a name="-prometheus--remote_write_configs"></a>`remote_write_configs`

Data type: `Array`

Prometheus remote_write config to scrape prometheus 1.8+ instances

Default value: `[]`

##### <a name="-prometheus--enable_tracing"></a>`enable_tracing`

Data type: `Boolean`

Prometheus enables experimental tracing in Prometheus config file

Default value: `false`

##### <a name="-prometheus--tracing_config"></a>`tracing_config`

Data type: `Hash`

Prometheus tracing configuration for the Prometheus config file

Default value: `{}`

##### <a name="-prometheus--alerts"></a>`alerts`

Data type: `Hash`

alert rules to put in alerts.rules

Default value: `{}`

##### <a name="-prometheus--extra_alerts"></a>`extra_alerts`

Data type: `Hash`

Hash with extra alert rules to put in separate files.

Default value: `{}`

##### <a name="-prometheus--alert_relabel_config"></a>`alert_relabel_config`

Data type: `Array`

Prometheus alert relabel config under alerting

Default value: `[]`

##### <a name="-prometheus--alertmanagers_config"></a>`alertmanagers_config`

Data type: `Array`

Prometheus managers config under alerting

Default value: `[]`

##### <a name="-prometheus--storage_retention"></a>`storage_retention`

Data type: `String`

How long to keep timeseries data. This is given as a duration like "100h" or "14d". Until
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.

Default value: `'360h'`

##### <a name="-prometheus--external_url"></a>`external_url`

Data type: `Optional[Variant[Stdlib::HTTPUrl, Stdlib::Unixpath, String[1]]]`

The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served
via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself.
If omitted, relevant URL components will be derived automatically.

Default value: `undef`

##### <a name="-prometheus--extract_command"></a>`extract_command`

Data type: `Optional[String[1]]`

Custom command passed to the archive resource to extract the downloaded archive.

Default value: `undef`

##### <a name="-prometheus--collect_tag"></a>`collect_tag`

Data type: `Optional[String[1]]`

Only collect scrape jobs tagged with this label. Allowing to split jobs over multiple prometheuses.

Default value: `undef`

##### <a name="-prometheus--collect_scrape_jobs"></a>`collect_scrape_jobs`

Data type: `Array[Hash[String[1], Any]]`

Array of scrape_configs. Format, e.g.:
- job_name: node (for node_exporter; use redis for redis_exporter and so on)
  scheme: https
The jobs defined here will be used to collect resources exported via prometheus::daemon,
creating the appropriate prometheus scrape configs for each endpoint. All scrape_config
options can be passed as hash elements. Only the job_name is mandatory.

Default value: `[]`

##### <a name="-prometheus--max_open_files"></a>`max_open_files`

Data type: `Optional[Integer]`

The maximum number of file descriptors for the prometheus server.
Defaults to `undef`, but set to a large integer to override your default OS limit.
Currently only implemented for systemd based service.

Default value: `undef`

##### <a name="-prometheus--usershell"></a>`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.

Default value: `'/usr/bin/nologin'`

##### <a name="-prometheus--web_listen_address"></a>`web_listen_address`

Data type: `Optional[String[1]]`

--web.listen-address="0.0.0.0:9090"
Address to listen on for UI, API, and telemetry.

Default value: `undef`

##### <a name="-prometheus--web_read_timeout"></a>`web_read_timeout`

Data type: `Optional[String[1]]`

--web.read-timeout=5m
Maximum duration before timing out read of the request, and closing idle connections.

Default value: `undef`

##### <a name="-prometheus--web_max_connections"></a>`web_max_connections`

Data type: `Optional[String[1]]`

--web.max-connections=512
Maximum number of simultaneous connections.

Default value: `undef`

##### <a name="-prometheus--web_route_prefix"></a>`web_route_prefix`

Data type: `Optional[String[1]]`

--web.route-prefix=<path>
Prefix for the internal routes of web endpoints. Defaults to path of --web.external-url.

Default value: `undef`

##### <a name="-prometheus--web_user_assets"></a>`web_user_assets`

Data type: `Optional[String[1]]`

--web.user-assets=<path>
Path to static asset directory, available at /user.

Default value: `undef`

##### <a name="-prometheus--web_enable_lifecycle"></a>`web_enable_lifecycle`

Data type: `Boolean`

--web.enable-lifecycle
Enable shutdown and reload via HTTP request

Default value: `false`

##### <a name="-prometheus--web_enable_admin_api"></a>`web_enable_admin_api`

Data type: `Boolean`

--web.enable-admin-api
Enable API endpoints for admin control actions.

Default value: `false`

##### <a name="-prometheus--web_page_title"></a>`web_page_title`

Data type: `Optional[String[1]]`

--web.page-title="Prometheus Time Series Collection and Processing Server"
Document title of Prometheus instance.

Default value: `undef`

##### <a name="-prometheus--web_cors_origin"></a>`web_cors_origin`

Data type: `Optional[String[1]]`

--web.cors.origin=".*"
Regex for CORS origin. It is fully anchored. Example: 'https?://(domain1|domain2)\.com'

Default value: `undef`

##### <a name="-prometheus--storage_retention_size"></a>`storage_retention_size`

Data type: `Optional[String[1]]`

--storage.tsdb.retention.size=STORAGE.TSDB.RETENTION.SIZE
[EXPERIMENTAL] Maximum number of bytes that can be stored for blocks. Units supported: KB,
MB, GB, TB, PB. This flag is experimental and can be changed in future releases.

Default value: `undef`

##### <a name="-prometheus--storage_no_lockfile"></a>`storage_no_lockfile`

Data type: `Boolean`

--storage.tsdb.no-lockfile
Do not create lockfile in data directory.

Default value: `false`

##### <a name="-prometheus--storage_allow_overlapping_blocks"></a>`storage_allow_overlapping_blocks`

Data type: `Boolean`

--storage.tsdb.allow-overlapping-blocks
[EXPERIMENTAL] Allow overlapping blocks, which in turn enables vertical compaction and
vertical query merge.

Default value: `false`

##### <a name="-prometheus--storage_wal_compression"></a>`storage_wal_compression`

Data type: `Boolean`

--storage.tsdb.wal-compression
Compress the tsdb WAL.

Default value: `false`

##### <a name="-prometheus--storage_flush_deadline"></a>`storage_flush_deadline`

Data type: `Optional[String[1]]`

--storage.remote.flush-deadline=<duration>
How long to wait flushing sample on shutdown or config reload.

Default value: `undef`

##### <a name="-prometheus--storage_read_sample_limit"></a>`storage_read_sample_limit`

Data type: `Optional[String[1]]`

--storage.remote.read-sample-limit=5e7
Maximum overall number of samples to return via the remote read interface, in a single
query. 0 means no limit. This limit is ignored for streamed response types.

Default value: `undef`

##### <a name="-prometheus--storage_read_concurrent_limit"></a>`storage_read_concurrent_limit`

Data type: `Optional[String[1]]`

--storage.remote.read-concurrent-limit=10
Maximum number of concurrent remote read calls. 0 means no limit.

Default value: `undef`

##### <a name="-prometheus--storage_read_max_bytes_in_frame"></a>`storage_read_max_bytes_in_frame`

Data type: `Optional[String[1]]`

--storage.remote.read-max-bytes-in-frame=1048576
Maximum number of bytes in a single frame for streaming remote read response types before
marshalling. Note that client might have limit on frame size as well. 1MB as recommended
by protobuf by default.

Default value: `undef`

##### <a name="-prometheus--alert_for_outage_tolerance"></a>`alert_for_outage_tolerance`

Data type: `Optional[String[1]]`

--rules.alert.for-outage-tolerance=1h
Max time to tolerate prometheus outage for restoring "for" state of alert.

Default value: `undef`

##### <a name="-prometheus--alert_for_grace_period"></a>`alert_for_grace_period`

Data type: `Optional[String[1]]`

--rules.alert.for-grace-period=10m
Minimum duration between alert and restored "for" state. This is maintained only for
alerts with configured "for" time greater than grace period.

Default value: `undef`

##### <a name="-prometheus--alert_resend_delay"></a>`alert_resend_delay`

Data type: `Optional[String[1]]`

--rules.alert.resend-delay=1m
Minimum amount of time to wait before resending an alert to Alertmanager.

Default value: `undef`

##### <a name="-prometheus--alertmanager_notification_queue_capacity"></a>`alertmanager_notification_queue_capacity`

Data type: `Optional[String[1]]`

--alertmanager.notification-queue-capacity=10000
The capacity of the queue for pending Alertmanager notifications.

Default value: `undef`

##### <a name="-prometheus--alertmanager_timeout"></a>`alertmanager_timeout`

Data type: `Optional[String[1]]`

--alertmanager.timeout=10s
Timeout for sending alerts to Alertmanager.

Default value: `undef`

##### <a name="-prometheus--query_lookback_delta"></a>`query_lookback_delta`

Data type: `Optional[String[1]]`

--query.lookback-delta=5m
The maximum lookback duration for retrieving metrics during expression evaluations.

Default value: `undef`

##### <a name="-prometheus--query_timeout"></a>`query_timeout`

Data type: `Optional[String[1]]`

--query.timeout=2m
Maximum time a query may take before being aborted.

Default value: `undef`

##### <a name="-prometheus--query_max_concurrency"></a>`query_max_concurrency`

Data type: `Optional[String[1]]`

--query.max-concurrency=20
Maximum number of queries executed concurrently.

Default value: `undef`

##### <a name="-prometheus--query_max_samples"></a>`query_max_samples`

Data type: `Optional[String[1]]`

--query.max-samples=50000000
Maximum number of samples a single query can load into memory. Note that queries will fail
if they try to load more samples than this into memory, so this also limits the number of
samples a query can return.
Enable remote service shutdown.

Default value: `undef`

##### <a name="-prometheus--log_level"></a>`log_level`

Data type: `Optional[Enum['debug', 'info', 'warn', 'error']]`

--log.level=info
Only log messages with the given severity or above. One of: [debug, info, warn, error]

Default value: `undef`

##### <a name="-prometheus--log_format"></a>`log_format`

Data type: `Optional[Enum['logfmt', 'json']]`

--log.format=logfmt
Output format of log messages. One of: [logfmt, json]

Default value: `undef`

##### <a name="-prometheus--config_show_diff"></a>`config_show_diff`

Data type: `Boolean`

Whether to show prometheus configuration file diff in the Puppet logs.

Default value: `true`

##### <a name="-prometheus--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups of which the user should be a part

Default value: `[]`

##### <a name="-prometheus--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--systemd_service_options"></a>`systemd_service_options`

Data type: `Systemd::Unit::Service`

Options for the service section of prometheus systemd unit file. Can be used to add custom options
or to override default. Only used when init_style is set to systemd.

Default value: `{}`

##### <a name="-prometheus--systemd_unit_options"></a>`systemd_unit_options`

Data type: `Systemd::Unit::Unit`

Options for the unit section of prometheus systemd unit file. Can be used to add custom options
or to override default. Only used when init_style is set to systemd.

Default value: `{}`

##### <a name="-prometheus--systemd_install_options"></a>`systemd_install_options`

Data type: `Systemd::Unit::Install`

Options for the install section of prometheus systemd unit file. Can be used to add custom options
or to override default. Only used when init_style is set to systemd.

Default value: `{}`

##### <a name="-prometheus--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`



##### <a name="-prometheus--manage_config_dir"></a>`manage_config_dir`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--manage_init_file"></a>`manage_init_file`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--manage_config"></a>`manage_config`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--manage_localstorage"></a>`manage_localstorage`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--manage_prometheus_server"></a>`manage_prometheus_server`

Data type: `Boolean`



Default value: `false`

### <a name="prometheus--alertmanager"></a>`prometheus::alertmanager`

Example:
 prometheus::alertmanager::time_intervals:
 - name: weekend
   time_intervals:
     - weekdays: ['saturday','sunday']

#### Parameters

The following parameters are available in the `prometheus::alertmanager` class:

* [`arch`](#-prometheus--alertmanager--arch)
* [`bin_dir`](#-prometheus--alertmanager--bin_dir)
* [`config_file`](#-prometheus--alertmanager--config_file)
* [`config_mode`](#-prometheus--alertmanager--config_mode)
* [`download_extension`](#-prometheus--alertmanager--download_extension)
* [`download_url`](#-prometheus--alertmanager--download_url)
* [`download_url_base`](#-prometheus--alertmanager--download_url_base)
* [`extra_groups`](#-prometheus--alertmanager--extra_groups)
* [`extra_options`](#-prometheus--alertmanager--extra_options)
* [`global`](#-prometheus--alertmanager--global)
* [`group`](#-prometheus--alertmanager--group)
* [`inhibit_rules`](#-prometheus--alertmanager--inhibit_rules)
* [`init_style`](#-prometheus--alertmanager--init_style)
* [`install_method`](#-prometheus--alertmanager--install_method)
* [`manage_group`](#-prometheus--alertmanager--manage_group)
* [`manage_service`](#-prometheus--alertmanager--manage_service)
* [`manage_user`](#-prometheus--alertmanager--manage_user)
* [`mute_time_intervals`](#-prometheus--alertmanager--mute_time_intervals)
* [`time_intervals`](#-prometheus--alertmanager--time_intervals)
* [`os`](#-prometheus--alertmanager--os)
* [`package_ensure`](#-prometheus--alertmanager--package_ensure)
* [`package_name`](#-prometheus--alertmanager--package_name)
* [`config_dir`](#-prometheus--alertmanager--config_dir)
* [`purge_config_dir`](#-prometheus--alertmanager--purge_config_dir)
* [`manage_config`](#-prometheus--alertmanager--manage_config)
* [`validate_config`](#-prometheus--alertmanager--validate_config)
* [`receivers`](#-prometheus--alertmanager--receivers)
* [`restart_on_change`](#-prometheus--alertmanager--restart_on_change)
* [`reload_on_change`](#-prometheus--alertmanager--reload_on_change)
* [`route`](#-prometheus--alertmanager--route)
* [`service_enable`](#-prometheus--alertmanager--service_enable)
* [`service_ensure`](#-prometheus--alertmanager--service_ensure)
* [`service_name`](#-prometheus--alertmanager--service_name)
* [`storage_path`](#-prometheus--alertmanager--storage_path)
* [`templates`](#-prometheus--alertmanager--templates)
* [`user`](#-prometheus--alertmanager--user)
* [`version`](#-prometheus--alertmanager--version)
* [`proxy_server`](#-prometheus--alertmanager--proxy_server)
* [`proxy_type`](#-prometheus--alertmanager--proxy_type)

##### <a name="-prometheus--alertmanager--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--alertmanager--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--alertmanager--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

The path to put the configuration file

Default value: `'%{hiera('prometheus::alertmanager::config_dir')}/alertmanager.yaml'`

##### <a name="-prometheus--alertmanager--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--alertmanager--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--alertmanager--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--alertmanager--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/alertmanager/releases'`

##### <a name="-prometheus--alertmanager--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--alertmanager--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--alertmanager--global"></a>`global`

Data type: `Hash`

The global alertmanager configuration.
Example (also default):
prometheus::alertmanager::global:
  smtp_smarthost: 'localhost:25'
  smtp_from: 'alertmanager@localhost'

Default value: `{ 'smtp_smarthost' => 'localhost:25', 'smtp_from' => 'alertmanager@localhost' }`

##### <a name="-prometheus--alertmanager--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'alertmanager'`

##### <a name="-prometheus--alertmanager--inhibit_rules"></a>`inhibit_rules`

Data type: `Array`

An array of inhibit rules.
Example (also default):
prometheus::alertmanager::inhibit_rules:
- source_match:
    severity: 'critical'
    target_match:
      severity: 'warning'
    equal:
    - 'alertname'
    - 'cluster'
    - 'service'

Default value: `[{ 'source_matchers' => ['severity = critical'], 'target_matchers' => ['severity = warning'], 'equal' => ['alertname', 'cluster', 'service'] }]`

##### <a name="-prometheus--alertmanager--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--alertmanager--install_method"></a>`install_method`

Data type: `String[1]`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--alertmanager--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--alertmanager--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--alertmanager--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--alertmanager--mute_time_intervals"></a>`mute_time_intervals`

Data type: `Array[Hash]`

Array of mute time intervals
Not applied if time_intervals is defined
Example:
prometheus::alertmanager::mute_time_intervals:
- name: weekend
  time_intervals:
    - weekdays: ['saturday','sunday']

Default value: `[]`

##### <a name="-prometheus--alertmanager--time_intervals"></a>`time_intervals`

Data type: `Array[Hash]`

Array of time intervals, only supported with 0.24.0 and newer

Default value: `[]`

##### <a name="-prometheus--alertmanager--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--alertmanager--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--alertmanager--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'alertmanager'`

##### <a name="-prometheus--alertmanager--config_dir"></a>`config_dir`

Data type: `Stdlib::Absolutepath`

The directory to put the configuration files

Default value: `'/etc/alertmanager'`

##### <a name="-prometheus--alertmanager--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--alertmanager--manage_config"></a>`manage_config`

Data type: `Boolean`

Whether Puppet should manage Alertmanager config

Default value: `true`

##### <a name="-prometheus--alertmanager--validate_config"></a>`validate_config`

Data type: `Boolean`

Whether Puppet should validate the config with amtool when it is not installed with the URL method

Default value: `false`

##### <a name="-prometheus--alertmanager--receivers"></a>`receivers`

Data type: `Array`

An array of receivers.
Example (also default):
prometheus::alertmanager::receivers:
- name: 'Admin'
  email_configs:
    - to: 'root@localhost'

Default value: `[{ 'name' => 'Admin', 'email_configs' => [{ 'to' => 'root@localhost' }] }]`

##### <a name="-prometheus--alertmanager--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--alertmanager--reload_on_change"></a>`reload_on_change`

Data type: `Boolean`

Should puppet reload the service on configuration change? (default false)

Default value: `false`

##### <a name="-prometheus--alertmanager--route"></a>`route`

Data type: `Hash`

The top level route.
Example (also default):
prometheus::alertmanager::route:
  group_by:
    - 'alertname'
    - 'cluster'
    - 'service'
  group_wait: '30s'
  group_interval: '5m'
  repeat_interval: '3h'
  receiver: 'Admin'

Default value: `{ 'group_by' => ['alertname', 'cluster', 'service'], 'group_wait' => '30s', 'group_interval' => '5m', 'repeat_interval' => '3h', 'receiver' => 'Admin' }`

##### <a name="-prometheus--alertmanager--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--alertmanager--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--alertmanager--service_name"></a>`service_name`

Data type: `String[1]`

Name of the alertmanager service (default 'alertmanager')

Default value: `'alertmanager'`

##### <a name="-prometheus--alertmanager--storage_path"></a>`storage_path`

Data type: `Stdlib::Absolutepath`

The storage path to pass to the alertmanager. Defaults to '/var/lib/alertmanager'

Default value: `'/var/lib/alertmanager'`

##### <a name="-prometheus--alertmanager--templates"></a>`templates`

Data type: `Array`

The array of template files. Defaults to [ "${config_dir}/*.tmpl" ]

Default value: `['%{lookup('prometheus::alertmanager::config_dir')}/*.tmpl']`

##### <a name="-prometheus--alertmanager--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'alertmanager'`

##### <a name="-prometheus--alertmanager--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.27.0'`

##### <a name="-prometheus--alertmanager--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--alertmanager--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

### <a name="prometheus--apache_exporter"></a>`prometheus::apache_exporter`

This module manages prometheus apache_exporter

#### Parameters

The following parameters are available in the `prometheus::apache_exporter` class:

* [`arch`](#-prometheus--apache_exporter--arch)
* [`bin_dir`](#-prometheus--apache_exporter--bin_dir)
* [`config_mode`](#-prometheus--apache_exporter--config_mode)
* [`download_extension`](#-prometheus--apache_exporter--download_extension)
* [`download_url`](#-prometheus--apache_exporter--download_url)
* [`download_url_base`](#-prometheus--apache_exporter--download_url_base)
* [`extra_groups`](#-prometheus--apache_exporter--extra_groups)
* [`extra_options`](#-prometheus--apache_exporter--extra_options)
* [`group`](#-prometheus--apache_exporter--group)
* [`init_style`](#-prometheus--apache_exporter--init_style)
* [`install_method`](#-prometheus--apache_exporter--install_method)
* [`manage_group`](#-prometheus--apache_exporter--manage_group)
* [`manage_service`](#-prometheus--apache_exporter--manage_service)
* [`manage_user`](#-prometheus--apache_exporter--manage_user)
* [`os`](#-prometheus--apache_exporter--os)
* [`package_ensure`](#-prometheus--apache_exporter--package_ensure)
* [`package_name`](#-prometheus--apache_exporter--package_name)
* [`purge_config_dir`](#-prometheus--apache_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--apache_exporter--restart_on_change)
* [`scrape_uri`](#-prometheus--apache_exporter--scrape_uri)
* [`service_enable`](#-prometheus--apache_exporter--service_enable)
* [`service_ensure`](#-prometheus--apache_exporter--service_ensure)
* [`service_name`](#-prometheus--apache_exporter--service_name)
* [`user`](#-prometheus--apache_exporter--user)
* [`version`](#-prometheus--apache_exporter--version)
* [`proxy_server`](#-prometheus--apache_exporter--proxy_server)
* [`proxy_type`](#-prometheus--apache_exporter--proxy_type)
* [`web_config_file`](#-prometheus--apache_exporter--web_config_file)
* [`web_config_content`](#-prometheus--apache_exporter--web_config_content)
* [`export_scrape_job`](#-prometheus--apache_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--apache_exporter--scrape_host)
* [`scrape_port`](#-prometheus--apache_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--apache_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--apache_exporter--scrape_job_labels)

##### <a name="-prometheus--apache_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--apache_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--apache_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--apache_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--apache_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--apache_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/Lusitaniae/apache_exporter/releases'`

##### <a name="-prometheus--apache_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--apache_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--apache_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'apache-exporter'`

##### <a name="-prometheus--apache_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--apache_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--apache_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--apache_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--apache_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--apache_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--apache_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--apache_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'apache_exporter'`

##### <a name="-prometheus--apache_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--apache_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--apache_exporter--scrape_uri"></a>`scrape_uri`

Data type: `String[1]`

The URI for the Apache status page

Default value: `'http://localhost/server-status/?auto'`

##### <a name="-prometheus--apache_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--apache_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--apache_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'apache_exporter')

Default value: `'apache_exporter'`

##### <a name="-prometheus--apache_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'apache-exporter'`

##### <a name="-prometheus--apache_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.0.12'`

##### <a name="-prometheus--apache_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--apache_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--apache_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/apache_exporter_web-config.yml'`

##### <a name="-prometheus--apache_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

##### <a name="-prometheus--apache_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--apache_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--apache_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9117`

##### <a name="-prometheus--apache_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'apache'`

##### <a name="-prometheus--apache_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--beanstalkd_exporter"></a>`prometheus::beanstalkd_exporter`

This module manages prometheus beanstalkd_exporter

#### Parameters

The following parameters are available in the `prometheus::beanstalkd_exporter` class:

* [`arch`](#-prometheus--beanstalkd_exporter--arch)
* [`bin_dir`](#-prometheus--beanstalkd_exporter--bin_dir)
* [`config`](#-prometheus--beanstalkd_exporter--config)
* [`mapping_config`](#-prometheus--beanstalkd_exporter--mapping_config)
* [`beanstalkd_address`](#-prometheus--beanstalkd_exporter--beanstalkd_address)
* [`exporter_listen`](#-prometheus--beanstalkd_exporter--exporter_listen)
* [`download_extension`](#-prometheus--beanstalkd_exporter--download_extension)
* [`download_url`](#-prometheus--beanstalkd_exporter--download_url)
* [`download_url_base`](#-prometheus--beanstalkd_exporter--download_url_base)
* [`extra_groups`](#-prometheus--beanstalkd_exporter--extra_groups)
* [`extra_options`](#-prometheus--beanstalkd_exporter--extra_options)
* [`group`](#-prometheus--beanstalkd_exporter--group)
* [`init_style`](#-prometheus--beanstalkd_exporter--init_style)
* [`install_method`](#-prometheus--beanstalkd_exporter--install_method)
* [`manage_group`](#-prometheus--beanstalkd_exporter--manage_group)
* [`manage_service`](#-prometheus--beanstalkd_exporter--manage_service)
* [`manage_user`](#-prometheus--beanstalkd_exporter--manage_user)
* [`os`](#-prometheus--beanstalkd_exporter--os)
* [`package_ensure`](#-prometheus--beanstalkd_exporter--package_ensure)
* [`package_name`](#-prometheus--beanstalkd_exporter--package_name)
* [`purge_config_dir`](#-prometheus--beanstalkd_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--beanstalkd_exporter--restart_on_change)
* [`service_enable`](#-prometheus--beanstalkd_exporter--service_enable)
* [`service_ensure`](#-prometheus--beanstalkd_exporter--service_ensure)
* [`service_name`](#-prometheus--beanstalkd_exporter--service_name)
* [`user`](#-prometheus--beanstalkd_exporter--user)
* [`version`](#-prometheus--beanstalkd_exporter--version)
* [`proxy_server`](#-prometheus--beanstalkd_exporter--proxy_server)
* [`proxy_type`](#-prometheus--beanstalkd_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--beanstalkd_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--beanstalkd_exporter--scrape_host)
* [`scrape_port`](#-prometheus--beanstalkd_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--beanstalkd_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--beanstalkd_exporter--scrape_job_labels)

##### <a name="-prometheus--beanstalkd_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--beanstalkd_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--beanstalkd_exporter--config"></a>`config`

Data type: `Stdlib::Absolutepath`

Path to configuration file that stores beanstalkd address

Default value: `'/etc/beanstalkd-exporter.conf'`

##### <a name="-prometheus--beanstalkd_exporter--mapping_config"></a>`mapping_config`

Data type: `Stdlib::Absolutepath`

Path to configuration file with tubes mappings (not implemented)

Default value: `'/etc/beanstalkd-exporter-mapping.conf'`

##### <a name="-prometheus--beanstalkd_exporter--beanstalkd_address"></a>`beanstalkd_address`

Data type: `String[1]`

Address of beanstalkd, defaults to localhost

Default value: `'127.0.0.1:11300'`

##### <a name="-prometheus--beanstalkd_exporter--exporter_listen"></a>`exporter_listen`

Data type: `String[1]`

Address to bind beanstalkd_exporter to. Default is different than upstream (*:9371)

Default value: `':9371'`

##### <a name="-prometheus--beanstalkd_exporter--download_extension"></a>`download_extension`

Data type: `String[0]`

Extension for the release binary archive

Default value: `''`

##### <a name="-prometheus--beanstalkd_exporter--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--beanstalkd_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/messagebird/beanstalkd_exporter/releases'`

##### <a name="-prometheus--beanstalkd_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--beanstalkd_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--beanstalkd_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'beanstalkd-exporter'`

##### <a name="-prometheus--beanstalkd_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--beanstalkd_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--beanstalkd_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--beanstalkd_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--beanstalkd_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'beanstalkd_exporter'`

##### <a name="-prometheus--beanstalkd_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--beanstalkd_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--beanstalkd_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the beanstalkd exporter service (default 'beanstalkd_exporter')

Default value: `'beanstalkd_exporter'`

##### <a name="-prometheus--beanstalkd_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'beanstalkd-exporter'`

##### <a name="-prometheus--beanstalkd_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.0.5'`

##### <a name="-prometheus--beanstalkd_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--beanstalkd_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--beanstalkd_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--beanstalkd_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--beanstalkd_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `8080`

##### <a name="-prometheus--beanstalkd_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'beanstalkd'`

##### <a name="-prometheus--beanstalkd_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--bind_exporter"></a>`prometheus::bind_exporter`

Class: prometheus::bind_exporter

This module manages prometheus bind_exporter

#### Parameters

The following parameters are available in the `prometheus::bind_exporter` class:

* [`arch`](#-prometheus--bind_exporter--arch)
* [`bin_dir`](#-prometheus--bind_exporter--bin_dir)
* [`config_mode`](#-prometheus--bind_exporter--config_mode)
* [`download_extension`](#-prometheus--bind_exporter--download_extension)
* [`download_url`](#-prometheus--bind_exporter--download_url)
* [`download_url_base`](#-prometheus--bind_exporter--download_url_base)
* [`extra_groups`](#-prometheus--bind_exporter--extra_groups)
* [`extra_options`](#-prometheus--bind_exporter--extra_options)
* [`env_vars`](#-prometheus--bind_exporter--env_vars)
* [`group`](#-prometheus--bind_exporter--group)
* [`init_style`](#-prometheus--bind_exporter--init_style)
* [`install_method`](#-prometheus--bind_exporter--install_method)
* [`manage_group`](#-prometheus--bind_exporter--manage_group)
* [`manage_service`](#-prometheus--bind_exporter--manage_service)
* [`manage_user`](#-prometheus--bind_exporter--manage_user)
* [`os`](#-prometheus--bind_exporter--os)
* [`package_ensure`](#-prometheus--bind_exporter--package_ensure)
* [`package_name`](#-prometheus--bind_exporter--package_name)
* [`purge_config_dir`](#-prometheus--bind_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--bind_exporter--restart_on_change)
* [`service_enable`](#-prometheus--bind_exporter--service_enable)
* [`service_ensure`](#-prometheus--bind_exporter--service_ensure)
* [`service_name`](#-prometheus--bind_exporter--service_name)
* [`user`](#-prometheus--bind_exporter--user)
* [`version`](#-prometheus--bind_exporter--version)
* [`export_scrape_job`](#-prometheus--bind_exporter--export_scrape_job)
* [`scrape_job_name`](#-prometheus--bind_exporter--scrape_job_name)
* [`scrape_port`](#-prometheus--bind_exporter--scrape_port)
* [`scrape_job_labels`](#-prometheus--bind_exporter--scrape_job_labels)
* [`proxy_server`](#-prometheus--bind_exporter--proxy_server)
* [`proxy_type`](#-prometheus--bind_exporter--proxy_type)

##### <a name="-prometheus--bind_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--bind_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--bind_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--bind_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--bind_exporter--download_url"></a>`download_url`

Data type: `Optional[Stdlib::HTTPSUrl]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--bind_exporter--download_url_base"></a>`download_url_base`

Data type: `Stdlib::HTTPSUrl`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/bind_exporter/releases'`

##### <a name="-prometheus--bind_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--bind_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--bind_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String, Scalar]`

The environment variable to pass to the daemon

Default value: `{}`

##### <a name="-prometheus--bind_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'bind-exporter'`

##### <a name="-prometheus--bind_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--bind_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--bind_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--bind_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--bind_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--bind_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--bind_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--bind_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'bind_exporter'`

##### <a name="-prometheus--bind_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--bind_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--bind_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--bind_exporter--service_ensure"></a>`service_ensure`

Data type: `String[1]`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--bind_exporter--service_name"></a>`service_name`

Data type: `String`

Name of the node exporter service (default 'bind_exporter')

Default value: `'bind_exporter'`

##### <a name="-prometheus--bind_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'bind-exporter'`

##### <a name="-prometheus--bind_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.8.0'`

##### <a name="-prometheus--bind_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`

Whether to export a `prometheus::scrape_job` to puppetDB for
collecting on your prometheus server.

Default value: `false`

##### <a name="-prometheus--bind_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`

The name of the scrape job. When configuring prometheus with this
puppet module, the jobs to be collected are configured with
`prometheus::collect_scrape_jobs`.

Default value: `'bind'`

##### <a name="-prometheus--bind_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

The port to use in the scrape job.  This won't normally need to be
changed unless you run the exporter with a non-default port by
overriding `extra_options`.

Default value: `9119`

##### <a name="-prometheus--bind_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`

Labels to configure on the scrape job. If not set, the
`prometheus::daemon` default (`{ 'alias' => $scrape_host }`) will
be used.

Default value: `undef`

##### <a name="-prometheus--bind_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--bind_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

### <a name="prometheus--bird_exporter"></a>`prometheus::bird_exporter`

This module manages prometheus bird exporter

* **See also**
  * https://github.com/czerwonk/bird_exporter

#### Examples

##### configure bird_exporter on Arch Linux via the repository package

```puppet
class { 'prometheus::bird_exporter':
  env_vars => { 'BIRD_EXPORTER_ARGS'=> '-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true -bird.socket=/var/run/bird/bird.ctl -format.description-labels' },
  require  => Service['bird'],
}
```

#### Parameters

The following parameters are available in the `prometheus::bird_exporter` class:

* [`arch`](#-prometheus--bird_exporter--arch)
* [`bin_dir`](#-prometheus--bird_exporter--bin_dir)
* [`download_extension`](#-prometheus--bird_exporter--download_extension)
* [`download_url`](#-prometheus--bird_exporter--download_url)
* [`download_url_base`](#-prometheus--bird_exporter--download_url_base)
* [`extra_groups`](#-prometheus--bird_exporter--extra_groups)
* [`extra_options`](#-prometheus--bird_exporter--extra_options)
* [`group`](#-prometheus--bird_exporter--group)
* [`init_style`](#-prometheus--bird_exporter--init_style)
* [`install_method`](#-prometheus--bird_exporter--install_method)
* [`manage_group`](#-prometheus--bird_exporter--manage_group)
* [`manage_service`](#-prometheus--bird_exporter--manage_service)
* [`manage_user`](#-prometheus--bird_exporter--manage_user)
* [`os`](#-prometheus--bird_exporter--os)
* [`package_ensure`](#-prometheus--bird_exporter--package_ensure)
* [`package_name`](#-prometheus--bird_exporter--package_name)
* [`purge_config_dir`](#-prometheus--bird_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--bird_exporter--restart_on_change)
* [`service_enable`](#-prometheus--bird_exporter--service_enable)
* [`service_ensure`](#-prometheus--bird_exporter--service_ensure)
* [`service_name`](#-prometheus--bird_exporter--service_name)
* [`user`](#-prometheus--bird_exporter--user)
* [`version`](#-prometheus--bird_exporter--version)
* [`env_vars`](#-prometheus--bird_exporter--env_vars)
* [`env_file_path`](#-prometheus--bird_exporter--env_file_path)
* [`proxy_server`](#-prometheus--bird_exporter--proxy_server)
* [`proxy_type`](#-prometheus--bird_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--bird_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--bird_exporter--scrape_host)
* [`scrape_port`](#-prometheus--bird_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--bird_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--bird_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--bird_exporter--bin_name)

##### <a name="-prometheus--bird_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--bird_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--bird_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `''`

##### <a name="-prometheus--bird_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--bird_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/czerwonk/bird_exporter/releases'`

##### <a name="-prometheus--bird_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `['bird']`

##### <a name="-prometheus--bird_exporter--extra_options"></a>`extra_options`

Data type: `String[1]`

Extra options added to the startup command

Default value: `'-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true'`

##### <a name="-prometheus--bird_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'bird-exporter'`

##### <a name="-prometheus--bird_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--bird_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `'url'`

##### <a name="-prometheus--bird_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--bird_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--bird_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--bird_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--bird_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'installed'`

##### <a name="-prometheus--bird_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'bird_exporter'`

##### <a name="-prometheus--bird_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--bird_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--bird_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--bird_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--bird_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the bird exporter service (default 'bird_exporter')

Default value: `'bird_exporter'`

##### <a name="-prometheus--bird_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'bird-exporter'`

##### <a name="-prometheus--bird_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.2.5'`

##### <a name="-prometheus--bird_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`

hash with custom environment variables thats passed to the exporter via init script / unit file

Default value: `{}`

##### <a name="-prometheus--bird_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`

The path to the file with the environmetn variable that is read from the init script/systemd unit

Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--bird_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--bird_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--bird_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--bird_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--bird_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9324`

##### <a name="-prometheus--bird_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'bird'`

##### <a name="-prometheus--bird_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--bird_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--blackbox_exporter"></a>`prometheus::blackbox_exporter`

prometheus::blackbox_exporter::modules:
  simple_ssl:
    prober: http
    timeout: 10s
    http:
      fail_if_not_ssl: true
  easy_tcp:
    prober: tcp
    tcp:
      preferred_ip_protocol: ip4
@ see https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md

#### Examples

##### Example for configuring named blackbox modules via hiera

```puppet

```

#### Parameters

The following parameters are available in the `prometheus::blackbox_exporter` class:

* [`arch`](#-prometheus--blackbox_exporter--arch)
* [`bin_dir`](#-prometheus--blackbox_exporter--bin_dir)
* [`config_file`](#-prometheus--blackbox_exporter--config_file)
* [`download_extension`](#-prometheus--blackbox_exporter--download_extension)
* [`download_url`](#-prometheus--blackbox_exporter--download_url)
* [`download_url_base`](#-prometheus--blackbox_exporter--download_url_base)
* [`extra_groups`](#-prometheus--blackbox_exporter--extra_groups)
* [`extra_options`](#-prometheus--blackbox_exporter--extra_options)
* [`group`](#-prometheus--blackbox_exporter--group)
* [`init_style`](#-prometheus--blackbox_exporter--init_style)
* [`install_method`](#-prometheus--blackbox_exporter--install_method)
* [`manage_group`](#-prometheus--blackbox_exporter--manage_group)
* [`manage_service`](#-prometheus--blackbox_exporter--manage_service)
* [`manage_user`](#-prometheus--blackbox_exporter--manage_user)
* [`modules`](#-prometheus--blackbox_exporter--modules)
* [`export_scrape_job`](#-prometheus--blackbox_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--blackbox_exporter--scrape_host)
* [`scrape_port`](#-prometheus--blackbox_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--blackbox_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--blackbox_exporter--scrape_job_labels)
* [`os`](#-prometheus--blackbox_exporter--os)
* [`package_ensure`](#-prometheus--blackbox_exporter--package_ensure)
* [`package_name`](#-prometheus--blackbox_exporter--package_name)
* [`restart_on_change`](#-prometheus--blackbox_exporter--restart_on_change)
* [`service_enable`](#-prometheus--blackbox_exporter--service_enable)
* [`service_ensure`](#-prometheus--blackbox_exporter--service_ensure)
* [`service_name`](#-prometheus--blackbox_exporter--service_name)
* [`user`](#-prometheus--blackbox_exporter--user)
* [`version`](#-prometheus--blackbox_exporter--version)
* [`config_mode`](#-prometheus--blackbox_exporter--config_mode)
* [`env_vars`](#-prometheus--blackbox_exporter--env_vars)
* [`env_file_path`](#-prometheus--blackbox_exporter--env_file_path)
* [`proxy_server`](#-prometheus--blackbox_exporter--proxy_server)
* [`proxy_type`](#-prometheus--blackbox_exporter--proxy_type)
* [`web_config_file`](#-prometheus--blackbox_exporter--web_config_file)
* [`web_config_content`](#-prometheus--blackbox_exporter--web_config_content)

##### <a name="-prometheus--blackbox_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--blackbox_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--blackbox_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Absolute path to configuration file (blackbox module definitions)

Default value: `'/etc/blackbox-exporter.yaml'`

##### <a name="-prometheus--blackbox_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--blackbox_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/blackbox_exporter/releases'`

##### <a name="-prometheus--blackbox_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--blackbox_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'blackbox-exporter'`

##### <a name="-prometheus--blackbox_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--blackbox_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--blackbox_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--blackbox_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--blackbox_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--blackbox_exporter--modules"></a>`modules`

Data type: `Hash`

Structured, array of blackbox module definitions for different probe types

Default value: `{}`

##### <a name="-prometheus--blackbox_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`

Whether to export a scrape job for this service

Default value: `false`

##### <a name="-prometheus--blackbox_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`

Hostname or IP address to scrape

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

Host port to scrape

Default value: `9115`

##### <a name="-prometheus--blackbox_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`

Name of the scrape job to export, if export_scrape_job is true

Default value: `'blackbox'`

##### <a name="-prometheus--blackbox_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`

Labels to add to the scrape job, if export_scrape_job is true

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--blackbox_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--blackbox_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'blackbox_exporter'`

##### <a name="-prometheus--blackbox_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--blackbox_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--blackbox_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--blackbox_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'blackbox_exporter')

Default value: `'blackbox_exporter'`

##### <a name="-prometheus--blackbox_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'blackbox-exporter'`

##### <a name="-prometheus--blackbox_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.28.0'`

##### <a name="-prometheus--blackbox_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--blackbox_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`

hash with custom environment variables thats passed to the exporter via init script / unit file

Default value: `{}`

##### <a name="-prometheus--blackbox_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`

The path to the file with the environmetn variable that is read from the init script/systemd unit

Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--blackbox_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--blackbox_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/blackbox_exporter_web-config.yml'`

##### <a name="-prometheus--blackbox_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

### <a name="prometheus--cgroup_exporter"></a>`prometheus::cgroup_exporter`

This module manages prometheus cgroup_exporter (https://github.com/treydock/cgroup_exporter)

#### Parameters

The following parameters are available in the `prometheus::cgroup_exporter` class:

* [`arch`](#-prometheus--cgroup_exporter--arch)
* [`bin_dir`](#-prometheus--cgroup_exporter--bin_dir)
* [`download_extension`](#-prometheus--cgroup_exporter--download_extension)
* [`download_url`](#-prometheus--cgroup_exporter--download_url)
* [`download_url_base`](#-prometheus--cgroup_exporter--download_url_base)
* [`extra_groups`](#-prometheus--cgroup_exporter--extra_groups)
* [`extra_options`](#-prometheus--cgroup_exporter--extra_options)
* [`group`](#-prometheus--cgroup_exporter--group)
* [`init_style`](#-prometheus--cgroup_exporter--init_style)
* [`install_method`](#-prometheus--cgroup_exporter--install_method)
* [`manage_group`](#-prometheus--cgroup_exporter--manage_group)
* [`manage_service`](#-prometheus--cgroup_exporter--manage_service)
* [`manage_user`](#-prometheus--cgroup_exporter--manage_user)
* [`modules`](#-prometheus--cgroup_exporter--modules)
* [`export_scrape_job`](#-prometheus--cgroup_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--cgroup_exporter--scrape_host)
* [`scrape_port`](#-prometheus--cgroup_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--cgroup_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--cgroup_exporter--scrape_job_labels)
* [`os`](#-prometheus--cgroup_exporter--os)
* [`package_ensure`](#-prometheus--cgroup_exporter--package_ensure)
* [`package_name`](#-prometheus--cgroup_exporter--package_name)
* [`purge_config_dir`](#-prometheus--cgroup_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--cgroup_exporter--restart_on_change)
* [`service_enable`](#-prometheus--cgroup_exporter--service_enable)
* [`service_ensure`](#-prometheus--cgroup_exporter--service_ensure)
* [`service_name`](#-prometheus--cgroup_exporter--service_name)
* [`user`](#-prometheus--cgroup_exporter--user)
* [`version`](#-prometheus--cgroup_exporter--version)
* [`proxy_server`](#-prometheus--cgroup_exporter--proxy_server)
* [`proxy_type`](#-prometheus--cgroup_exporter--proxy_type)
* [`cgroup_paths`](#-prometheus--cgroup_exporter--cgroup_paths)
* [`unprivileged`](#-prometheus--cgroup_exporter--unprivileged)
* [`archive_bin_path`](#-prometheus--cgroup_exporter--archive_bin_path)
* [`env_file_path`](#-prometheus--cgroup_exporter--env_file_path)

##### <a name="-prometheus--cgroup_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (x86_64)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--cgroup_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--cgroup_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--cgroup_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/treydock/cgroup_exporter/releases'`

##### <a name="-prometheus--cgroup_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--cgroup_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'cgroup-exporter'`

##### <a name="-prometheus--cgroup_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--cgroup_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--cgroup_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--modules"></a>`modules`

Data type: `Hash`

Structured, array of blackbox module definitions for different probe types

Default value: `{}`

##### <a name="-prometheus--cgroup_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`

Whether to export a scrape job for this service

Default value: `false`

##### <a name="-prometheus--cgroup_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`

Hostname or IP address to scrape

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

Host port to scrape

Default value: `9306`

##### <a name="-prometheus--cgroup_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`

Name of the scrape job to export, if export_scrape_job is true

Default value: `'cgroup'`

##### <a name="-prometheus--cgroup_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`

Labels to add to the scrape job, if export_scrape_job is true

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase(fact('kernel'))`

##### <a name="-prometheus--cgroup_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--cgroup_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'cgroup_exporter'`

##### <a name="-prometheus--cgroup_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--cgroup_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--cgroup_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'cgroup_exporter')

Default value: `'cgroup_exporter'`

##### <a name="-prometheus--cgroup_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'cgroup-exporter'`

##### <a name="-prometheus--cgroup_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.0.1'`

##### <a name="-prometheus--cgroup_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--cgroup_exporter--cgroup_paths"></a>`cgroup_paths`

Data type: `Enum['slurm', 'user.slice']`

cgroup paths (slurm|user.slice)

Default value: `'slurm'`

##### <a name="-prometheus--cgroup_exporter--unprivileged"></a>`unprivileged`

Data type: `Boolean`

If true, run the exporter as an unprivileged user and add sudoers entrie to manage the binary exporter

Default value: `false`

##### <a name="-prometheus--cgroup_exporter--archive_bin_path"></a>`archive_bin_path`

Data type: `Stdlib::Absolutepath`

Path to the binary in the downloaded archive.

Default value: `"/opt/${package_name}-${version}.${os}-${arch}/${package_name}"`

##### <a name="-prometheus--cgroup_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`

The path to the file with the environmetn variable that is read from the init script/systemd unit

Default value: `$prometheus::env_file_path`

### <a name="prometheus--collectd_exporter"></a>`prometheus::collectd_exporter`

This module manages prometheus node collectd_exporter

#### Parameters

The following parameters are available in the `prometheus::collectd_exporter` class:

* [`arch`](#-prometheus--collectd_exporter--arch)
* [`bin_dir`](#-prometheus--collectd_exporter--bin_dir)
* [`download_extension`](#-prometheus--collectd_exporter--download_extension)
* [`download_url`](#-prometheus--collectd_exporter--download_url)
* [`download_url_base`](#-prometheus--collectd_exporter--download_url_base)
* [`options`](#-prometheus--collectd_exporter--options)
* [`group`](#-prometheus--collectd_exporter--group)
* [`init_style`](#-prometheus--collectd_exporter--init_style)
* [`install_method`](#-prometheus--collectd_exporter--install_method)
* [`manage_group`](#-prometheus--collectd_exporter--manage_group)
* [`manage_service`](#-prometheus--collectd_exporter--manage_service)
* [`manage_user`](#-prometheus--collectd_exporter--manage_user)
* [`os`](#-prometheus--collectd_exporter--os)
* [`package_ensure`](#-prometheus--collectd_exporter--package_ensure)
* [`package_name`](#-prometheus--collectd_exporter--package_name)
* [`purge_config_dir`](#-prometheus--collectd_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--collectd_exporter--restart_on_change)
* [`service_enable`](#-prometheus--collectd_exporter--service_enable)
* [`service_ensure`](#-prometheus--collectd_exporter--service_ensure)
* [`service_name`](#-prometheus--collectd_exporter--service_name)
* [`user`](#-prometheus--collectd_exporter--user)
* [`version`](#-prometheus--collectd_exporter--version)
* [`proxy_server`](#-prometheus--collectd_exporter--proxy_server)
* [`proxy_type`](#-prometheus--collectd_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--collectd_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--collectd_exporter--scrape_host)
* [`scrape_port`](#-prometheus--collectd_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--collectd_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--collectd_exporter--scrape_job_labels)

##### <a name="-prometheus--collectd_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--collectd_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--collectd_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--collectd_exporter--download_url"></a>`download_url`

Data type: `Optional[String[1]]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--collectd_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/collectd_exporter/releases'`

##### <a name="-prometheus--collectd_exporter--options"></a>`options`

Data type: `String`

Options added to the startup command

Default value: `''`

##### <a name="-prometheus--collectd_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'collectd-exporter'`

##### <a name="-prometheus--collectd_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--collectd_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--collectd_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--collectd_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--collectd_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--collectd_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--collectd_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--collectd_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'collectd_exporter'`

##### <a name="-prometheus--collectd_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--collectd_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--collectd_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--collectd_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--collectd_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the collectd exporter service (default 'collectd_exporter')

Default value: `'collectd_exporter'`

##### <a name="-prometheus--collectd_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'collectd-exporter'`

##### <a name="-prometheus--collectd_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.7.0'`

##### <a name="-prometheus--collectd_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--collectd_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--collectd_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--collectd_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--collectd_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9103`

##### <a name="-prometheus--collectd_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'collectd'`

##### <a name="-prometheus--collectd_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--config"></a>`prometheus::config`

Configuration class for prometheus monitoring system

### <a name="prometheus--consul_exporter"></a>`prometheus::consul_exporter`

This module manages prometheus node consul_exporter

#### Parameters

The following parameters are available in the `prometheus::consul_exporter` class:

* [`arch`](#-prometheus--consul_exporter--arch)
* [`bin_dir`](#-prometheus--consul_exporter--bin_dir)
* [`consul_server`](#-prometheus--consul_exporter--consul_server)
* [`consul_health_summary`](#-prometheus--consul_exporter--consul_health_summary)
* [`download_extension`](#-prometheus--consul_exporter--download_extension)
* [`download_url`](#-prometheus--consul_exporter--download_url)
* [`download_url_base`](#-prometheus--consul_exporter--download_url_base)
* [`extra_groups`](#-prometheus--consul_exporter--extra_groups)
* [`extra_options`](#-prometheus--consul_exporter--extra_options)
* [`group`](#-prometheus--consul_exporter--group)
* [`init_style`](#-prometheus--consul_exporter--init_style)
* [`install_method`](#-prometheus--consul_exporter--install_method)
* [`log_level`](#-prometheus--consul_exporter--log_level)
* [`manage_group`](#-prometheus--consul_exporter--manage_group)
* [`manage_service`](#-prometheus--consul_exporter--manage_service)
* [`manage_user`](#-prometheus--consul_exporter--manage_user)
* [`os`](#-prometheus--consul_exporter--os)
* [`package_ensure`](#-prometheus--consul_exporter--package_ensure)
* [`package_name`](#-prometheus--consul_exporter--package_name)
* [`purge_config_dir`](#-prometheus--consul_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--consul_exporter--restart_on_change)
* [`service_enable`](#-prometheus--consul_exporter--service_enable)
* [`service_ensure`](#-prometheus--consul_exporter--service_ensure)
* [`service_name`](#-prometheus--consul_exporter--service_name)
* [`user`](#-prometheus--consul_exporter--user)
* [`version`](#-prometheus--consul_exporter--version)
* [`web_listen_address`](#-prometheus--consul_exporter--web_listen_address)
* [`web_telemetry_path`](#-prometheus--consul_exporter--web_telemetry_path)
* [`proxy_server`](#-prometheus--consul_exporter--proxy_server)
* [`proxy_type`](#-prometheus--consul_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--consul_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--consul_exporter--scrape_host)
* [`scrape_port`](#-prometheus--consul_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--consul_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--consul_exporter--scrape_job_labels)

##### <a name="-prometheus--consul_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--consul_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--consul_exporter--consul_server"></a>`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")

Default value: `'localhost:8500'`

##### <a name="-prometheus--consul_exporter--consul_health_summary"></a>`consul_health_summary`

Data type: `Boolean`

Generate a health summary for each service instance. Needs n+1 queries to collect all information. (default true)

Default value: `true`

##### <a name="-prometheus--consul_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--consul_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--consul_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/consul_exporter/releases'`

##### <a name="-prometheus--consul_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--consul_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--consul_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'consul-exporter'`

##### <a name="-prometheus--consul_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--consul_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--consul_exporter--log_level"></a>`log_level`

Data type: `String[1]`

Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default "info")

Default value: `'info'`

##### <a name="-prometheus--consul_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--consul_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--consul_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--consul_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--consul_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--consul_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'consul_exporter'`

##### <a name="-prometheus--consul_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--consul_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--consul_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--consul_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--consul_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the consul exporter service (default 'consul_exporter')

Default value: `'consul_exporter'`

##### <a name="-prometheus--consul_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'consul-exporter'`

##### <a name="-prometheus--consul_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.13.0'`

##### <a name="-prometheus--consul_exporter--web_listen_address"></a>`web_listen_address`

Data type: `String[1]`

Address to listen on for web interface and telemetry. (default ":9107")

Default value: `':9107'`

##### <a name="-prometheus--consul_exporter--web_telemetry_path"></a>`web_telemetry_path`

Data type: `String[1]`

Path under which to expose metrics. (default "/metrics")

Default value: `'/metrics'`

##### <a name="-prometheus--consul_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--consul_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--consul_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--consul_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--consul_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9107`

##### <a name="-prometheus--consul_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'consul'`

##### <a name="-prometheus--consul_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--dellhw_exporter"></a>`prometheus::dellhw_exporter`

This module manages prometheus node dellhw_exporter

#### Parameters

The following parameters are available in the `prometheus::dellhw_exporter` class:

* [`arch`](#-prometheus--dellhw_exporter--arch)
* [`bin_dir`](#-prometheus--dellhw_exporter--bin_dir)
* [`download_extension`](#-prometheus--dellhw_exporter--download_extension)
* [`download_url`](#-prometheus--dellhw_exporter--download_url)
* [`download_url_base`](#-prometheus--dellhw_exporter--download_url_base)
* [`extra_groups`](#-prometheus--dellhw_exporter--extra_groups)
* [`extra_options`](#-prometheus--dellhw_exporter--extra_options)
* [`group`](#-prometheus--dellhw_exporter--group)
* [`init_style`](#-prometheus--dellhw_exporter--init_style)
* [`install_method`](#-prometheus--dellhw_exporter--install_method)
* [`manage_group`](#-prometheus--dellhw_exporter--manage_group)
* [`manage_service`](#-prometheus--dellhw_exporter--manage_service)
* [`manage_user`](#-prometheus--dellhw_exporter--manage_user)
* [`os`](#-prometheus--dellhw_exporter--os)
* [`package_ensure`](#-prometheus--dellhw_exporter--package_ensure)
* [`package_name`](#-prometheus--dellhw_exporter--package_name)
* [`purge_config_dir`](#-prometheus--dellhw_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--dellhw_exporter--restart_on_change)
* [`service_enable`](#-prometheus--dellhw_exporter--service_enable)
* [`service_ensure`](#-prometheus--dellhw_exporter--service_ensure)
* [`service_name`](#-prometheus--dellhw_exporter--service_name)
* [`user`](#-prometheus--dellhw_exporter--user)
* [`version`](#-prometheus--dellhw_exporter--version)
* [`omreport_path`](#-prometheus--dellhw_exporter--omreport_path)
* [`scrape_ipadress`](#-prometheus--dellhw_exporter--scrape_ipadress)
* [`proxy_server`](#-prometheus--dellhw_exporter--proxy_server)
* [`proxy_type`](#-prometheus--dellhw_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--dellhw_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--dellhw_exporter--scrape_host)
* [`scrape_port`](#-prometheus--dellhw_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--dellhw_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--dellhw_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--dellhw_exporter--bin_name)

##### <a name="-prometheus--dellhw_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--dellhw_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--dellhw_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--dellhw_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/galexrt/dellhw_exporter/releases'`

##### <a name="-prometheus--dellhw_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--dellhw_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'dellhw-exporter'`

##### <a name="-prometheus--dellhw_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--dellhw_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--dellhw_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--dellhw_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'present'`

##### <a name="-prometheus--dellhw_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'dellhw_exporter'`

##### <a name="-prometheus--dellhw_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--dellhw_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--dellhw_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the dellhw exporter service (default 'dellhw_exporter')

Default value: `'dellhw_exporter'`

##### <a name="-prometheus--dellhw_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'dellhw-exporter'`

##### <a name="-prometheus--dellhw_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.13.13'`

##### <a name="-prometheus--dellhw_exporter--omreport_path"></a>`omreport_path`

Data type: `Stdlib::Unixpath`

The file path to the omReport executable (default "/opt/dell/srvadmin/bin/omreport")

Default value: `'/opt/dell/srvadmin/bin/omreport'`

##### <a name="-prometheus--dellhw_exporter--scrape_ipadress"></a>`scrape_ipadress`

Data type: `String`

The ip address that the exporter will to listen to (default '')

Default value: `''`

##### <a name="-prometheus--dellhw_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--dellhw_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9137`

##### <a name="-prometheus--dellhw_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'dellhw'`

##### <a name="-prometheus--dellhw_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--dellhw_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--elasticsearch_exporter"></a>`prometheus::elasticsearch_exporter`

This module manages prometheus elasticsearch_exporter

#### Parameters

The following parameters are available in the `prometheus::elasticsearch_exporter` class:

* [`arch`](#-prometheus--elasticsearch_exporter--arch)
* [`bin_dir`](#-prometheus--elasticsearch_exporter--bin_dir)
* [`cnf_uri`](#-prometheus--elasticsearch_exporter--cnf_uri)
* [`cnf_timeout`](#-prometheus--elasticsearch_exporter--cnf_timeout)
* [`download_extension`](#-prometheus--elasticsearch_exporter--download_extension)
* [`download_url`](#-prometheus--elasticsearch_exporter--download_url)
* [`download_url_base`](#-prometheus--elasticsearch_exporter--download_url_base)
* [`extra_groups`](#-prometheus--elasticsearch_exporter--extra_groups)
* [`extra_options`](#-prometheus--elasticsearch_exporter--extra_options)
* [`group`](#-prometheus--elasticsearch_exporter--group)
* [`init_style`](#-prometheus--elasticsearch_exporter--init_style)
* [`install_method`](#-prometheus--elasticsearch_exporter--install_method)
* [`manage_group`](#-prometheus--elasticsearch_exporter--manage_group)
* [`manage_service`](#-prometheus--elasticsearch_exporter--manage_service)
* [`manage_user`](#-prometheus--elasticsearch_exporter--manage_user)
* [`export_scrape_job`](#-prometheus--elasticsearch_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--elasticsearch_exporter--scrape_host)
* [`scrape_port`](#-prometheus--elasticsearch_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--elasticsearch_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--elasticsearch_exporter--scrape_job_labels)
* [`os`](#-prometheus--elasticsearch_exporter--os)
* [`package_ensure`](#-prometheus--elasticsearch_exporter--package_ensure)
* [`package_name`](#-prometheus--elasticsearch_exporter--package_name)
* [`purge_config_dir`](#-prometheus--elasticsearch_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--elasticsearch_exporter--restart_on_change)
* [`service_enable`](#-prometheus--elasticsearch_exporter--service_enable)
* [`service_ensure`](#-prometheus--elasticsearch_exporter--service_ensure)
* [`service_name`](#-prometheus--elasticsearch_exporter--service_name)
* [`user`](#-prometheus--elasticsearch_exporter--user)
* [`version`](#-prometheus--elasticsearch_exporter--version)
* [`proxy_server`](#-prometheus--elasticsearch_exporter--proxy_server)
* [`proxy_type`](#-prometheus--elasticsearch_exporter--proxy_type)
* [`web_config_file`](#-prometheus--elasticsearch_exporter--web_config_file)
* [`web_config_content`](#-prometheus--elasticsearch_exporter--web_config_content)

##### <a name="-prometheus--elasticsearch_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--elasticsearch_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--elasticsearch_exporter--cnf_uri"></a>`cnf_uri`

Data type: `String[1]`

The URI to obtain elasticsearch stats from

Default value: `'http://localhost:9200'`

##### <a name="-prometheus--elasticsearch_exporter--cnf_timeout"></a>`cnf_timeout`

Data type: `String[1]`

Timeout for trying to get stats from elasticsearch URI

Default value: `'5s'`

##### <a name="-prometheus--elasticsearch_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--elasticsearch_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/elasticsearch_exporter/releases'`

##### <a name="-prometheus--elasticsearch_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--elasticsearch_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'elasticsearch-exporter'`

##### <a name="-prometheus--elasticsearch_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--elasticsearch_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--elasticsearch_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`

Whether to export a scrape job for this service

Default value: `false`

##### <a name="-prometheus--elasticsearch_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`

Hostname or IP address to scrape

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

Host port to scrape

Default value: `9114`

##### <a name="-prometheus--elasticsearch_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`

Name of the scrape job to export, if export_scrape_job is true

Default value: `'elasticsearch'`

##### <a name="-prometheus--elasticsearch_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`

Labels to add to the scrape job, if export_scrape_job is true

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--elasticsearch_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--elasticsearch_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'elasticsearch_exporter'`

##### <a name="-prometheus--elasticsearch_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--elasticsearch_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--elasticsearch_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service

Default value: `'elasticsearch_exporter'`

##### <a name="-prometheus--elasticsearch_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'elasticsearch-exporter'`

##### <a name="-prometheus--elasticsearch_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.10.0'`

##### <a name="-prometheus--elasticsearch_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--elasticsearch_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/elasticsearch_exporter_web-config.yml'`

##### <a name="-prometheus--elasticsearch_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

### <a name="prometheus--frr_exporter"></a>`prometheus::frr_exporter`

This module manages prometheus FRR exporter

* **See also**
  * https://github.com/tynany/frr_exporter

#### Examples

##### configure frr_exporter to monitor BGP peers

```puppet
class { 'prometheus::frr_exporter':
  peer_descriptions    => true,
  peer_types          => true,
  advertised_prefixes => true,
  frr_socket_dir      => '/var/run/frr',
  web_listen_address  => ':9342',
}
```

#### Parameters

The following parameters are available in the `prometheus::frr_exporter` class:

* [`arch`](#-prometheus--frr_exporter--arch)
* [`bin_dir`](#-prometheus--frr_exporter--bin_dir)
* [`download_extension`](#-prometheus--frr_exporter--download_extension)
* [`download_url`](#-prometheus--frr_exporter--download_url)
* [`download_url_base`](#-prometheus--frr_exporter--download_url_base)
* [`extra_groups`](#-prometheus--frr_exporter--extra_groups)
* [`extra_options`](#-prometheus--frr_exporter--extra_options)
* [`frr_socket_dir`](#-prometheus--frr_exporter--frr_socket_dir)
* [`group`](#-prometheus--frr_exporter--group)
* [`init_style`](#-prometheus--frr_exporter--init_style)
* [`install_method`](#-prometheus--frr_exporter--install_method)
* [`log_level`](#-prometheus--frr_exporter--log_level)
* [`manage_group`](#-prometheus--frr_exporter--manage_group)
* [`manage_service`](#-prometheus--frr_exporter--manage_service)
* [`manage_user`](#-prometheus--frr_exporter--manage_user)
* [`advertised_prefixes`](#-prometheus--frr_exporter--advertised_prefixes)
* [`bgp6`](#-prometheus--frr_exporter--bgp6)
* [`os`](#-prometheus--frr_exporter--os)
* [`package_ensure`](#-prometheus--frr_exporter--package_ensure)
* [`package_name`](#-prometheus--frr_exporter--package_name)
* [`peer_descriptions`](#-prometheus--frr_exporter--peer_descriptions)
* [`peer_types`](#-prometheus--frr_exporter--peer_types)
* [`telemetry_path`](#-prometheus--frr_exporter--telemetry_path)
* [`purge_config_dir`](#-prometheus--frr_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--frr_exporter--restart_on_change)
* [`service_enable`](#-prometheus--frr_exporter--service_enable)
* [`service_ensure`](#-prometheus--frr_exporter--service_ensure)
* [`service_name`](#-prometheus--frr_exporter--service_name)
* [`user`](#-prometheus--frr_exporter--user)
* [`version`](#-prometheus--frr_exporter--version)
* [`web_listen_address`](#-prometheus--frr_exporter--web_listen_address)
* [`env_vars`](#-prometheus--frr_exporter--env_vars)
* [`ensure`](#-prometheus--frr_exporter--ensure)

##### <a name="-prometheus--frr_exporter--arch"></a>`arch`

Data type: `String`

Architecture (amd64 or arm64)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--frr_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--frr_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--frr_exporter--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--frr_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/tynany/frr_exporter/releases'`

##### <a name="-prometheus--frr_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--frr_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--frr_exporter--frr_socket_dir"></a>`frr_socket_dir`

Data type: `String`

Path to FRR socket directory for BGP monitoring

Default value: `'/var/run/frr'`

##### <a name="-prometheus--frr_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'frr-exporter'`

##### <a name="-prometheus--frr_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--frr_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--frr_exporter--log_level"></a>`log_level`

Data type: `String`

Log level for the exporter

Default value: `'info'`

##### <a name="-prometheus--frr_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--frr_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--frr_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--frr_exporter--advertised_prefixes"></a>`advertised_prefixes`

Data type: `Boolean`

Enable BGP advertised prefixes collection

Default value: `false`

##### <a name="-prometheus--frr_exporter--bgp6"></a>`bgp6`

Data type: `Boolean`

Enable the bgp6 collector

Default value: `false`

##### <a name="-prometheus--frr_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--frr_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--frr_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'frr_exporter'`

##### <a name="-prometheus--frr_exporter--peer_descriptions"></a>`peer_descriptions`

Data type: `Boolean`

Enable BGP peer descriptions collection

Default value: `true`

##### <a name="-prometheus--frr_exporter--peer_types"></a>`peer_types`

Data type: `Boolean`

Enable BGP peer types collection

Default value: `true`

##### <a name="-prometheus--frr_exporter--telemetry_path"></a>`telemetry_path`

Data type: `String`

Path to expose metrics

Default value: `'/metrics'`

##### <a name="-prometheus--frr_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--frr_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--frr_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--frr_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--frr_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the FRR exporter service

Default value: `'frr_exporter'`

##### <a name="-prometheus--frr_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'frr-exporter'`

##### <a name="-prometheus--frr_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.10.0'`

##### <a name="-prometheus--frr_exporter--web_listen_address"></a>`web_listen_address`

Data type: `String`

Address to listen on for web interface and telemetry

Default value: `':9342'`

##### <a name="-prometheus--frr_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`

hash with custom environment variables thats passed to the exporter via init script / unit file

Default value: `{}`

##### <a name="-prometheus--frr_exporter--ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Whether to install or remove the FRR exporter (default 'present')

Default value: `'present'`

### <a name="prometheus--graphite_exporter"></a>`prometheus::graphite_exporter`

This module manages prometheus node graphite_exporter

#### Parameters

The following parameters are available in the `prometheus::graphite_exporter` class:

* [`arch`](#-prometheus--graphite_exporter--arch)
* [`bin_dir`](#-prometheus--graphite_exporter--bin_dir)
* [`download_extension`](#-prometheus--graphite_exporter--download_extension)
* [`download_url`](#-prometheus--graphite_exporter--download_url)
* [`download_url_base`](#-prometheus--graphite_exporter--download_url_base)
* [`options`](#-prometheus--graphite_exporter--options)
* [`group`](#-prometheus--graphite_exporter--group)
* [`init_style`](#-prometheus--graphite_exporter--init_style)
* [`install_method`](#-prometheus--graphite_exporter--install_method)
* [`manage_group`](#-prometheus--graphite_exporter--manage_group)
* [`manage_service`](#-prometheus--graphite_exporter--manage_service)
* [`manage_user`](#-prometheus--graphite_exporter--manage_user)
* [`os`](#-prometheus--graphite_exporter--os)
* [`package_ensure`](#-prometheus--graphite_exporter--package_ensure)
* [`package_name`](#-prometheus--graphite_exporter--package_name)
* [`purge_config_dir`](#-prometheus--graphite_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--graphite_exporter--restart_on_change)
* [`service_enable`](#-prometheus--graphite_exporter--service_enable)
* [`service_ensure`](#-prometheus--graphite_exporter--service_ensure)
* [`service_name`](#-prometheus--graphite_exporter--service_name)
* [`user`](#-prometheus--graphite_exporter--user)
* [`version`](#-prometheus--graphite_exporter--version)
* [`proxy_server`](#-prometheus--graphite_exporter--proxy_server)
* [`proxy_type`](#-prometheus--graphite_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--graphite_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--graphite_exporter--scrape_host)
* [`scrape_port`](#-prometheus--graphite_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--graphite_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--graphite_exporter--scrape_job_labels)

##### <a name="-prometheus--graphite_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--graphite_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--graphite_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--graphite_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--graphite_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/graphite_exporter/releases'`

##### <a name="-prometheus--graphite_exporter--options"></a>`options`

Data type: `String`

Options added to the startup command

Default value: `''`

##### <a name="-prometheus--graphite_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'graphite-exporter'`

##### <a name="-prometheus--graphite_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--graphite_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--graphite_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--graphite_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--graphite_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--graphite_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--graphite_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--graphite_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'graphite_exporter'`

##### <a name="-prometheus--graphite_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--graphite_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--graphite_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--graphite_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--graphite_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the graphite exporter service (default 'graphite_exporter')

Default value: `'graphite_exporter'`

##### <a name="-prometheus--graphite_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'graphite-exporter'`

##### <a name="-prometheus--graphite_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.16.0'`

##### <a name="-prometheus--graphite_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--graphite_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--graphite_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--graphite_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--graphite_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9108`

##### <a name="-prometheus--graphite_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'graphite'`

##### <a name="-prometheus--graphite_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--grok_exporter"></a>`prometheus::grok_exporter`

This module manages prometheus grok_exporter

#### Parameters

The following parameters are available in the `prometheus::grok_exporter` class:

* [`arch`](#-prometheus--grok_exporter--arch)
* [`bin_dir`](#-prometheus--grok_exporter--bin_dir)
* [`config`](#-prometheus--grok_exporter--config)
* [`config_file`](#-prometheus--grok_exporter--config_file)
* [`config_mode`](#-prometheus--grok_exporter--config_mode)
* [`download_extension`](#-prometheus--grok_exporter--download_extension)
* [`download_url`](#-prometheus--grok_exporter--download_url)
* [`download_url_base`](#-prometheus--grok_exporter--download_url_base)
* [`extra_groups`](#-prometheus--grok_exporter--extra_groups)
* [`extra_options`](#-prometheus--grok_exporter--extra_options)
* [`group`](#-prometheus--grok_exporter--group)
* [`init_style`](#-prometheus--grok_exporter--init_style)
* [`install_method`](#-prometheus--grok_exporter--install_method)
* [`manage_group`](#-prometheus--grok_exporter--manage_group)
* [`manage_service`](#-prometheus--grok_exporter--manage_service)
* [`manage_user`](#-prometheus--grok_exporter--manage_user)
* [`os`](#-prometheus--grok_exporter--os)
* [`package_ensure`](#-prometheus--grok_exporter--package_ensure)
* [`package_name`](#-prometheus--grok_exporter--package_name)
* [`purge_config_dir`](#-prometheus--grok_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--grok_exporter--restart_on_change)
* [`service_enable`](#-prometheus--grok_exporter--service_enable)
* [`service_ensure`](#-prometheus--grok_exporter--service_ensure)
* [`service_name`](#-prometheus--grok_exporter--service_name)
* [`user`](#-prometheus--grok_exporter--user)
* [`version`](#-prometheus--grok_exporter--version)
* [`proxy_server`](#-prometheus--grok_exporter--proxy_server)
* [`proxy_type`](#-prometheus--grok_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--grok_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--grok_exporter--scrape_host)
* [`scrape_port`](#-prometheus--grok_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--grok_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--grok_exporter--scrape_job_labels)

##### <a name="-prometheus--grok_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--grok_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--grok_exporter--config"></a>`config`

Data type: `Hash`

Hash of configuration, see https://github.com/fstab/grok_exporter/blob/master/CONFIG.md
for available options

##### <a name="-prometheus--grok_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Path to config file, it will be generated from config param

Default value: `'/etc/grok-exporter.yaml'`

##### <a name="-prometheus--grok_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--grok_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'zip'`

##### <a name="-prometheus--grok_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--grok_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/fstab/grok_exporter/releases'`

##### <a name="-prometheus--grok_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--grok_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--grok_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'grok-exporter'`

##### <a name="-prometheus--grok_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--grok_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--grok_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--grok_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--grok_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--grok_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--grok_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--grok_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'grok_exporter'`

##### <a name="-prometheus--grok_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--grok_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--grok_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--grok_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--grok_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'grok_exporter')

Default value: `'grok_exporter'`

##### <a name="-prometheus--grok_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'grok-exporter'`

##### <a name="-prometheus--grok_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.0.0.RC4'`

##### <a name="-prometheus--grok_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--grok_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--grok_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--grok_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--grok_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9144`

##### <a name="-prometheus--grok_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'grok'`

##### <a name="-prometheus--grok_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--install"></a>`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

### <a name="prometheus--iperf3_exporter"></a>`prometheus::iperf3_exporter`

This module manages prometheus node iperf3_exporter

#### Parameters

The following parameters are available in the `prometheus::iperf3_exporter` class:

* [`arch`](#-prometheus--iperf3_exporter--arch)
* [`bin_dir`](#-prometheus--iperf3_exporter--bin_dir)
* [`download_extension`](#-prometheus--iperf3_exporter--download_extension)
* [`download_url`](#-prometheus--iperf3_exporter--download_url)
* [`download_url_base`](#-prometheus--iperf3_exporter--download_url_base)
* [`options`](#-prometheus--iperf3_exporter--options)
* [`extra_groups`](#-prometheus--iperf3_exporter--extra_groups)
* [`group`](#-prometheus--iperf3_exporter--group)
* [`init_style`](#-prometheus--iperf3_exporter--init_style)
* [`install_method`](#-prometheus--iperf3_exporter--install_method)
* [`manage_group`](#-prometheus--iperf3_exporter--manage_group)
* [`manage_service`](#-prometheus--iperf3_exporter--manage_service)
* [`manage_user`](#-prometheus--iperf3_exporter--manage_user)
* [`os`](#-prometheus--iperf3_exporter--os)
* [`package_ensure`](#-prometheus--iperf3_exporter--package_ensure)
* [`package_name`](#-prometheus--iperf3_exporter--package_name)
* [`purge_config_dir`](#-prometheus--iperf3_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--iperf3_exporter--restart_on_change)
* [`service_enable`](#-prometheus--iperf3_exporter--service_enable)
* [`service_ensure`](#-prometheus--iperf3_exporter--service_ensure)
* [`service_name`](#-prometheus--iperf3_exporter--service_name)
* [`user`](#-prometheus--iperf3_exporter--user)
* [`version`](#-prometheus--iperf3_exporter--version)
* [`export_scrape_job`](#-prometheus--iperf3_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--iperf3_exporter--scrape_host)
* [`scrape_port`](#-prometheus--iperf3_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--iperf3_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--iperf3_exporter--scrape_job_labels)

##### <a name="-prometheus--iperf3_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--iperf3_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::AbsolutePath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--iperf3_exporter--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--iperf3_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--iperf3_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/edgard/iperf3_exporter/releases'`

##### <a name="-prometheus--iperf3_exporter--options"></a>`options`

Data type: `Optional[String[1]]`

Options added to the startup command

Default value: `undef`

##### <a name="-prometheus--iperf3_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--iperf3_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'iperf3-exporter'`

##### <a name="-prometheus--iperf3_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$facts['service_provider']`

##### <a name="-prometheus--iperf3_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--iperf3_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--iperf3_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--iperf3_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'iperf3_exporter'`

##### <a name="-prometheus--iperf3_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--iperf3_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--iperf3_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the iperf3 exporter service (default 'iperf3_exporter')

Default value: `'iperf3_exporter'`

##### <a name="-prometheus--iperf3_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'iperf3-exporter'`

##### <a name="-prometheus--iperf3_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.1.3'`

##### <a name="-prometheus--iperf3_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--iperf3_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--iperf3_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9579`

##### <a name="-prometheus--iperf3_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'iperf3'`

##### <a name="-prometheus--iperf3_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--ipmi_exporter"></a>`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`](#-prometheus--ipmi_exporter--arch)
* [`bin_dir`](#-prometheus--ipmi_exporter--bin_dir)
* [`config_file`](#-prometheus--ipmi_exporter--config_file)
* [`config_mode`](#-prometheus--ipmi_exporter--config_mode)
* [`download_extension`](#-prometheus--ipmi_exporter--download_extension)
* [`download_url`](#-prometheus--ipmi_exporter--download_url)
* [`download_url_base`](#-prometheus--ipmi_exporter--download_url_base)
* [`extra_groups`](#-prometheus--ipmi_exporter--extra_groups)
* [`extra_options`](#-prometheus--ipmi_exporter--extra_options)
* [`group`](#-prometheus--ipmi_exporter--group)
* [`init_style`](#-prometheus--ipmi_exporter--init_style)
* [`install_method`](#-prometheus--ipmi_exporter--install_method)
* [`manage_group`](#-prometheus--ipmi_exporter--manage_group)
* [`manage_service`](#-prometheus--ipmi_exporter--manage_service)
* [`manage_user`](#-prometheus--ipmi_exporter--manage_user)
* [`modules`](#-prometheus--ipmi_exporter--modules)
* [`os`](#-prometheus--ipmi_exporter--os)
* [`package_ensure`](#-prometheus--ipmi_exporter--package_ensure)
* [`package_name`](#-prometheus--ipmi_exporter--package_name)
* [`purge_config_dir`](#-prometheus--ipmi_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--ipmi_exporter--restart_on_change)
* [`service_enable`](#-prometheus--ipmi_exporter--service_enable)
* [`service_ensure`](#-prometheus--ipmi_exporter--service_ensure)
* [`service_name`](#-prometheus--ipmi_exporter--service_name)
* [`user`](#-prometheus--ipmi_exporter--user)
* [`version`](#-prometheus--ipmi_exporter--version)
* [`proxy_server`](#-prometheus--ipmi_exporter--proxy_server)
* [`proxy_type`](#-prometheus--ipmi_exporter--proxy_type)
* [`unprivileged`](#-prometheus--ipmi_exporter--unprivileged)
* [`scrape_host`](#-prometheus--ipmi_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--ipmi_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--ipmi_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--ipmi_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--ipmi_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--ipmi_exporter--bin_name)
* [`script_dir`](#-prometheus--ipmi_exporter--script_dir)

##### <a name="-prometheus--ipmi_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--ipmi_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--ipmi_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Path to IPMI exporter configuration file

Default value: `'/etc/ipmi_exporter.yaml'`

##### <a name="-prometheus--ipmi_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--ipmi_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--ipmi_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/ipmi_exporter/releases'`

##### <a name="-prometheus--ipmi_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--ipmi_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'ipmi-exporter'`

##### <a name="-prometheus--ipmi_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--ipmi_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--ipmi_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--modules"></a>`modules`

Data type: `Hash`

Hash of IPMI exporter modules

Default value: `{}`

##### <a name="-prometheus--ipmi_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--ipmi_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--ipmi_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'ipmi_exporter'`

##### <a name="-prometheus--ipmi_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--ipmi_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'ipmi_exporter')

Default value: `'ipmi_exporter'`

##### <a name="-prometheus--ipmi_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'ipmi-exporter'`

##### <a name="-prometheus--ipmi_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.10.1'`

##### <a name="-prometheus--ipmi_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--unprivileged"></a>`unprivileged`

Data type: `Boolean`

If true, run the exporter as an unprivileged user and add sudoers entries

Default value: `true`

##### <a name="-prometheus--ipmi_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--ipmi_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9290`

##### <a name="-prometheus--ipmi_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'ipmi'`

##### <a name="-prometheus--ipmi_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

##### <a name="-prometheus--ipmi_exporter--script_dir"></a>`script_dir`

Data type: `Stdlib::Absolutepath`



Default value: `'/usr/local/bin'`

### <a name="prometheus--ipsec_exporter"></a>`prometheus::ipsec_exporter`

This module manages prometheus node ipsec_exporter

#### Parameters

The following parameters are available in the `prometheus::ipsec_exporter` class:

* [`arch`](#-prometheus--ipsec_exporter--arch)
* [`bin_dir`](#-prometheus--ipsec_exporter--bin_dir)
* [`download_extension`](#-prometheus--ipsec_exporter--download_extension)
* [`download_url`](#-prometheus--ipsec_exporter--download_url)
* [`download_url_base`](#-prometheus--ipsec_exporter--download_url_base)
* [`options`](#-prometheus--ipsec_exporter--options)
* [`extra_groups`](#-prometheus--ipsec_exporter--extra_groups)
* [`group`](#-prometheus--ipsec_exporter--group)
* [`init_style`](#-prometheus--ipsec_exporter--init_style)
* [`install_method`](#-prometheus--ipsec_exporter--install_method)
* [`manage_group`](#-prometheus--ipsec_exporter--manage_group)
* [`manage_service`](#-prometheus--ipsec_exporter--manage_service)
* [`manage_user`](#-prometheus--ipsec_exporter--manage_user)
* [`os`](#-prometheus--ipsec_exporter--os)
* [`package_ensure`](#-prometheus--ipsec_exporter--package_ensure)
* [`package_name`](#-prometheus--ipsec_exporter--package_name)
* [`purge_config_dir`](#-prometheus--ipsec_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--ipsec_exporter--restart_on_change)
* [`service_enable`](#-prometheus--ipsec_exporter--service_enable)
* [`service_ensure`](#-prometheus--ipsec_exporter--service_ensure)
* [`service_name`](#-prometheus--ipsec_exporter--service_name)
* [`user`](#-prometheus--ipsec_exporter--user)
* [`version`](#-prometheus--ipsec_exporter--version)
* [`proxy_server`](#-prometheus--ipsec_exporter--proxy_server)
* [`proxy_type`](#-prometheus--ipsec_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--ipsec_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--ipsec_exporter--scrape_host)
* [`scrape_port`](#-prometheus--ipsec_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--ipsec_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--ipsec_exporter--scrape_job_labels)

##### <a name="-prometheus--ipsec_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--ipsec_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::AbsolutePath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--ipsec_exporter--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--ipsec_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--ipsec_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/dennisstritzke/ipsec_exporter/releases'`

##### <a name="-prometheus--ipsec_exporter--options"></a>`options`

Data type: `String`

Options added to the startup command

Default value: `''`

##### <a name="-prometheus--ipsec_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--ipsec_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'ipsec-exporter'`

##### <a name="-prometheus--ipsec_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--ipsec_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--ipsec_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--ipsec_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--ipsec_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'ipsec_exporter'`

##### <a name="-prometheus--ipsec_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--ipsec_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--ipsec_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the ipsec exporter service (default 'ipsec_exporter')

Default value: `'ipsec_exporter'`

##### <a name="-prometheus--ipsec_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'ipsec-exporter'`

##### <a name="-prometheus--ipsec_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.4.0'`

##### <a name="-prometheus--ipsec_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--ipsec_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--ipsec_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--ipsec_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--ipsec_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9536`

##### <a name="-prometheus--ipsec_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'ipsec'`

##### <a name="-prometheus--ipsec_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--jmx_exporter"></a>`prometheus::jmx_exporter`

Installs and configures the Prometheus JMX exporter

* **See also**
  * https://github.com/prometheus/jmx_exporter

#### Parameters

The following parameters are available in the `prometheus::jmx_exporter` class:

* [`version`](#-prometheus--jmx_exporter--version)
* [`config_file_location`](#-prometheus--jmx_exporter--config_file_location)
* [`service_name`](#-prometheus--jmx_exporter--service_name)
* [`user`](#-prometheus--jmx_exporter--user)
* [`group`](#-prometheus--jmx_exporter--group)
* [`extra_groups`](#-prometheus--jmx_exporter--extra_groups)
* [`java_bin_path`](#-prometheus--jmx_exporter--java_bin_path)
* [`configuration`](#-prometheus--jmx_exporter--configuration)
* [`deployment`](#-prometheus--jmx_exporter--deployment)
* [`os`](#-prometheus--jmx_exporter--os)
* [`arch`](#-prometheus--jmx_exporter--arch)
* [`bin_dir`](#-prometheus--jmx_exporter--bin_dir)
* [`config_mode`](#-prometheus--jmx_exporter--config_mode)
* [`restart_on_change`](#-prometheus--jmx_exporter--restart_on_change)
* [`manage_user`](#-prometheus--jmx_exporter--manage_user)
* [`manage_group`](#-prometheus--jmx_exporter--manage_group)
* [`manage_service`](#-prometheus--jmx_exporter--manage_service)
* [`port`](#-prometheus--jmx_exporter--port)
* [`download_url`](#-prometheus--jmx_exporter--download_url)
* [`proxy_server`](#-prometheus--jmx_exporter--proxy_server)
* [`proxy_type`](#-prometheus--jmx_exporter--proxy_type)
* [`java_options`](#-prometheus--jmx_exporter--java_options)
* [`install_method`](#-prometheus--jmx_exporter--install_method)

##### <a name="-prometheus--jmx_exporter--version"></a>`version`

Data type: `String[1]`

Version of JMX exporter to download

##### <a name="-prometheus--jmx_exporter--config_file_location"></a>`config_file_location`

Data type: `Stdlib::Absolutepath`

Location where the jmx-exporter configuration should be placed

Default value: `'/etc/jmx-exporter.yaml'`

##### <a name="-prometheus--jmx_exporter--service_name"></a>`service_name`

Data type: `String[1]`

System service name for jmx exporter httpserver deployment

Default value: `'jmx_exporter'`

##### <a name="-prometheus--jmx_exporter--user"></a>`user`

Data type: `String[1]`

Service user for httpserver deployment

Default value: `'jmx_exporter'`

##### <a name="-prometheus--jmx_exporter--group"></a>`group`

Data type: `String[1]`

Service group for httpserver deployment

Default value: `'jmx-exporter'`

##### <a name="-prometheus--jmx_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Additional groups for httpserver deployment service user

Default value: `[]`

##### <a name="-prometheus--jmx_exporter--java_bin_path"></a>`java_bin_path`

Data type: `Stdlib::Absolutepath`

Path to JAVA (required for httpserver deployment)

Default value: `'/usr/bin/java'`

##### <a name="-prometheus--jmx_exporter--configuration"></a>`configuration`

Data type: `Hash`

jmx-exporter configuration (see website for details)

Default value: `{}`

##### <a name="-prometheus--jmx_exporter--deployment"></a>`deployment`

Data type: `Enum['javaagent', 'httpserver']`

Way of deploying jmx-exporter. Defaults to standalone httpserver deployment. If set to javaagent, requires
additional configuration on the target jmx service

Default value: `'httpserver'`

##### <a name="-prometheus--jmx_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--jmx_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--jmx_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--jmx_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

File mode for jmx exporter configuration file

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--jmx_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Restart jmx exporter service when the configuration file was updated

Default value: `true`

##### <a name="-prometheus--jmx_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Manage service user

Default value: `true`

##### <a name="-prometheus--jmx_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Manage service group

Default value: `true`

##### <a name="-prometheus--jmx_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Manage service

Default value: `true`

##### <a name="-prometheus--jmx_exporter--port"></a>`port`

Data type: `Optional[Stdlib::Port::Unprivileged]`

Port that the JMX exporter should listen on (required for httpserver deployment)

Default value: `undef`

##### <a name="-prometheus--jmx_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Download URL for JMX exporter

Default value: `undef`

##### <a name="-prometheus--jmx_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--jmx_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--jmx_exporter--java_options"></a>`java_options`

Data type: `Optional[String]`

Optional options for the JVM of the standalone jmx exporter

Default value: `undef`

##### <a name="-prometheus--jmx_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`



Default value: `$prometheus::install_method`

### <a name="prometheus--memcached_exporter"></a>`prometheus::memcached_exporter`

This module manages prometheus node memcached_exporter

#### Parameters

The following parameters are available in the `prometheus::memcached_exporter` class:

* [`arch`](#-prometheus--memcached_exporter--arch)
* [`bin_dir`](#-prometheus--memcached_exporter--bin_dir)
* [`download_extension`](#-prometheus--memcached_exporter--download_extension)
* [`download_url`](#-prometheus--memcached_exporter--download_url)
* [`download_url_base`](#-prometheus--memcached_exporter--download_url_base)
* [`extra_groups`](#-prometheus--memcached_exporter--extra_groups)
* [`extra_options`](#-prometheus--memcached_exporter--extra_options)
* [`group`](#-prometheus--memcached_exporter--group)
* [`init_style`](#-prometheus--memcached_exporter--init_style)
* [`install_method`](#-prometheus--memcached_exporter--install_method)
* [`manage_group`](#-prometheus--memcached_exporter--manage_group)
* [`manage_service`](#-prometheus--memcached_exporter--manage_service)
* [`manage_user`](#-prometheus--memcached_exporter--manage_user)
* [`os`](#-prometheus--memcached_exporter--os)
* [`package_ensure`](#-prometheus--memcached_exporter--package_ensure)
* [`package_name`](#-prometheus--memcached_exporter--package_name)
* [`purge_config_dir`](#-prometheus--memcached_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--memcached_exporter--restart_on_change)
* [`service_enable`](#-prometheus--memcached_exporter--service_enable)
* [`service_ensure`](#-prometheus--memcached_exporter--service_ensure)
* [`service_name`](#-prometheus--memcached_exporter--service_name)
* [`user`](#-prometheus--memcached_exporter--user)
* [`version`](#-prometheus--memcached_exporter--version)
* [`proxy_server`](#-prometheus--memcached_exporter--proxy_server)
* [`proxy_type`](#-prometheus--memcached_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--memcached_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--memcached_exporter--scrape_host)
* [`scrape_port`](#-prometheus--memcached_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--memcached_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--memcached_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--memcached_exporter--bin_name)

##### <a name="-prometheus--memcached_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--memcached_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--memcached_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--memcached_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--memcached_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/memcached_exporter/releases'`

##### <a name="-prometheus--memcached_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--memcached_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--memcached_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'memcached-exporter'`

##### <a name="-prometheus--memcached_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--memcached_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--memcached_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--memcached_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--memcached_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--memcached_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--memcached_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'present'`

##### <a name="-prometheus--memcached_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'memcached_exporter'`

##### <a name="-prometheus--memcached_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--memcached_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--memcached_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--memcached_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--memcached_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the memcached exporter service (default 'memcached_exporter')

Default value: `'memcached_exporter'`

##### <a name="-prometheus--memcached_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'memcached-exporter'`

##### <a name="-prometheus--memcached_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.15.5'`

##### <a name="-prometheus--memcached_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--memcached_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--memcached_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--memcached_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--memcached_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9150`

##### <a name="-prometheus--memcached_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'memcached'`

##### <a name="-prometheus--memcached_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--memcached_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--mesos_exporter"></a>`prometheus::mesos_exporter`

This module manages prometheus mesos_exporter

#### Parameters

The following parameters are available in the `prometheus::mesos_exporter` class:

* [`arch`](#-prometheus--mesos_exporter--arch)
* [`bin_dir`](#-prometheus--mesos_exporter--bin_dir)
* [`server_type`](#-prometheus--mesos_exporter--server_type)
* [`cnf_scrape_uri`](#-prometheus--mesos_exporter--cnf_scrape_uri)
* [`download_extension`](#-prometheus--mesos_exporter--download_extension)
* [`download_url`](#-prometheus--mesos_exporter--download_url)
* [`download_url_base`](#-prometheus--mesos_exporter--download_url_base)
* [`extra_groups`](#-prometheus--mesos_exporter--extra_groups)
* [`extra_options`](#-prometheus--mesos_exporter--extra_options)
* [`group`](#-prometheus--mesos_exporter--group)
* [`init_style`](#-prometheus--mesos_exporter--init_style)
* [`install_method`](#-prometheus--mesos_exporter--install_method)
* [`manage_group`](#-prometheus--mesos_exporter--manage_group)
* [`manage_service`](#-prometheus--mesos_exporter--manage_service)
* [`manage_user`](#-prometheus--mesos_exporter--manage_user)
* [`os`](#-prometheus--mesos_exporter--os)
* [`package_ensure`](#-prometheus--mesos_exporter--package_ensure)
* [`package_name`](#-prometheus--mesos_exporter--package_name)
* [`purge_config_dir`](#-prometheus--mesos_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--mesos_exporter--restart_on_change)
* [`service_enable`](#-prometheus--mesos_exporter--service_enable)
* [`service_ensure`](#-prometheus--mesos_exporter--service_ensure)
* [`service_name`](#-prometheus--mesos_exporter--service_name)
* [`user`](#-prometheus--mesos_exporter--user)
* [`version`](#-prometheus--mesos_exporter--version)
* [`proxy_server`](#-prometheus--mesos_exporter--proxy_server)
* [`proxy_type`](#-prometheus--mesos_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--mesos_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--mesos_exporter--scrape_host)
* [`scrape_port`](#-prometheus--mesos_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--mesos_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--mesos_exporter--scrape_job_labels)

##### <a name="-prometheus--mesos_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--mesos_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--mesos_exporter--server_type"></a>`server_type`

Data type: `String[1]`

Specify target type master or slave

Default value: `'master'`

##### <a name="-prometheus--mesos_exporter--cnf_scrape_uri"></a>`cnf_scrape_uri`

Data type: `String[1]`

The URI to obtain mesos stats from

Default value: `'http://localhost:5050'`

##### <a name="-prometheus--mesos_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--mesos_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--mesos_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/mesosphere/mesos_exporter/releases'`

##### <a name="-prometheus--mesos_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--mesos_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--mesos_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'mesos-exporter'`

##### <a name="-prometheus--mesos_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--mesos_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--mesos_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mesos_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--mesos_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mesos_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--mesos_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--mesos_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'mesos_exporter'`

##### <a name="-prometheus--mesos_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--mesos_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--mesos_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--mesos_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--mesos_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the mesos exporter service (default 'mesos_exporter')

Default value: `'mesos_exporter'`

##### <a name="-prometheus--mesos_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'mesos-exporter'`

##### <a name="-prometheus--mesos_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.1.2'`

##### <a name="-prometheus--mesos_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--mesos_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--mesos_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--mesos_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--mesos_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9105`

##### <a name="-prometheus--mesos_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'mesos'`

##### <a name="-prometheus--mesos_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--mongodb_exporter"></a>`prometheus::mongodb_exporter`

This module manages prometheus mongodb_exporter

#### Parameters

The following parameters are available in the `prometheus::mongodb_exporter` class:

* [`arch`](#-prometheus--mongodb_exporter--arch)
* [`bin_dir`](#-prometheus--mongodb_exporter--bin_dir)
* [`bin_name`](#-prometheus--mongodb_exporter--bin_name)
* [`cnf_uri`](#-prometheus--mongodb_exporter--cnf_uri)
* [`download_extension`](#-prometheus--mongodb_exporter--download_extension)
* [`download_url`](#-prometheus--mongodb_exporter--download_url)
* [`download_url_base`](#-prometheus--mongodb_exporter--download_url_base)
* [`extra_groups`](#-prometheus--mongodb_exporter--extra_groups)
* [`extra_options`](#-prometheus--mongodb_exporter--extra_options)
* [`group`](#-prometheus--mongodb_exporter--group)
* [`init_style`](#-prometheus--mongodb_exporter--init_style)
* [`install_method`](#-prometheus--mongodb_exporter--install_method)
* [`manage_group`](#-prometheus--mongodb_exporter--manage_group)
* [`manage_service`](#-prometheus--mongodb_exporter--manage_service)
* [`manage_user`](#-prometheus--mongodb_exporter--manage_user)
* [`os`](#-prometheus--mongodb_exporter--os)
* [`package_ensure`](#-prometheus--mongodb_exporter--package_ensure)
* [`package_name`](#-prometheus--mongodb_exporter--package_name)
* [`purge_config_dir`](#-prometheus--mongodb_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--mongodb_exporter--restart_on_change)
* [`service_enable`](#-prometheus--mongodb_exporter--service_enable)
* [`service_ensure`](#-prometheus--mongodb_exporter--service_ensure)
* [`service_name`](#-prometheus--mongodb_exporter--service_name)
* [`user`](#-prometheus--mongodb_exporter--user)
* [`version`](#-prometheus--mongodb_exporter--version)
* [`use_kingpin`](#-prometheus--mongodb_exporter--use_kingpin)
* [`proxy_server`](#-prometheus--mongodb_exporter--proxy_server)
* [`proxy_type`](#-prometheus--mongodb_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--mongodb_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--mongodb_exporter--scrape_host)
* [`scrape_port`](#-prometheus--mongodb_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--mongodb_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--mongodb_exporter--scrape_job_labels)

##### <a name="-prometheus--mongodb_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--mongodb_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--mongodb_exporter--bin_name"></a>`bin_name`

Data type: `String[1]`

The name of the binary to execute

Default value: `'mongodb_exporter'`

##### <a name="-prometheus--mongodb_exporter--cnf_uri"></a>`cnf_uri`

Data type: `String[1]`

The URI to obtain MongoDB stats from

Default value: `'mongodb://localhost:27017'`

##### <a name="-prometheus--mongodb_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--mongodb_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--mongodb_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/percona/mongodb_exporter/releases'`

##### <a name="-prometheus--mongodb_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--mongodb_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--mongodb_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'mongodb-exporter'`

##### <a name="-prometheus--mongodb_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--mongodb_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--mongodb_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--mongodb_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--mongodb_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'mongodb_exporter'`

##### <a name="-prometheus--mongodb_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--mongodb_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the mongodb exporter service (default 'mongodb_exporter')

Default value: `'mongodb_exporter'`

##### <a name="-prometheus--mongodb_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'mongodb-exporter'`

##### <a name="-prometheus--mongodb_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.48.0'`

##### <a name="-prometheus--mongodb_exporter--use_kingpin"></a>`use_kingpin`

Data type: `Boolean`

Since version 0.7.0, the mongodb exporter uses kingpin, thus
this param to define how we call the mongodb.uri in the $options
https://github.com/percona/mongodb_exporter/blob/v0.7.0/CHANGELOG.md

Default value: `true`

##### <a name="-prometheus--mongodb_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--mongodb_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--mongodb_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--mongodb_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--mongodb_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9216`

##### <a name="-prometheus--mongodb_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'mongodb'`

##### <a name="-prometheus--mongodb_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--mysqld_exporter"></a>`prometheus::mysqld_exporter`

manages prometheus mysqld_exporter

* **See also**
  * https://github.com/prometheus/mysqld_exporter

#### Parameters

The following parameters are available in the `prometheus::mysqld_exporter` class:

* [`cnf_config_path`](#-prometheus--mysqld_exporter--cnf_config_path)
* [`cnf_host`](#-prometheus--mysqld_exporter--cnf_host)
* [`cnf_password`](#-prometheus--mysqld_exporter--cnf_password)
* [`cnf_port`](#-prometheus--mysqld_exporter--cnf_port)
* [`cnf_socket`](#-prometheus--mysqld_exporter--cnf_socket)
* [`cnf_user`](#-prometheus--mysqld_exporter--cnf_user)
* [`arch`](#-prometheus--mysqld_exporter--arch)
* [`bin_dir`](#-prometheus--mysqld_exporter--bin_dir)
* [`config_mode`](#-prometheus--mysqld_exporter--config_mode)
* [`download_extension`](#-prometheus--mysqld_exporter--download_extension)
* [`download_url`](#-prometheus--mysqld_exporter--download_url)
* [`download_url_base`](#-prometheus--mysqld_exporter--download_url_base)
* [`extra_groups`](#-prometheus--mysqld_exporter--extra_groups)
* [`extra_options`](#-prometheus--mysqld_exporter--extra_options)
* [`group`](#-prometheus--mysqld_exporter--group)
* [`init_style`](#-prometheus--mysqld_exporter--init_style)
* [`install_method`](#-prometheus--mysqld_exporter--install_method)
* [`manage_group`](#-prometheus--mysqld_exporter--manage_group)
* [`manage_service`](#-prometheus--mysqld_exporter--manage_service)
* [`manage_user`](#-prometheus--mysqld_exporter--manage_user)
* [`os`](#-prometheus--mysqld_exporter--os)
* [`package_ensure`](#-prometheus--mysqld_exporter--package_ensure)
* [`package_name`](#-prometheus--mysqld_exporter--package_name)
* [`purge_config_dir`](#-prometheus--mysqld_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--mysqld_exporter--restart_on_change)
* [`service_enable`](#-prometheus--mysqld_exporter--service_enable)
* [`service_ensure`](#-prometheus--mysqld_exporter--service_ensure)
* [`service_name`](#-prometheus--mysqld_exporter--service_name)
* [`user`](#-prometheus--mysqld_exporter--user)
* [`version`](#-prometheus--mysqld_exporter--version)
* [`proxy_server`](#-prometheus--mysqld_exporter--proxy_server)
* [`proxy_type`](#-prometheus--mysqld_exporter--proxy_type)
* [`web_config_file`](#-prometheus--mysqld_exporter--web_config_file)
* [`web_config_content`](#-prometheus--mysqld_exporter--web_config_content)
* [`cnf_ssl_ca`](#-prometheus--mysqld_exporter--cnf_ssl_ca)
* [`cnf_ssl_cert`](#-prometheus--mysqld_exporter--cnf_ssl_cert)
* [`cnf_ssl_key`](#-prometheus--mysqld_exporter--cnf_ssl_key)
* [`export_scrape_job`](#-prometheus--mysqld_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--mysqld_exporter--scrape_host)
* [`scrape_port`](#-prometheus--mysqld_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--mysqld_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--mysqld_exporter--scrape_job_labels)

##### <a name="-prometheus--mysqld_exporter--cnf_config_path"></a>`cnf_config_path`

Data type: `Stdlib::Absolutepath`

The path to put the my.cnf file

Default value: `'/etc/mysqld_exporter-my.cnf'`

##### <a name="-prometheus--mysqld_exporter--cnf_host"></a>`cnf_host`

Data type: `Stdlib::Host`

The mysql host.

Default value: `localhost`

##### <a name="-prometheus--mysqld_exporter--cnf_password"></a>`cnf_password`

Data type: `Variant[Sensitive[String],String]`

The mysql user password.

Default value: `'password'`

##### <a name="-prometheus--mysqld_exporter--cnf_port"></a>`cnf_port`

Data type: `Stdlib::Port`

The port for which the mysql host is running.

Default value: `3306`

##### <a name="-prometheus--mysqld_exporter--cnf_socket"></a>`cnf_socket`

Data type: `Optional[Stdlib::Absolutepath]`

The socket which the mysql host is running. If defined, host and port are not used.

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--cnf_user"></a>`cnf_user`

Data type: `String[1]`

The mysql user to use when connecting.

Default value: `login`

##### <a name="-prometheus--mysqld_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--mysqld_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--mysqld_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--mysqld_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--mysqld_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/mysqld_exporter/releases'`

##### <a name="-prometheus--mysqld_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--mysqld_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'mysqld-exporter'`

##### <a name="-prometheus--mysqld_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--mysqld_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--mysqld_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service?

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--mysqld_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--mysqld_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'mysqld_exporter'`

##### <a name="-prometheus--mysqld_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change?

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet

Default value: `true`

##### <a name="-prometheus--mysqld_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service

Default value: `'running'`

##### <a name="-prometheus--mysqld_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the mysqld exporter service

Default value: `'mysqld_exporter'`

##### <a name="-prometheus--mysqld_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'mysqld-exporter'`

##### <a name="-prometheus--mysqld_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.18.0'`

##### <a name="-prometheus--mysqld_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

proxy server type

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/mysqld_exporter_web-config.yml'`

##### <a name="-prometheus--mysqld_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

##### <a name="-prometheus--mysqld_exporter--cnf_ssl_ca"></a>`cnf_ssl_ca`

Data type: `Optional[Stdlib::Absolutepath]`

The path name of the Certificate Authority (CA) certificate file in PEM format.

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--cnf_ssl_cert"></a>`cnf_ssl_cert`

Data type: `Optional[Stdlib::Absolutepath]`

The path name of the client SSL public key certificate file in PEM format.

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--cnf_ssl_key"></a>`cnf_ssl_key`

Data type: `Optional[Stdlib::Absolutepath]`

The path name of the client SSL private key file in PEM format.

Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--mysqld_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--mysqld_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9104`

##### <a name="-prometheus--mysqld_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'mysql'`

##### <a name="-prometheus--mysqld_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--nginx_prometheus_exporter"></a>`prometheus::nginx_prometheus_exporter`

This module manages prometheus nginx exporter

#### Parameters

The following parameters are available in the `prometheus::nginx_prometheus_exporter` class:

* [`arch`](#-prometheus--nginx_prometheus_exporter--arch)
* [`bin_dir`](#-prometheus--nginx_prometheus_exporter--bin_dir)
* [`config_mode`](#-prometheus--nginx_prometheus_exporter--config_mode)
* [`download_extension`](#-prometheus--nginx_prometheus_exporter--download_extension)
* [`download_url`](#-prometheus--nginx_prometheus_exporter--download_url)
* [`download_url_base`](#-prometheus--nginx_prometheus_exporter--download_url_base)
* [`extra_groups`](#-prometheus--nginx_prometheus_exporter--extra_groups)
* [`extra_options`](#-prometheus--nginx_prometheus_exporter--extra_options)
* [`group`](#-prometheus--nginx_prometheus_exporter--group)
* [`init_style`](#-prometheus--nginx_prometheus_exporter--init_style)
* [`install_method`](#-prometheus--nginx_prometheus_exporter--install_method)
* [`manage_group`](#-prometheus--nginx_prometheus_exporter--manage_group)
* [`manage_service`](#-prometheus--nginx_prometheus_exporter--manage_service)
* [`manage_user`](#-prometheus--nginx_prometheus_exporter--manage_user)
* [`os`](#-prometheus--nginx_prometheus_exporter--os)
* [`package_ensure`](#-prometheus--nginx_prometheus_exporter--package_ensure)
* [`package_name`](#-prometheus--nginx_prometheus_exporter--package_name)
* [`purge_config_dir`](#-prometheus--nginx_prometheus_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--nginx_prometheus_exporter--restart_on_change)
* [`scrape_uri`](#-prometheus--nginx_prometheus_exporter--scrape_uri)
* [`service_enable`](#-prometheus--nginx_prometheus_exporter--service_enable)
* [`service_ensure`](#-prometheus--nginx_prometheus_exporter--service_ensure)
* [`service_name`](#-prometheus--nginx_prometheus_exporter--service_name)
* [`user`](#-prometheus--nginx_prometheus_exporter--user)
* [`version`](#-prometheus--nginx_prometheus_exporter--version)
* [`proxy_server`](#-prometheus--nginx_prometheus_exporter--proxy_server)
* [`proxy_type`](#-prometheus--nginx_prometheus_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--nginx_prometheus_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--nginx_prometheus_exporter--scrape_host)
* [`scrape_port`](#-prometheus--nginx_prometheus_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--nginx_prometheus_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--nginx_prometheus_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--nginx_prometheus_exporter--bin_name)
* [`env_vars`](#-prometheus--nginx_prometheus_exporter--env_vars)
* [`env_file_path`](#-prometheus--nginx_prometheus_exporter--env_file_path)

##### <a name="-prometheus--nginx_prometheus_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--nginx_prometheus_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--nginx_prometheus_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--nginx_prometheus_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--nginx_prometheus_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/nginxinc/nginx-prometheus-exporter/releases'`

##### <a name="-prometheus--nginx_prometheus_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--nginx_prometheus_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'nginx-prometheus-exporter'`

##### <a name="-prometheus--nginx_prometheus_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--nginx_prometheus_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--nginx_prometheus_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--nginx_prometheus_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--nginx_prometheus_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'nginx-prometheus-exporter'`

##### <a name="-prometheus--nginx_prometheus_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--scrape_uri"></a>`scrape_uri`

Data type: `String[1]`

The URI for the nginx status or nginx plus api page

Default value: `'http://localhost:8080/stub_status'`

##### <a name="-prometheus--nginx_prometheus_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--nginx_prometheus_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--nginx_prometheus_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the nginx prometheus exporter service (default 'nginx_prometheus_exporter')

Default value: `'nginx_prometheus_exporter'`

##### <a name="-prometheus--nginx_prometheus_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'nginx-prometheus-exporter'`

##### <a name="-prometheus--nginx_prometheus_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.5.1'`

##### <a name="-prometheus--nginx_prometheus_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--nginx_prometheus_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9113`

##### <a name="-prometheus--nginx_prometheus_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'nginx'`

##### <a name="-prometheus--nginx_prometheus_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--nginx_prometheus_exporter--bin_name"></a>`bin_name`

Data type: `String[1]`



Default value: `'nginx-prometheus-exporter'`

##### <a name="-prometheus--nginx_prometheus_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`



Default value: `{}`

##### <a name="-prometheus--nginx_prometheus_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::env_file_path`

### <a name="prometheus--node_exporter"></a>`prometheus::node_exporter`

This module manages prometheus node node_exporter

#### Parameters

The following parameters are available in the `prometheus::node_exporter` class:

* [`arch`](#-prometheus--node_exporter--arch)
* [`bin_dir`](#-prometheus--node_exporter--bin_dir)
* [`collectors`](#-prometheus--node_exporter--collectors)
* [`collectors_enable`](#-prometheus--node_exporter--collectors_enable)
* [`collectors_disable`](#-prometheus--node_exporter--collectors_disable)
* [`download_extension`](#-prometheus--node_exporter--download_extension)
* [`download_url`](#-prometheus--node_exporter--download_url)
* [`download_url_base`](#-prometheus--node_exporter--download_url_base)
* [`extra_groups`](#-prometheus--node_exporter--extra_groups)
* [`extra_options`](#-prometheus--node_exporter--extra_options)
* [`group`](#-prometheus--node_exporter--group)
* [`init_style`](#-prometheus--node_exporter--init_style)
* [`install_method`](#-prometheus--node_exporter--install_method)
* [`manage_group`](#-prometheus--node_exporter--manage_group)
* [`manage_service`](#-prometheus--node_exporter--manage_service)
* [`manage_user`](#-prometheus--node_exporter--manage_user)
* [`os`](#-prometheus--node_exporter--os)
* [`package_ensure`](#-prometheus--node_exporter--package_ensure)
* [`package_name`](#-prometheus--node_exporter--package_name)
* [`purge_config_dir`](#-prometheus--node_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--node_exporter--restart_on_change)
* [`service_enable`](#-prometheus--node_exporter--service_enable)
* [`service_ensure`](#-prometheus--node_exporter--service_ensure)
* [`service_name`](#-prometheus--node_exporter--service_name)
* [`user`](#-prometheus--node_exporter--user)
* [`version`](#-prometheus--node_exporter--version)
* [`env_vars`](#-prometheus--node_exporter--env_vars)
* [`env_file_path`](#-prometheus--node_exporter--env_file_path)
* [`proxy_server`](#-prometheus--node_exporter--proxy_server)
* [`proxy_type`](#-prometheus--node_exporter--proxy_type)
* [`web_config_file`](#-prometheus--node_exporter--web_config_file)
* [`web_config_content`](#-prometheus--node_exporter--web_config_content)
* [`scrape_port`](#-prometheus--node_exporter--scrape_port)
* [`scrape_host`](#-prometheus--node_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--node_exporter--export_scrape_job)
* [`scrape_job_name`](#-prometheus--node_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--node_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--node_exporter--bin_name)

##### <a name="-prometheus--node_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--node_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--node_exporter--collectors"></a>`collectors`

Data type: `Optional[Array[String]]`

deprecated, unused kept for migration scenatrios
will be removed in next release

Default value: `undef`

##### <a name="-prometheus--node_exporter--collectors_enable"></a>`collectors_enable`

Data type: `Array[String]`

Collectors to enable, addtionally to the defaults
https://github.com/prometheus/node_exporter#enabled-by-default

Default value: `[]`

##### <a name="-prometheus--node_exporter--collectors_disable"></a>`collectors_disable`

Data type: `Array[String]`

disable collectors which are enabled by default
https://github.com/prometheus/node_exporter#enabled-by-default

Default value: `[]`

##### <a name="-prometheus--node_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--node_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--node_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/node_exporter/releases'`

##### <a name="-prometheus--node_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--node_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--node_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'node-exporter'`

##### <a name="-prometheus--node_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--node_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--node_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--node_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--node_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--node_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--node_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--node_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'node_exporter'`

##### <a name="-prometheus--node_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--node_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--node_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--node_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--node_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'node_exporter')

Default value: `'node_exporter'`

##### <a name="-prometheus--node_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'node-exporter'`

##### <a name="-prometheus--node_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.10.2'`

##### <a name="-prometheus--node_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`

hash with custom environment variables thats passed to the exporter via init script / unit file

Default value: `{}`

##### <a name="-prometheus--node_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`

The path to the file with the environmetn variable that is read from the init script/systemd unit

Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--node_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--node_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--node_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/node_exporter_web-config.yml'`

##### <a name="-prometheus--node_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

##### <a name="-prometheus--node_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

Scrape port for configuring scrape targets on the prometheus server via exported `prometheus::scrape_job` resources
If changed from default 9100 the option `--web.listen-address=':${scrape_port}'` will be added to the command line arguments

Default value: `9100`

##### <a name="-prometheus--node_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--node_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--node_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'node'`

##### <a name="-prometheus--node_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--node_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--openldap_exporter"></a>`prometheus::openldap_exporter`

This module manages prometheus openldap_exporter

#### Parameters

The following parameters are available in the `prometheus::openldap_exporter` class:

* [`bin_dir`](#-prometheus--openldap_exporter--bin_dir)
* [`download_extension`](#-prometheus--openldap_exporter--download_extension)
* [`download_url`](#-prometheus--openldap_exporter--download_url)
* [`download_url_base`](#-prometheus--openldap_exporter--download_url_base)
* [`extra_groups`](#-prometheus--openldap_exporter--extra_groups)
* [`options`](#-prometheus--openldap_exporter--options)
* [`group`](#-prometheus--openldap_exporter--group)
* [`init_style`](#-prometheus--openldap_exporter--init_style)
* [`install_method`](#-prometheus--openldap_exporter--install_method)
* [`manage_group`](#-prometheus--openldap_exporter--manage_group)
* [`manage_service`](#-prometheus--openldap_exporter--manage_service)
* [`manage_user`](#-prometheus--openldap_exporter--manage_user)
* [`os`](#-prometheus--openldap_exporter--os)
* [`package_ensure`](#-prometheus--openldap_exporter--package_ensure)
* [`package_name`](#-prometheus--openldap_exporter--package_name)
* [`restart_on_change`](#-prometheus--openldap_exporter--restart_on_change)
* [`service_enable`](#-prometheus--openldap_exporter--service_enable)
* [`service_ensure`](#-prometheus--openldap_exporter--service_ensure)
* [`service_name`](#-prometheus--openldap_exporter--service_name)
* [`user`](#-prometheus--openldap_exporter--user)
* [`version`](#-prometheus--openldap_exporter--version)
* [`ldap_binddn`](#-prometheus--openldap_exporter--ldap_binddn)
* [`ldap_password`](#-prometheus--openldap_exporter--ldap_password)
* [`proxy_server`](#-prometheus--openldap_exporter--proxy_server)
* [`proxy_type`](#-prometheus--openldap_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--openldap_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--openldap_exporter--scrape_host)
* [`scrape_port`](#-prometheus--openldap_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--openldap_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--openldap_exporter--scrape_job_labels)

##### <a name="-prometheus--openldap_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--openldap_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--openldap_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--openldap_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/hm-edu/openldap-exporter/releases'`

##### <a name="-prometheus--openldap_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--openldap_exporter--options"></a>`options`

Data type: `String`

Additionnal arguments to command line of openldap_exporter, use to specify the URL of the LDAP to scrap if not ldap://localhost:389
Do not use for user/password authentication

Default value: `''`

##### <a name="-prometheus--openldap_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'openldap-exporter'`

##### <a name="-prometheus--openldap_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--openldap_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--openldap_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--openldap_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--openldap_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--openldap_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--openldap_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--openldap_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - used to reference the name in the archive.

Default value: `'openldap-exporter'`

##### <a name="-prometheus--openldap_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--openldap_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--openldap_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--openldap_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'openldap_exporter')

Default value: `'openldap_exporter'`

##### <a name="-prometheus--openldap_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'openldap-exporter'`

##### <a name="-prometheus--openldap_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'v2.8.0'`

##### <a name="-prometheus--openldap_exporter--ldap_binddn"></a>`ldap_binddn`

Data type: `Optional[String[1]]`

DN (LDAP User) used to authenticate to openldap cn=monitor tree

Default value: `undef`

##### <a name="-prometheus--openldap_exporter--ldap_password"></a>`ldap_password`

Data type: `Optional[String[1]]`

Password used to authenticate to openldap cn=monitor tree

Default value: `undef`

##### <a name="-prometheus--openldap_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--openldap_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--openldap_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--openldap_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--openldap_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9330`

##### <a name="-prometheus--openldap_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'openldap'`

##### <a name="-prometheus--openldap_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--openvpn_exporter"></a>`prometheus::openvpn_exporter`

This module manages prometheus node openvpn_exporter

#### Parameters

The following parameters are available in the `prometheus::openvpn_exporter` class:

* [`arch`](#-prometheus--openvpn_exporter--arch)
* [`bin_dir`](#-prometheus--openvpn_exporter--bin_dir)
* [`status_paths`](#-prometheus--openvpn_exporter--status_paths)
* [`download_extension`](#-prometheus--openvpn_exporter--download_extension)
* [`download_url`](#-prometheus--openvpn_exporter--download_url)
* [`download_url_base`](#-prometheus--openvpn_exporter--download_url_base)
* [`extra_groups`](#-prometheus--openvpn_exporter--extra_groups)
* [`extra_options`](#-prometheus--openvpn_exporter--extra_options)
* [`group`](#-prometheus--openvpn_exporter--group)
* [`init_style`](#-prometheus--openvpn_exporter--init_style)
* [`install_method`](#-prometheus--openvpn_exporter--install_method)
* [`manage_group`](#-prometheus--openvpn_exporter--manage_group)
* [`manage_service`](#-prometheus--openvpn_exporter--manage_service)
* [`manage_user`](#-prometheus--openvpn_exporter--manage_user)
* [`os`](#-prometheus--openvpn_exporter--os)
* [`package_ensure`](#-prometheus--openvpn_exporter--package_ensure)
* [`package_name`](#-prometheus--openvpn_exporter--package_name)
* [`purge_config_dir`](#-prometheus--openvpn_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--openvpn_exporter--restart_on_change)
* [`service_enable`](#-prometheus--openvpn_exporter--service_enable)
* [`service_ensure`](#-prometheus--openvpn_exporter--service_ensure)
* [`service_name`](#-prometheus--openvpn_exporter--service_name)
* [`user`](#-prometheus--openvpn_exporter--user)
* [`version`](#-prometheus--openvpn_exporter--version)
* [`proxy_server`](#-prometheus--openvpn_exporter--proxy_server)
* [`proxy_type`](#-prometheus--openvpn_exporter--proxy_type)
* [`scrape_host`](#-prometheus--openvpn_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--openvpn_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--openvpn_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--openvpn_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--openvpn_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--openvpn_exporter--bin_name)

##### <a name="-prometheus--openvpn_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--openvpn_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--openvpn_exporter--status_paths"></a>`status_paths`

Data type: `Array[Stdlib::Absolutepath]`

The openvpn status files to monitor with this exporter

Default value: `[]`

##### <a name="-prometheus--openvpn_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `''`

##### <a name="-prometheus--openvpn_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/wandera/openvpn_exporter/releases'`

##### <a name="-prometheus--openvpn_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--openvpn_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'openvpn-exporter'`

##### <a name="-prometheus--openvpn_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--openvpn_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--openvpn_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--openvpn_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--openvpn_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'openvpn_exporter'`

##### <a name="-prometheus--openvpn_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--openvpn_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--openvpn_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the openvpn exporter service (default 'openvpn_exporter')

Default value: `'openvpn_exporter'`

##### <a name="-prometheus--openvpn_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'openvpn-exporter'`

##### <a name="-prometheus--openvpn_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'v0.3.0.3'`

##### <a name="-prometheus--openvpn_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--openvpn_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9176`

##### <a name="-prometheus--openvpn_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'openvpn'`

##### <a name="-prometheus--openvpn_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--openvpn_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--php_fpm_exporter"></a>`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`](#-prometheus--php_fpm_exporter--arch)
* [`bin_dir`](#-prometheus--php_fpm_exporter--bin_dir)
* [`config_mode`](#-prometheus--php_fpm_exporter--config_mode)
* [`download_extension`](#-prometheus--php_fpm_exporter--download_extension)
* [`download_url`](#-prometheus--php_fpm_exporter--download_url)
* [`download_url_base`](#-prometheus--php_fpm_exporter--download_url_base)
* [`extra_groups`](#-prometheus--php_fpm_exporter--extra_groups)
* [`extra_options`](#-prometheus--php_fpm_exporter--extra_options)
* [`group`](#-prometheus--php_fpm_exporter--group)
* [`init_style`](#-prometheus--php_fpm_exporter--init_style)
* [`install_method`](#-prometheus--php_fpm_exporter--install_method)
* [`manage_group`](#-prometheus--php_fpm_exporter--manage_group)
* [`manage_service`](#-prometheus--php_fpm_exporter--manage_service)
* [`manage_user`](#-prometheus--php_fpm_exporter--manage_user)
* [`os`](#-prometheus--php_fpm_exporter--os)
* [`package_ensure`](#-prometheus--php_fpm_exporter--package_ensure)
* [`package_name`](#-prometheus--php_fpm_exporter--package_name)
* [`purge_config_dir`](#-prometheus--php_fpm_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--php_fpm_exporter--restart_on_change)
* [`scrape_uri`](#-prometheus--php_fpm_exporter--scrape_uri)
* [`service_enable`](#-prometheus--php_fpm_exporter--service_enable)
* [`service_ensure`](#-prometheus--php_fpm_exporter--service_ensure)
* [`service_name`](#-prometheus--php_fpm_exporter--service_name)
* [`user`](#-prometheus--php_fpm_exporter--user)
* [`version`](#-prometheus--php_fpm_exporter--version)
* [`proxy_server`](#-prometheus--php_fpm_exporter--proxy_server)
* [`proxy_type`](#-prometheus--php_fpm_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--php_fpm_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--php_fpm_exporter--scrape_host)
* [`scrape_port`](#-prometheus--php_fpm_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--php_fpm_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--php_fpm_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--php_fpm_exporter--bin_name)
* [`env_vars`](#-prometheus--php_fpm_exporter--env_vars)
* [`env_file_path`](#-prometheus--php_fpm_exporter--env_file_path)

##### <a name="-prometheus--php_fpm_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--php_fpm_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--php_fpm_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--php_fpm_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--php_fpm_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/hipages/php-fpm_exporter/releases'`

##### <a name="-prometheus--php_fpm_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--php_fpm_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'php-fpm_exporter'`

##### <a name="-prometheus--php_fpm_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--php_fpm_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--php_fpm_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--php_fpm_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--php_fpm_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'php-fpm_exporter'`

##### <a name="-prometheus--php_fpm_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--scrape_uri"></a>`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'`

##### <a name="-prometheus--php_fpm_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--php_fpm_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--php_fpm_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the php-fpm exporter service (default 'php-fpm_exporter')

Default value: `'php-fpm_exporter'`

##### <a name="-prometheus--php_fpm_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'php-fpm_exporter'`

##### <a name="-prometheus--php_fpm_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'2.2.0'`

##### <a name="-prometheus--php_fpm_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--php_fpm_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9253`

##### <a name="-prometheus--php_fpm_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'php-fpm'`

##### <a name="-prometheus--php_fpm_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--php_fpm_exporter--bin_name"></a>`bin_name`

Data type: `String[1]`



Default value: `'php-fpm_exporter'`

##### <a name="-prometheus--php_fpm_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`



Default value: `{}`

##### <a name="-prometheus--php_fpm_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::env_file_path`

### <a name="prometheus--postfix_exporter"></a>`prometheus::postfix_exporter`

manages prometheus postfix_exporter

* **See also**
  * https://github.com/kumina/postfix_exporter

#### Examples

##### Basic usage

```puppet
include prometheus::postfix_exporter
```

#### Parameters

The following parameters are available in the `prometheus::postfix_exporter` class:

* [`install_method`](#-prometheus--postfix_exporter--install_method)
* [`download_url`](#-prometheus--postfix_exporter--download_url)
* [`download_url_base`](#-prometheus--postfix_exporter--download_url_base)
* [`download_extension`](#-prometheus--postfix_exporter--download_extension)
* [`version`](#-prometheus--postfix_exporter--version)
* [`package_ensure`](#-prometheus--postfix_exporter--package_ensure)
* [`package_name`](#-prometheus--postfix_exporter--package_name)
* [`manage_user`](#-prometheus--postfix_exporter--manage_user)
* [`user`](#-prometheus--postfix_exporter--user)
* [`manage_group`](#-prometheus--postfix_exporter--manage_group)
* [`group`](#-prometheus--postfix_exporter--group)
* [`extra_groups`](#-prometheus--postfix_exporter--extra_groups)
* [`manage_service`](#-prometheus--postfix_exporter--manage_service)
* [`init_style`](#-prometheus--postfix_exporter--init_style)
* [`service_name`](#-prometheus--postfix_exporter--service_name)
* [`service_ensure`](#-prometheus--postfix_exporter--service_ensure)
* [`service_enable`](#-prometheus--postfix_exporter--service_enable)
* [`extra_options`](#-prometheus--postfix_exporter--extra_options)
* [`restart_on_change`](#-prometheus--postfix_exporter--restart_on_change)
* [`export_scrape_job`](#-prometheus--postfix_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--postfix_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--postfix_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--postfix_exporter--scrape_job_labels)
* [`proxy_server`](#-prometheus--postfix_exporter--proxy_server)
* [`proxy_type`](#-prometheus--postfix_exporter--proxy_type)
* [`scrape_host`](#-prometheus--postfix_exporter--scrape_host)

##### <a name="-prometheus--postfix_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: `url` or `package`. (Note `package` is not available on most OSes.)

Default value: `'url'`

##### <a name="-prometheus--postfix_exporter--download_url"></a>`download_url`

Data type: `Optional[Stdlib::HTTPUrl]`

Complete URL corresponding to the where the release can be downloaded. (This option is only relevant when `install_method` is `url`.)

Default value: `undef`

##### <a name="-prometheus--postfix_exporter--download_url_base"></a>`download_url_base`

Data type: `Stdlib::HTTPUrl`

Base URL for the binary archive. (This option is only relevant when `install_method` is `url`.)

Default value: `'https://github.com/kumina/postfix_exporter/releases'`

##### <a name="-prometheus--postfix_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive. (This option is only relevant when `install_method` is `url`.)

Default value: `''`

##### <a name="-prometheus--postfix_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version. (This option is only relevant when `install_method` is `url`.)

Default value: `'0.2.0'`

##### <a name="-prometheus--postfix_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

Used when `install_method` is `package`.

Default value: `'installed'`

##### <a name="-prometheus--postfix_exporter--package_name"></a>`package_name`

Data type: `String[1]`

Used when `install_method` is `package`.

Default value: `'postfix_exporter'`

##### <a name="-prometheus--postfix_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create and manage the exporter's user. This can eg. be set to `false` if your package already creates a user for you.

Default value: `true`

##### <a name="-prometheus--postfix_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service.

Default value: `'postfix-exporter'`

##### <a name="-prometheus--postfix_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create and manage the exporter's group. This can eg. be set to `false` if your package already creates a group for you.

Default value: `true`

##### <a name="-prometheus--postfix_exporter--group"></a>`group`

Data type: `String[1]`

Group to run the service as.

Default value: `'postfix-exporter'`

##### <a name="-prometheus--postfix_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the exporter user to.

Default value: `[]`

##### <a name="-prometheus--postfix_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service?

Default value: `true`

##### <a name="-prometheus--postfix_exporter--init_style"></a>`init_style`

Data type: `Optional[Prometheus::Initstyle]`

Service startup scripts style. When not set, the correct default for your OS will be used.
Can also be set to `none` when you don't want the class to create a startup script/unit_file for you.
Typically this can be used when a package is already providing the file.

Default value: `undef`

##### <a name="-prometheus--postfix_exporter--service_name"></a>`service_name`

Data type: `String[1]`

The name of the service.

Default value: `'postfix_exporter'`

##### <a name="-prometheus--postfix_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

Desired state for the service.

Default value: `'running'`

##### <a name="-prometheus--postfix_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet.

Default value: `true`

##### <a name="-prometheus--postfix_exporter--extra_options"></a>`extra_options`

Data type: `String`

Extra options added to the startup command. Override these if you want to monitor a logfile instead of systemd.

Default value: `'--systemd.enable --systemd.unit=\'postfix.service\' --postfix.logfile_path=\'\''`

##### <a name="-prometheus--postfix_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change?

Default value: `true`

##### <a name="-prometheus--postfix_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`

Whether to export a `prometheus::scrape_job` to puppetDB for collecting on your prometheus server.

Default value: `false`

##### <a name="-prometheus--postfix_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`

The port to use in the scrape job.  This won't normally need to be changed unless you run the exporter with a non-default port by overriding `extra_options`.

Default value: `9154`

##### <a name="-prometheus--postfix_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`

The name of the scrape job. When configuring prometheus with this puppet module, the jobs to be collected are configured with `prometheus::collect_scrape_jobs`.

Default value: `'postfix'`

##### <a name="-prometheus--postfix_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`

Labels to configure on the scrape job. If not set, the `prometheus::daemon` default (`{ 'alias' => $scrape_host }`) will be used.

Default value: `undef`

##### <a name="-prometheus--postfix_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--postfix_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--postfix_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

### <a name="prometheus--postgres_exporter"></a>`prometheus::postgres_exporter`

This module manages prometheus node postgres_exporter

#### Parameters

The following parameters are available in the `prometheus::postgres_exporter` class:

* [`arch`](#-prometheus--postgres_exporter--arch)
* [`bin_dir`](#-prometheus--postgres_exporter--bin_dir)
* [`data_source_custom`](#-prometheus--postgres_exporter--data_source_custom)
* [`download_extension`](#-prometheus--postgres_exporter--download_extension)
* [`download_url`](#-prometheus--postgres_exporter--download_url)
* [`download_url_base`](#-prometheus--postgres_exporter--download_url_base)
* [`extra_groups`](#-prometheus--postgres_exporter--extra_groups)
* [`group`](#-prometheus--postgres_exporter--group)
* [`init_style`](#-prometheus--postgres_exporter--init_style)
* [`install_method`](#-prometheus--postgres_exporter--install_method)
* [`manage_group`](#-prometheus--postgres_exporter--manage_group)
* [`manage_service`](#-prometheus--postgres_exporter--manage_service)
* [`manage_user`](#-prometheus--postgres_exporter--manage_user)
* [`os`](#-prometheus--postgres_exporter--os)
* [`package_ensure`](#-prometheus--postgres_exporter--package_ensure)
* [`package_name`](#-prometheus--postgres_exporter--package_name)
* [`purge_config_dir`](#-prometheus--postgres_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--postgres_exporter--restart_on_change)
* [`service_enable`](#-prometheus--postgres_exporter--service_enable)
* [`service_ensure`](#-prometheus--postgres_exporter--service_ensure)
* [`service_name`](#-prometheus--postgres_exporter--service_name)
* [`user`](#-prometheus--postgres_exporter--user)
* [`version`](#-prometheus--postgres_exporter--version)
* [`postgres_user`](#-prometheus--postgres_exporter--postgres_user)
* [`postgres_pass`](#-prometheus--postgres_exporter--postgres_pass)
* [`postgres_auth_method`](#-prometheus--postgres_exporter--postgres_auth_method)
* [`data_source_uri`](#-prometheus--postgres_exporter--data_source_uri)
* [`proxy_server`](#-prometheus--postgres_exporter--proxy_server)
* [`proxy_type`](#-prometheus--postgres_exporter--proxy_type)
* [`web_config_file`](#-prometheus--postgres_exporter--web_config_file)
* [`web_config_content`](#-prometheus--postgres_exporter--web_config_content)
* [`options`](#-prometheus--postgres_exporter--options)
* [`export_scrape_job`](#-prometheus--postgres_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--postgres_exporter--scrape_host)
* [`scrape_port`](#-prometheus--postgres_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--postgres_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--postgres_exporter--scrape_job_labels)

##### <a name="-prometheus--postgres_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--postgres_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--postgres_exporter--data_source_custom"></a>`data_source_custom`

Data type: `Hash[String[1],String[1]]`

Hash of key:value pair to use for alternate environment variables when using param 'postgres_auth_method'

Default value: `{}`

##### <a name="-prometheus--postgres_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--postgres_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--postgres_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/postgres_exporter/releases'`

##### <a name="-prometheus--postgres_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--postgres_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'postgres-exporter'`

##### <a name="-prometheus--postgres_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--postgres_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--postgres_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--postgres_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--postgres_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--postgres_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--postgres_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--postgres_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'postgres_exporter'`

##### <a name="-prometheus--postgres_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--postgres_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--postgres_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--postgres_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--postgres_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'postgres_exporter')

Default value: `'postgres_exporter'`

##### <a name="-prometheus--postgres_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'postgres-exporter'`

##### <a name="-prometheus--postgres_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.19.0'`

##### <a name="-prometheus--postgres_exporter--postgres_user"></a>`postgres_user`

Data type: `Optional[String]`

User to authenticate against postgres

Default value: `undef`

##### <a name="-prometheus--postgres_exporter--postgres_pass"></a>`postgres_pass`

Data type: `Optional[String]`

Password to authenticate against postgres

Default value: `undef`

##### <a name="-prometheus--postgres_exporter--postgres_auth_method"></a>`postgres_auth_method`

Data type: `Enum['custom', 'env', 'file']`

method for presenting username and password to the exporter
This can be file, or env (default 'env')
Using 'custom' requires 'data_source_custom' values

Default value: `'env'`

##### <a name="-prometheus--postgres_exporter--data_source_uri"></a>`data_source_uri`

Data type: `String[1]`

Uri on howto connect to the database

Default value: `'host=/var/run/postgresql/ sslmode=disable'`

##### <a name="-prometheus--postgres_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--postgres_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--postgres_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`

Path of file where the web-config will be saved to

Default value: `'/etc/postgres_exporter_web-config.yml'`

##### <a name="-prometheus--postgres_exporter--web_config_content"></a>`web_config_content`

Data type: `Prometheus::Web_config`

Unless empty the content of the web-config yaml which will handed over as option to the exporter

Default value: `{}`

##### <a name="-prometheus--postgres_exporter--options"></a>`options`

Data type: `String`



Default value: `''`

##### <a name="-prometheus--postgres_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--postgres_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--postgres_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9187`

##### <a name="-prometheus--postgres_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'postgres'`

##### <a name="-prometheus--postgres_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--process_exporter"></a>`prometheus::process_exporter`

This module manages prometheus process_exporter

#### Examples

##### Usage with hash_watched_processes

```puppet
class { 'prometheus::process_exporter':
  version                => '0.6.0',
  arch                   => 'amd64',
  os                     => 'linux',
  bin_dir                => '/usr/local/bin',
  install_method         => 'url',
  hash_watched_processes => {
   'process_names' => [
     {
       'name'    => "{{.Matches}}",
       'cmdline' => [".*process1.*"]
     },
     {
       'name'    => "{{.Matches}}",
       'cmdline' => [".*process2.*"]
     }
   ]
 }
```

#### Parameters

The following parameters are available in the `prometheus::process_exporter` class:

* [`arch`](#-prometheus--process_exporter--arch)
* [`bin_dir`](#-prometheus--process_exporter--bin_dir)
* [`download_extension`](#-prometheus--process_exporter--download_extension)
* [`download_url`](#-prometheus--process_exporter--download_url)
* [`download_url_base`](#-prometheus--process_exporter--download_url_base)
* [`extra_groups`](#-prometheus--process_exporter--extra_groups)
* [`extra_options`](#-prometheus--process_exporter--extra_options)
* [`group`](#-prometheus--process_exporter--group)
* [`init_style`](#-prometheus--process_exporter--init_style)
* [`install_method`](#-prometheus--process_exporter--install_method)
* [`manage_group`](#-prometheus--process_exporter--manage_group)
* [`manage_service`](#-prometheus--process_exporter--manage_service)
* [`manage_user`](#-prometheus--process_exporter--manage_user)
* [`os`](#-prometheus--process_exporter--os)
* [`package_ensure`](#-prometheus--process_exporter--package_ensure)
* [`package_name`](#-prometheus--process_exporter--package_name)
* [`purge_config_dir`](#-prometheus--process_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--process_exporter--restart_on_change)
* [`service_enable`](#-prometheus--process_exporter--service_enable)
* [`service_ensure`](#-prometheus--process_exporter--service_ensure)
* [`service_name`](#-prometheus--process_exporter--service_name)
* [`user`](#-prometheus--process_exporter--user)
* [`version`](#-prometheus--process_exporter--version)
* [`hash_watched_processes`](#-prometheus--process_exporter--hash_watched_processes)
* [`watched_processes`](#-prometheus--process_exporter--watched_processes)
* [`proxy_server`](#-prometheus--process_exporter--proxy_server)
* [`proxy_type`](#-prometheus--process_exporter--proxy_type)
* [`config_path`](#-prometheus--process_exporter--config_path)
* [`config_mode`](#-prometheus--process_exporter--config_mode)
* [`export_scrape_job`](#-prometheus--process_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--process_exporter--scrape_host)
* [`scrape_port`](#-prometheus--process_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--process_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--process_exporter--scrape_job_labels)

##### <a name="-prometheus--process_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--process_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--process_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--process_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--process_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/ncabatoff/process-exporter/releases'`

##### <a name="-prometheus--process_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--process_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--process_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'process-exporter'`

##### <a name="-prometheus--process_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--process_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--process_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--process_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--process_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--process_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--process_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--process_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'process-exporter'`

##### <a name="-prometheus--process_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--process_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--process_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--process_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--process_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the process exporter service (default 'process-exporter')

Default value: `'process-exporter'`

##### <a name="-prometheus--process_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'process-exporter'`

##### <a name="-prometheus--process_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.8.7'`

##### <a name="-prometheus--process_exporter--hash_watched_processes"></a>`hash_watched_processes`

Data type: `Hash`

A hash of processes to monitor with the ability to pass different options
Don't set if you want to use only the Array version of it (watched_processes)

Default value: `{}`

##### <a name="-prometheus--process_exporter--watched_processes"></a>`watched_processes`

Data type: `Array`

A list of processes to monitor
Has no effect if hash_watched_processes is set

Default value: `[]`

##### <a name="-prometheus--process_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--process_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--process_exporter--config_path"></a>`config_path`

Data type: `Stdlib::Absolutepath`



Default value: `'/etc/process-exporter.yaml'`

##### <a name="-prometheus--process_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`



Default value: `$prometheus::config_mode`

##### <a name="-prometheus--process_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--process_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--process_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9256`

##### <a name="-prometheus--process_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'process'`

##### <a name="-prometheus--process_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--puppetdb_exporter"></a>`prometheus::puppetdb_exporter`

This module manages prometheus node puppetdb_exporter

#### Parameters

The following parameters are available in the `prometheus::puppetdb_exporter` class:

* [`arch`](#-prometheus--puppetdb_exporter--arch)
* [`bin_dir`](#-prometheus--puppetdb_exporter--bin_dir)
* [`download_extension`](#-prometheus--puppetdb_exporter--download_extension)
* [`download_url`](#-prometheus--puppetdb_exporter--download_url)
* [`download_url_base`](#-prometheus--puppetdb_exporter--download_url_base)
* [`extra_groups`](#-prometheus--puppetdb_exporter--extra_groups)
* [`extra_options`](#-prometheus--puppetdb_exporter--extra_options)
* [`group`](#-prometheus--puppetdb_exporter--group)
* [`init_style`](#-prometheus--puppetdb_exporter--init_style)
* [`install_method`](#-prometheus--puppetdb_exporter--install_method)
* [`manage_group`](#-prometheus--puppetdb_exporter--manage_group)
* [`manage_service`](#-prometheus--puppetdb_exporter--manage_service)
* [`manage_user`](#-prometheus--puppetdb_exporter--manage_user)
* [`os`](#-prometheus--puppetdb_exporter--os)
* [`package_ensure`](#-prometheus--puppetdb_exporter--package_ensure)
* [`package_name`](#-prometheus--puppetdb_exporter--package_name)
* [`purge_config_dir`](#-prometheus--puppetdb_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--puppetdb_exporter--restart_on_change)
* [`service_enable`](#-prometheus--puppetdb_exporter--service_enable)
* [`service_ensure`](#-prometheus--puppetdb_exporter--service_ensure)
* [`service_name`](#-prometheus--puppetdb_exporter--service_name)
* [`user`](#-prometheus--puppetdb_exporter--user)
* [`version`](#-prometheus--puppetdb_exporter--version)
* [`puppetdb_url`](#-prometheus--puppetdb_exporter--puppetdb_url)
* [`proxy_server`](#-prometheus--puppetdb_exporter--proxy_server)
* [`proxy_type`](#-prometheus--puppetdb_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--puppetdb_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--puppetdb_exporter--scrape_host)
* [`scrape_port`](#-prometheus--puppetdb_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--puppetdb_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--puppetdb_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--puppetdb_exporter--bin_name)

##### <a name="-prometheus--puppetdb_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--puppetdb_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--puppetdb_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--puppetdb_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/camptocamp/prometheus-puppetdb-exporter/releases'`

##### <a name="-prometheus--puppetdb_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--puppetdb_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'puppetdb-exporter'`

##### <a name="-prometheus--puppetdb_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--puppetdb_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--puppetdb_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--puppetdb_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'present'`

##### <a name="-prometheus--puppetdb_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'puppetdb_exporter'`

##### <a name="-prometheus--puppetdb_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--puppetdb_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--puppetdb_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the puppetdb exporter service (default 'puppetdb_exporter')

Default value: `'puppetdb_exporter'`

##### <a name="-prometheus--puppetdb_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'puppetdb-exporter'`

##### <a name="-prometheus--puppetdb_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.1.0'`

##### <a name="-prometheus--puppetdb_exporter--puppetdb_url"></a>`puppetdb_url`

Data type: `Stdlib::HTTPUrl`

The URI to PuppetDB with http/https protocol at the beginning and `/pdb/query` at the end

Default value: `'http://127.0.0.1:8080/pdb/query'`

##### <a name="-prometheus--puppetdb_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--puppetdb_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9635`

##### <a name="-prometheus--puppetdb_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'puppetdb'`

##### <a name="-prometheus--puppetdb_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--puppetdb_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--pushgateway"></a>`prometheus::pushgateway`

This module manages prometheus node pushgateway

#### Parameters

The following parameters are available in the `prometheus::pushgateway` class:

* [`arch`](#-prometheus--pushgateway--arch)
* [`bin_dir`](#-prometheus--pushgateway--bin_dir)
* [`download_extension`](#-prometheus--pushgateway--download_extension)
* [`download_url`](#-prometheus--pushgateway--download_url)
* [`download_url_base`](#-prometheus--pushgateway--download_url_base)
* [`extra_groups`](#-prometheus--pushgateway--extra_groups)
* [`extra_options`](#-prometheus--pushgateway--extra_options)
* [`group`](#-prometheus--pushgateway--group)
* [`init_style`](#-prometheus--pushgateway--init_style)
* [`install_method`](#-prometheus--pushgateway--install_method)
* [`manage_group`](#-prometheus--pushgateway--manage_group)
* [`manage_service`](#-prometheus--pushgateway--manage_service)
* [`manage_user`](#-prometheus--pushgateway--manage_user)
* [`os`](#-prometheus--pushgateway--os)
* [`package_ensure`](#-prometheus--pushgateway--package_ensure)
* [`package_name`](#-prometheus--pushgateway--package_name)
* [`restart_on_change`](#-prometheus--pushgateway--restart_on_change)
* [`service_enable`](#-prometheus--pushgateway--service_enable)
* [`service_ensure`](#-prometheus--pushgateway--service_ensure)
* [`service_name`](#-prometheus--pushgateway--service_name)
* [`user`](#-prometheus--pushgateway--user)
* [`version`](#-prometheus--pushgateway--version)
* [`proxy_server`](#-prometheus--pushgateway--proxy_server)
* [`proxy_type`](#-prometheus--pushgateway--proxy_type)

##### <a name="-prometheus--pushgateway--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--pushgateway--bin_dir"></a>`bin_dir`

Data type: `String[1]`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--pushgateway--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--pushgateway--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--pushgateway--download_url_base"></a>`download_url_base`

Data type: `String[1]`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/pushgateway/releases'`

##### <a name="-prometheus--pushgateway--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--pushgateway--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--pushgateway--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'pushgateway'`

##### <a name="-prometheus--pushgateway--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--pushgateway--install_method"></a>`install_method`

Data type: `String[1]`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--pushgateway--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushgateway--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--pushgateway--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushgateway--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--pushgateway--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--pushgateway--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'pushgateway'`

##### <a name="-prometheus--pushgateway--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--pushgateway--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--pushgateway--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--pushgateway--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'pushgateway')

Default value: `'pushgateway'`

##### <a name="-prometheus--pushgateway--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'pushgateway'`

##### <a name="-prometheus--pushgateway--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.9.0'`

##### <a name="-prometheus--pushgateway--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--pushgateway--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

### <a name="prometheus--pushprox_client"></a>`prometheus::pushprox_client`

This module manages prometheus pushprox_client

#### Parameters

The following parameters are available in the `prometheus::pushprox_client` class:

* [`arch`](#-prometheus--pushprox_client--arch)
* [`bin_dir`](#-prometheus--pushprox_client--bin_dir)
* [`config_mode`](#-prometheus--pushprox_client--config_mode)
* [`download_extension`](#-prometheus--pushprox_client--download_extension)
* [`download_url`](#-prometheus--pushprox_client--download_url)
* [`download_url_base`](#-prometheus--pushprox_client--download_url_base)
* [`extra_groups`](#-prometheus--pushprox_client--extra_groups)
* [`extra_options`](#-prometheus--pushprox_client--extra_options)
* [`group`](#-prometheus--pushprox_client--group)
* [`init_style`](#-prometheus--pushprox_client--init_style)
* [`install_method`](#-prometheus--pushprox_client--install_method)
* [`manage_group`](#-prometheus--pushprox_client--manage_group)
* [`manage_service`](#-prometheus--pushprox_client--manage_service)
* [`manage_user`](#-prometheus--pushprox_client--manage_user)
* [`os`](#-prometheus--pushprox_client--os)
* [`package_ensure`](#-prometheus--pushprox_client--package_ensure)
* [`package_name`](#-prometheus--pushprox_client--package_name)
* [`purge_config_dir`](#-prometheus--pushprox_client--purge_config_dir)
* [`restart_on_change`](#-prometheus--pushprox_client--restart_on_change)
* [`service_enable`](#-prometheus--pushprox_client--service_enable)
* [`service_ensure`](#-prometheus--pushprox_client--service_ensure)
* [`service_name`](#-prometheus--pushprox_client--service_name)
* [`user`](#-prometheus--pushprox_client--user)
* [`version`](#-prometheus--pushprox_client--version)
* [`env_vars`](#-prometheus--pushprox_client--env_vars)
* [`proxy_server`](#-prometheus--pushprox_client--proxy_server)
* [`proxy_type`](#-prometheus--pushprox_client--proxy_type)
* [`proxy_url`](#-prometheus--pushprox_client--proxy_url)

##### <a name="-prometheus--pushprox_client--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--pushprox_client--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--pushprox_client--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--pushprox_client--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--pushprox_client--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--pushprox_client--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/PushProx/releases'`

##### <a name="-prometheus--pushprox_client--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--pushprox_client--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--pushprox_client--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'pushprox_client'`

##### <a name="-prometheus--pushprox_client--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--pushprox_client--install_method"></a>`install_method`

Data type: `String[1]`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--pushprox_client--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushprox_client--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_client--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushprox_client--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--pushprox_client--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--pushprox_client--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'pushprox_client'`

##### <a name="-prometheus--pushprox_client--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--pushprox_client--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_client--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_client--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--pushprox_client--service_name"></a>`service_name`

Data type: `String[1]`

Name of the pushprox_client service (default 'pushprox_client')

Default value: `'pushprox_client'`

##### <a name="-prometheus--pushprox_client--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'pushprox_client'`

##### <a name="-prometheus--pushprox_client--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.2.0'`

##### <a name="-prometheus--pushprox_client--env_vars"></a>`env_vars`

Data type: `Hash[String, Scalar]`

The environment variable to pass to the daemon

Default value: `{}`

##### <a name="-prometheus--pushprox_client--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--pushprox_client--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--pushprox_client--proxy_url"></a>`proxy_url`

Data type: `String[1]`



### <a name="prometheus--pushprox_proxy"></a>`prometheus::pushprox_proxy`

This module manages prometheus pushprox_proxy

#### Parameters

The following parameters are available in the `prometheus::pushprox_proxy` class:

* [`arch`](#-prometheus--pushprox_proxy--arch)
* [`bin_dir`](#-prometheus--pushprox_proxy--bin_dir)
* [`config_mode`](#-prometheus--pushprox_proxy--config_mode)
* [`download_extension`](#-prometheus--pushprox_proxy--download_extension)
* [`download_url`](#-prometheus--pushprox_proxy--download_url)
* [`download_url_base`](#-prometheus--pushprox_proxy--download_url_base)
* [`extra_groups`](#-prometheus--pushprox_proxy--extra_groups)
* [`extra_options`](#-prometheus--pushprox_proxy--extra_options)
* [`group`](#-prometheus--pushprox_proxy--group)
* [`init_style`](#-prometheus--pushprox_proxy--init_style)
* [`install_method`](#-prometheus--pushprox_proxy--install_method)
* [`manage_group`](#-prometheus--pushprox_proxy--manage_group)
* [`manage_service`](#-prometheus--pushprox_proxy--manage_service)
* [`manage_user`](#-prometheus--pushprox_proxy--manage_user)
* [`os`](#-prometheus--pushprox_proxy--os)
* [`package_ensure`](#-prometheus--pushprox_proxy--package_ensure)
* [`package_name`](#-prometheus--pushprox_proxy--package_name)
* [`purge_config_dir`](#-prometheus--pushprox_proxy--purge_config_dir)
* [`restart_on_change`](#-prometheus--pushprox_proxy--restart_on_change)
* [`service_enable`](#-prometheus--pushprox_proxy--service_enable)
* [`service_ensure`](#-prometheus--pushprox_proxy--service_ensure)
* [`service_name`](#-prometheus--pushprox_proxy--service_name)
* [`user`](#-prometheus--pushprox_proxy--user)
* [`version`](#-prometheus--pushprox_proxy--version)
* [`proxy_server`](#-prometheus--pushprox_proxy--proxy_server)
* [`proxy_type`](#-prometheus--pushprox_proxy--proxy_type)

##### <a name="-prometheus--pushprox_proxy--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--pushprox_proxy--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--pushprox_proxy--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--pushprox_proxy--download_extension"></a>`download_extension`

Data type: `String[1]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--pushprox_proxy--download_url"></a>`download_url`

Data type: `Optional[String]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--pushprox_proxy--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/PushProx/releases'`

##### <a name="-prometheus--pushprox_proxy--extra_groups"></a>`extra_groups`

Data type: `Array[String[1]]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--pushprox_proxy--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--pushprox_proxy--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'pushprox_proxy'`

##### <a name="-prometheus--pushprox_proxy--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--pushprox_proxy--install_method"></a>`install_method`

Data type: `String[1]`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--pushprox_proxy--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--pushprox_proxy--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--pushprox_proxy--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'pushprox_proxy'`

##### <a name="-prometheus--pushprox_proxy--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--pushprox_proxy--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--pushprox_proxy--service_name"></a>`service_name`

Data type: `String[1]`

Name of the pushprox_proxy service (default 'pushprox_proxy')

Default value: `'pushprox_proxy'`

##### <a name="-prometheus--pushprox_proxy--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'pushprox_proxy'`

##### <a name="-prometheus--pushprox_proxy--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.2.0'`

##### <a name="-prometheus--pushprox_proxy--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--pushprox_proxy--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

### <a name="prometheus--redis_exporter"></a>`prometheus::redis_exporter`

This module manages prometheus node redis_exporter

#### Parameters

The following parameters are available in the `prometheus::redis_exporter` class:

* [`arch`](#-prometheus--redis_exporter--arch)
* [`bin_dir`](#-prometheus--redis_exporter--bin_dir)
* [`addr`](#-prometheus--redis_exporter--addr)
* [`download_extension`](#-prometheus--redis_exporter--download_extension)
* [`download_url`](#-prometheus--redis_exporter--download_url)
* [`download_url_base`](#-prometheus--redis_exporter--download_url_base)
* [`extra_groups`](#-prometheus--redis_exporter--extra_groups)
* [`extra_options`](#-prometheus--redis_exporter--extra_options)
* [`group`](#-prometheus--redis_exporter--group)
* [`init_style`](#-prometheus--redis_exporter--init_style)
* [`install_method`](#-prometheus--redis_exporter--install_method)
* [`manage_group`](#-prometheus--redis_exporter--manage_group)
* [`manage_service`](#-prometheus--redis_exporter--manage_service)
* [`manage_user`](#-prometheus--redis_exporter--manage_user)
* [`namespace`](#-prometheus--redis_exporter--namespace)
* [`os`](#-prometheus--redis_exporter--os)
* [`package_ensure`](#-prometheus--redis_exporter--package_ensure)
* [`package_name`](#-prometheus--redis_exporter--package_name)
* [`purge_config_dir`](#-prometheus--redis_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--redis_exporter--restart_on_change)
* [`service_enable`](#-prometheus--redis_exporter--service_enable)
* [`service_ensure`](#-prometheus--redis_exporter--service_ensure)
* [`service_name`](#-prometheus--redis_exporter--service_name)
* [`user`](#-prometheus--redis_exporter--user)
* [`version`](#-prometheus--redis_exporter--version)
* [`proxy_server`](#-prometheus--redis_exporter--proxy_server)
* [`proxy_type`](#-prometheus--redis_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--redis_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--redis_exporter--scrape_host)
* [`scrape_port`](#-prometheus--redis_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--redis_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--redis_exporter--scrape_job_labels)

##### <a name="-prometheus--redis_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--redis_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--redis_exporter--addr"></a>`addr`

Data type: `Array[String]`

Array of address of one or more redis nodes. Defaults to redis://localhost:6379

Default value: `['redis://localhost:6379']`

##### <a name="-prometheus--redis_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--redis_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--redis_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/oliver006/redis_exporter/releases'`

##### <a name="-prometheus--redis_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--redis_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command
For a full list of the exporter's supported extra options
please refer to https://github.com/oliver006/redis_exporter

Default value: `undef`

##### <a name="-prometheus--redis_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'redis-exporter'`

##### <a name="-prometheus--redis_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--redis_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--redis_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--redis_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--redis_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--redis_exporter--namespace"></a>`namespace`

Data type: `String[1]`

Namespace for the metrics, defaults to `redis`.

Default value: `'redis'`

##### <a name="-prometheus--redis_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--redis_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--redis_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'redis_exporter'`

##### <a name="-prometheus--redis_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--redis_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--redis_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--redis_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--redis_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'redis_exporter')

Default value: `'redis_exporter'`

##### <a name="-prometheus--redis_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'redis-exporter'`

##### <a name="-prometheus--redis_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.81.0'`

##### <a name="-prometheus--redis_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--redis_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--redis_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--redis_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--redis_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9121`

##### <a name="-prometheus--redis_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'redis'`

##### <a name="-prometheus--redis_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--run_service"></a>`prometheus::run_service`

This class is meant to be called from prometheus. It ensure the service is running

### <a name="prometheus--sachet"></a>`prometheus::sachet`

This module manages prometheus sachet (https://github.com/messagebird/sachet)

#### Parameters

The following parameters are available in the `prometheus::sachet` class:

* [`arch`](#-prometheus--sachet--arch)
* [`bin_dir`](#-prometheus--sachet--bin_dir)
* [`download_extension`](#-prometheus--sachet--download_extension)
* [`download_url`](#-prometheus--sachet--download_url)
* [`download_url_base`](#-prometheus--sachet--download_url_base)
* [`extra_groups`](#-prometheus--sachet--extra_groups)
* [`extra_options`](#-prometheus--sachet--extra_options)
* [`group`](#-prometheus--sachet--group)
* [`init_style`](#-prometheus--sachet--init_style)
* [`install_method`](#-prometheus--sachet--install_method)
* [`manage_group`](#-prometheus--sachet--manage_group)
* [`manage_service`](#-prometheus--sachet--manage_service)
* [`manage_user`](#-prometheus--sachet--manage_user)
* [`os`](#-prometheus--sachet--os)
* [`package_ensure`](#-prometheus--sachet--package_ensure)
* [`package_name`](#-prometheus--sachet--package_name)
* [`purge_config_dir`](#-prometheus--sachet--purge_config_dir)
* [`templates`](#-prometheus--sachet--templates)
* [`receivers`](#-prometheus--sachet--receivers)
* [`providers`](#-prometheus--sachet--providers)
* [`restart_on_change`](#-prometheus--sachet--restart_on_change)
* [`service_enable`](#-prometheus--sachet--service_enable)
* [`service_ensure`](#-prometheus--sachet--service_ensure)
* [`service_name`](#-prometheus--sachet--service_name)
* [`user`](#-prometheus--sachet--user)
* [`version`](#-prometheus--sachet--version)
* [`proxy_server`](#-prometheus--sachet--proxy_server)
* [`proxy_type`](#-prometheus--sachet--proxy_type)
* [`config_dir`](#-prometheus--sachet--config_dir)
* [`config_file`](#-prometheus--sachet--config_file)
* [`config_mode`](#-prometheus--sachet--config_mode)
* [`listen_port`](#-prometheus--sachet--listen_port)
* [`bin_name`](#-prometheus--sachet--bin_name)

##### <a name="-prometheus--sachet--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--sachet--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--sachet--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--sachet--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--sachet--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/messagebird/sachet/releases'`

##### <a name="-prometheus--sachet--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--sachet--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--sachet--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'sachet'`

##### <a name="-prometheus--sachet--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--sachet--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--sachet--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--sachet--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--sachet--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--sachet--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--sachet--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--sachet--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'sachet'`

##### <a name="-prometheus--sachet--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--sachet--templates"></a>`templates`

Data type: `Array`

An array of templates.
Example:
prometheus::sachet::templates:
- name: 'notifications'
  template: |
    {{ define "telegram_title" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .CommonLabels.alertname }} @ {{ .CommonLabels.identifier }} {{ end }}

    {{ define "telegram_message" }}
    {{ if gt (len .Alerts.Firing) 0 }}
    *Alerts Firing:*
    {{ range .Alerts.Firing }}• {{ .Labels.instance }}: {{ .Annotations.description }}
    {{ end }}{{ end }}
    {{ if gt (len .Alerts.Resolved) 0 }}
    *Alerts Resolved:*
    {{ range .Alerts.Resolved }}• {{ .Labels.instance }}: {{ .Annotations.description }}
    {{ end }}{{ end }}{{ end }}

    {{ define "telegram_text" }}{{ template "telegram_title" .}}
    {{ template "telegram_message" . }}{{ end }}

Default value: `[]`

##### <a name="-prometheus--sachet--receivers"></a>`receivers`

Data type: `Array`

An array of receivers.
Example:
prometheus::sachet::receivers:
- name: 'Telegram'
  provider: telegram
  text: '{{ template "telegram_message" . }}'

Default value: `[]`

##### <a name="-prometheus--sachet--providers"></a>`providers`

Data type: `Hash`

An hash of providers.
See https://github.com/messagebird/sachet/blob/master/examples/config.yaml for more examples
Example:
prometheus::sachet::providers:
  telegram:
    token: "724679217:aa26V5mK3e2qkGsSlTT-iHreaa5FUyy3Z_0"

Default value: `{}`

##### <a name="-prometheus--sachet--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--sachet--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--sachet--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--sachet--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'sachet')

Default value: `'sachet'`

##### <a name="-prometheus--sachet--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'sachet'`

##### <a name="-prometheus--sachet--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.2.6'`

##### <a name="-prometheus--sachet--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--sachet--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--sachet--config_dir"></a>`config_dir`

Data type: `Stdlib::Absolutepath`



Default value: `'/etc/sachet'`

##### <a name="-prometheus--sachet--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`



Default value: `'/etc/sachet/sachet.yaml'`

##### <a name="-prometheus--sachet--config_mode"></a>`config_mode`

Data type: `String[1]`



Default value: `$prometheus::config_mode`

##### <a name="-prometheus--sachet--listen_port"></a>`listen_port`

Data type: `Stdlib::Port`



Default value: `9876`

##### <a name="-prometheus--sachet--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--server"></a>`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`](#-prometheus--server--configname)
* [`user`](#-prometheus--server--user)
* [`group`](#-prometheus--server--group)
* [`extra_groups`](#-prometheus--server--extra_groups)
* [`bin_dir`](#-prometheus--server--bin_dir)
* [`shared_dir`](#-prometheus--server--shared_dir)
* [`version`](#-prometheus--server--version)
* [`install_method`](#-prometheus--server--install_method)
* [`download_url_base`](#-prometheus--server--download_url_base)
* [`download_extension`](#-prometheus--server--download_extension)
* [`package_name`](#-prometheus--server--package_name)
* [`package_ensure`](#-prometheus--server--package_ensure)
* [`config_dir`](#-prometheus--server--config_dir)
* [`manage_config_dir`](#-prometheus--server--manage_config_dir)
* [`localstorage`](#-prometheus--server--localstorage)
* [`manage_localstorage`](#-prometheus--server--manage_localstorage)
* [`config_template`](#-prometheus--server--config_template)
* [`config_mode`](#-prometheus--server--config_mode)
* [`global_config`](#-prometheus--server--global_config)
* [`rule_files`](#-prometheus--server--rule_files)
* [`scrape_configs`](#-prometheus--server--scrape_configs)
* [`scrape_config_files`](#-prometheus--server--scrape_config_files)
* [`include_default_scrape_configs`](#-prometheus--server--include_default_scrape_configs)
* [`remote_read_configs`](#-prometheus--server--remote_read_configs)
* [`remote_write_configs`](#-prometheus--server--remote_write_configs)
* [`enable_tracing`](#-prometheus--server--enable_tracing)
* [`tracing_config`](#-prometheus--server--tracing_config)
* [`alerts`](#-prometheus--server--alerts)
* [`alert_relabel_config`](#-prometheus--server--alert_relabel_config)
* [`alertmanagers_config`](#-prometheus--server--alertmanagers_config)
* [`storage_retention`](#-prometheus--server--storage_retention)
* [`env_file_path`](#-prometheus--server--env_file_path)
* [`extra_alerts`](#-prometheus--server--extra_alerts)
* [`service_enable`](#-prometheus--server--service_enable)
* [`service_ensure`](#-prometheus--server--service_ensure)
* [`service_name`](#-prometheus--server--service_name)
* [`manage_service`](#-prometheus--server--manage_service)
* [`restart_on_change`](#-prometheus--server--restart_on_change)
* [`init_style`](#-prometheus--server--init_style)
* [`extra_options`](#-prometheus--server--extra_options)
* [`config_hash`](#-prometheus--server--config_hash)
* [`config_defaults`](#-prometheus--server--config_defaults)
* [`os`](#-prometheus--server--os)
* [`download_url`](#-prometheus--server--download_url)
* [`arch`](#-prometheus--server--arch)
* [`manage_group`](#-prometheus--server--manage_group)
* [`purge_config_dir`](#-prometheus--server--purge_config_dir)
* [`manage_user`](#-prometheus--server--manage_user)
* [`manage_config`](#-prometheus--server--manage_config)
* [`external_url`](#-prometheus--server--external_url)
* [`collect_scrape_jobs`](#-prometheus--server--collect_scrape_jobs)
* [`collect_tag`](#-prometheus--server--collect_tag)
* [`max_open_files`](#-prometheus--server--max_open_files)
* [`usershell`](#-prometheus--server--usershell)
* [`proxy_server`](#-prometheus--server--proxy_server)
* [`proxy_type`](#-prometheus--server--proxy_type)
* [`manage_init_file`](#-prometheus--server--manage_init_file)

##### <a name="-prometheus--server--configname"></a>`configname`

Data type: `String`



Default value: `$prometheus::configname`

##### <a name="-prometheus--server--user"></a>`user`

Data type: `String`



Default value: `$prometheus::user`

##### <a name="-prometheus--server--group"></a>`group`

Data type: `String`



Default value: `$prometheus::group`

##### <a name="-prometheus--server--extra_groups"></a>`extra_groups`

Data type: `Array`



Default value: `$prometheus::extra_groups`

##### <a name="-prometheus--server--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--server--shared_dir"></a>`shared_dir`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::shared_dir`

##### <a name="-prometheus--server--version"></a>`version`

Data type: `String`



Default value: `$prometheus::version`

##### <a name="-prometheus--server--install_method"></a>`install_method`

Data type: `String`



Default value: `$prometheus::install_method`

##### <a name="-prometheus--server--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`



Default value: `$prometheus::download_url_base`

##### <a name="-prometheus--server--download_extension"></a>`download_extension`

Data type: `String`



Default value: `$prometheus::download_extension`

##### <a name="-prometheus--server--package_name"></a>`package_name`

Data type: `String`



Default value: `$prometheus::package_name`

##### <a name="-prometheus--server--package_ensure"></a>`package_ensure`

Data type: `String`



Default value: `$prometheus::package_ensure`

##### <a name="-prometheus--server--config_dir"></a>`config_dir`

Data type: `String`



Default value: `$prometheus::config_dir`

##### <a name="-prometheus--server--manage_config_dir"></a>`manage_config_dir`

Data type: `Boolean`



Default value: `$prometheus::manage_config_dir`

##### <a name="-prometheus--server--localstorage"></a>`localstorage`

Data type: `Variant[Stdlib::Absolutepath, Boolean[false]]`



Default value: `$prometheus::localstorage`

##### <a name="-prometheus--server--manage_localstorage"></a>`manage_localstorage`

Data type: `Boolean`



Default value: `$prometheus::manage_localstorage`

##### <a name="-prometheus--server--config_template"></a>`config_template`

Data type: `String`



Default value: `$prometheus::config_template`

##### <a name="-prometheus--server--config_mode"></a>`config_mode`

Data type: `String`



Default value: `$prometheus::config_mode`

##### <a name="-prometheus--server--global_config"></a>`global_config`

Data type: `Hash`



Default value: `$prometheus::global_config`

##### <a name="-prometheus--server--rule_files"></a>`rule_files`

Data type: `Array`



Default value: `$prometheus::rule_files`

##### <a name="-prometheus--server--scrape_configs"></a>`scrape_configs`

Data type: `Array`



Default value: `$prometheus::scrape_configs`

##### <a name="-prometheus--server--scrape_config_files"></a>`scrape_config_files`

Data type: `Optional[Array]`



Default value: `$prometheus::scrape_config_files`

##### <a name="-prometheus--server--include_default_scrape_configs"></a>`include_default_scrape_configs`

Data type: `Boolean`



Default value: `$prometheus::include_default_scrape_configs`

##### <a name="-prometheus--server--remote_read_configs"></a>`remote_read_configs`

Data type: `Array`



Default value: `$prometheus::remote_read_configs`

##### <a name="-prometheus--server--remote_write_configs"></a>`remote_write_configs`

Data type: `Array`



Default value: `$prometheus::remote_write_configs`

##### <a name="-prometheus--server--enable_tracing"></a>`enable_tracing`

Data type: `Boolean`



Default value: `$prometheus::enable_tracing`

##### <a name="-prometheus--server--tracing_config"></a>`tracing_config`

Data type: `Hash`



Default value: `$prometheus::tracing_config`

##### <a name="-prometheus--server--alerts"></a>`alerts`

Data type: `Variant[Array,Hash]`



Default value: `$prometheus::alerts`

##### <a name="-prometheus--server--alert_relabel_config"></a>`alert_relabel_config`

Data type: `Array`



Default value: `$prometheus::alert_relabel_config`

##### <a name="-prometheus--server--alertmanagers_config"></a>`alertmanagers_config`

Data type: `Array`



Default value: `$prometheus::alertmanagers_config`

##### <a name="-prometheus--server--storage_retention"></a>`storage_retention`

Data type: `Variant[String, Boolean[false]]`



Default value: `$prometheus::storage_retention`

##### <a name="-prometheus--server--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--server--extra_alerts"></a>`extra_alerts`

Data type: `Hash`



Default value: `$prometheus::extra_alerts`

##### <a name="-prometheus--server--service_enable"></a>`service_enable`

Data type: `Boolean`



Default value: `$prometheus::service_enable`

##### <a name="-prometheus--server--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`



Default value: `$prometheus::service_ensure`

##### <a name="-prometheus--server--service_name"></a>`service_name`

Data type: `String[1]`



Default value: `$prometheus::service_name`

##### <a name="-prometheus--server--manage_service"></a>`manage_service`

Data type: `Boolean`



Default value: `$prometheus::manage_service`

##### <a name="-prometheus--server--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`



Default value: `$prometheus::restart_on_change`

##### <a name="-prometheus--server--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`



Default value: `$prometheus::init_style`

##### <a name="-prometheus--server--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`



Default value: `$prometheus::extra_options`

##### <a name="-prometheus--server--config_hash"></a>`config_hash`

Data type: `Hash`



Default value: `$prometheus::config_hash`

##### <a name="-prometheus--server--config_defaults"></a>`config_defaults`

Data type: `Hash`



Default value: `$prometheus::config_defaults`

##### <a name="-prometheus--server--os"></a>`os`

Data type: `String[1]`



Default value: `$prometheus::os`

##### <a name="-prometheus--server--download_url"></a>`download_url`

Data type: `Optional[String]`



Default value: `$prometheus::download_url`

##### <a name="-prometheus--server--arch"></a>`arch`

Data type: `String[1]`



Default value: `$prometheus::real_arch`

##### <a name="-prometheus--server--manage_group"></a>`manage_group`

Data type: `Boolean`



Default value: `$prometheus::manage_group`

##### <a name="-prometheus--server--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`



Default value: `$prometheus::purge_config_dir`

##### <a name="-prometheus--server--manage_user"></a>`manage_user`

Data type: `Boolean`



Default value: `$prometheus::manage_user`

##### <a name="-prometheus--server--manage_config"></a>`manage_config`

Data type: `Boolean`



Default value: `$prometheus::manage_config`

##### <a name="-prometheus--server--external_url"></a>`external_url`

Data type: `Optional[Variant[Stdlib::HTTPurl, Stdlib::Unixpath, String[1]]]`



Default value: `$prometheus::external_url`

##### <a name="-prometheus--server--collect_scrape_jobs"></a>`collect_scrape_jobs`

Data type: `Optional[Array[Hash[String[1], Any]]]`



Default value: `$prometheus::collect_scrape_jobs`

##### <a name="-prometheus--server--collect_tag"></a>`collect_tag`

Data type: `Optional[String[1]]`



Default value: `$prometheus::collect_tag`

##### <a name="-prometheus--server--max_open_files"></a>`max_open_files`

Data type: `Optional[Integer]`



Default value: `$prometheus::max_open_files`

##### <a name="-prometheus--server--usershell"></a>`usershell`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::usershell`

##### <a name="-prometheus--server--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`



Default value: `$prometheus::proxy_server`

##### <a name="-prometheus--server--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`



Default value: `$prometheus::proxy_type`

##### <a name="-prometheus--server--manage_init_file"></a>`manage_init_file`

Data type: `Boolean`



Default value: `$prometheus::manage_init_file`

### <a name="prometheus--snmp_exporter"></a>`prometheus::snmp_exporter`

This module manages prometheus snmp_exporter

#### Parameters

The following parameters are available in the `prometheus::snmp_exporter` class:

* [`arch`](#-prometheus--snmp_exporter--arch)
* [`bin_dir`](#-prometheus--snmp_exporter--bin_dir)
* [`config_file`](#-prometheus--snmp_exporter--config_file)
* [`config_mode`](#-prometheus--snmp_exporter--config_mode)
* [`config_template`](#-prometheus--snmp_exporter--config_template)
* [`download_extension`](#-prometheus--snmp_exporter--download_extension)
* [`download_url`](#-prometheus--snmp_exporter--download_url)
* [`download_url_base`](#-prometheus--snmp_exporter--download_url_base)
* [`extra_groups`](#-prometheus--snmp_exporter--extra_groups)
* [`extra_options`](#-prometheus--snmp_exporter--extra_options)
* [`group`](#-prometheus--snmp_exporter--group)
* [`init_style`](#-prometheus--snmp_exporter--init_style)
* [`install_method`](#-prometheus--snmp_exporter--install_method)
* [`manage_group`](#-prometheus--snmp_exporter--manage_group)
* [`manage_service`](#-prometheus--snmp_exporter--manage_service)
* [`manage_user`](#-prometheus--snmp_exporter--manage_user)
* [`os`](#-prometheus--snmp_exporter--os)
* [`package_ensure`](#-prometheus--snmp_exporter--package_ensure)
* [`package_name`](#-prometheus--snmp_exporter--package_name)
* [`purge_config_dir`](#-prometheus--snmp_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--snmp_exporter--restart_on_change)
* [`service_enable`](#-prometheus--snmp_exporter--service_enable)
* [`service_ensure`](#-prometheus--snmp_exporter--service_ensure)
* [`service_name`](#-prometheus--snmp_exporter--service_name)
* [`user`](#-prometheus--snmp_exporter--user)
* [`version`](#-prometheus--snmp_exporter--version)
* [`proxy_server`](#-prometheus--snmp_exporter--proxy_server)
* [`proxy_type`](#-prometheus--snmp_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--snmp_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--snmp_exporter--scrape_host)
* [`scrape_port`](#-prometheus--snmp_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--snmp_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--snmp_exporter--scrape_job_labels)

##### <a name="-prometheus--snmp_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--snmp_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--snmp_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Absolute path to configuration file

Default value: `'/etc/snmp-exporter.yaml'`

##### <a name="-prometheus--snmp_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

Configuration file mode (default 0660)

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--snmp_exporter--config_template"></a>`config_template`

Data type: `String[0]`

Configuration template to use. If empty, uses upstream config (default "")

Default value: `''`

##### <a name="-prometheus--snmp_exporter--download_extension"></a>`download_extension`

Data type: `String[0]`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--snmp_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--snmp_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/snmp_exporter/releases'`

##### <a name="-prometheus--snmp_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--snmp_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--snmp_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `snmp-exporter`

##### <a name="-prometheus--snmp_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--snmp_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--snmp_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--snmp_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--snmp_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--snmp_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--snmp_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--snmp_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'snmp_exporter'`

##### <a name="-prometheus--snmp_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--snmp_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--snmp_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--snmp_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--snmp_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the snmp exporter service (default 'snmp_exporter')

Default value: `'snmp_exporter'`

##### <a name="-prometheus--snmp_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'snmp-exporter'`

##### <a name="-prometheus--snmp_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.30.1'`

##### <a name="-prometheus--snmp_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--snmp_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--snmp_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--snmp_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--snmp_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9116`

##### <a name="-prometheus--snmp_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'snmp'`

##### <a name="-prometheus--snmp_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--ssh_exporter"></a>`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`](#-prometheus--ssh_exporter--arch)
* [`bin_dir`](#-prometheus--ssh_exporter--bin_dir)
* [`config_file`](#-prometheus--ssh_exporter--config_file)
* [`config_mode`](#-prometheus--ssh_exporter--config_mode)
* [`download_extension`](#-prometheus--ssh_exporter--download_extension)
* [`download_url`](#-prometheus--ssh_exporter--download_url)
* [`download_url_base`](#-prometheus--ssh_exporter--download_url_base)
* [`extra_groups`](#-prometheus--ssh_exporter--extra_groups)
* [`extra_options`](#-prometheus--ssh_exporter--extra_options)
* [`group`](#-prometheus--ssh_exporter--group)
* [`init_style`](#-prometheus--ssh_exporter--init_style)
* [`install_method`](#-prometheus--ssh_exporter--install_method)
* [`manage_group`](#-prometheus--ssh_exporter--manage_group)
* [`manage_service`](#-prometheus--ssh_exporter--manage_service)
* [`manage_user`](#-prometheus--ssh_exporter--manage_user)
* [`modules`](#-prometheus--ssh_exporter--modules)
* [`os`](#-prometheus--ssh_exporter--os)
* [`package_ensure`](#-prometheus--ssh_exporter--package_ensure)
* [`package_name`](#-prometheus--ssh_exporter--package_name)
* [`purge_config_dir`](#-prometheus--ssh_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--ssh_exporter--restart_on_change)
* [`service_enable`](#-prometheus--ssh_exporter--service_enable)
* [`service_ensure`](#-prometheus--ssh_exporter--service_ensure)
* [`service_name`](#-prometheus--ssh_exporter--service_name)
* [`user`](#-prometheus--ssh_exporter--user)
* [`version`](#-prometheus--ssh_exporter--version)
* [`proxy_server`](#-prometheus--ssh_exporter--proxy_server)
* [`proxy_type`](#-prometheus--ssh_exporter--proxy_type)
* [`scrape_host`](#-prometheus--ssh_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--ssh_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--ssh_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--ssh_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--ssh_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--ssh_exporter--bin_name)

##### <a name="-prometheus--ssh_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--ssh_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--ssh_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Path to SSH exporter configuration file

Default value: `'/etc/ssh_exporter.yaml'`

##### <a name="-prometheus--ssh_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--ssh_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--ssh_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--ssh_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/treydock/ssh_exporter/releases'`

##### <a name="-prometheus--ssh_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--ssh_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--ssh_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'ssh-exporter'`

##### <a name="-prometheus--ssh_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--ssh_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--ssh_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ssh_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--ssh_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ssh_exporter--modules"></a>`modules`

Data type: `Hash`

Hash of SSH exporter modules

Default value: `{}`

##### <a name="-prometheus--ssh_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--ssh_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--ssh_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'ssh_exporter'`

##### <a name="-prometheus--ssh_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--ssh_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--ssh_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--ssh_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--ssh_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'ssh_exporter')

Default value: `'ssh_exporter'`

##### <a name="-prometheus--ssh_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'ssh-exporter'`

##### <a name="-prometheus--ssh_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.5.0'`

##### <a name="-prometheus--ssh_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--ssh_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--ssh_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--ssh_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--ssh_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9312`

##### <a name="-prometheus--ssh_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'ssh'`

##### <a name="-prometheus--ssh_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--ssh_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--ssl_exporter"></a>`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`](#-prometheus--ssl_exporter--arch)
* [`bin_dir`](#-prometheus--ssl_exporter--bin_dir)
* [`config_file`](#-prometheus--ssl_exporter--config_file)
* [`config_mode`](#-prometheus--ssl_exporter--config_mode)
* [`download_extension`](#-prometheus--ssl_exporter--download_extension)
* [`download_url`](#-prometheus--ssl_exporter--download_url)
* [`download_url_base`](#-prometheus--ssl_exporter--download_url_base)
* [`extra_groups`](#-prometheus--ssl_exporter--extra_groups)
* [`extra_options`](#-prometheus--ssl_exporter--extra_options)
* [`group`](#-prometheus--ssl_exporter--group)
* [`init_style`](#-prometheus--ssl_exporter--init_style)
* [`install_method`](#-prometheus--ssl_exporter--install_method)
* [`manage_group`](#-prometheus--ssl_exporter--manage_group)
* [`manage_service`](#-prometheus--ssl_exporter--manage_service)
* [`manage_user`](#-prometheus--ssl_exporter--manage_user)
* [`modules`](#-prometheus--ssl_exporter--modules)
* [`os`](#-prometheus--ssl_exporter--os)
* [`package_ensure`](#-prometheus--ssl_exporter--package_ensure)
* [`package_name`](#-prometheus--ssl_exporter--package_name)
* [`purge_config_dir`](#-prometheus--ssl_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--ssl_exporter--restart_on_change)
* [`service_enable`](#-prometheus--ssl_exporter--service_enable)
* [`service_ensure`](#-prometheus--ssl_exporter--service_ensure)
* [`service_name`](#-prometheus--ssl_exporter--service_name)
* [`user`](#-prometheus--ssl_exporter--user)
* [`version`](#-prometheus--ssl_exporter--version)
* [`proxy_server`](#-prometheus--ssl_exporter--proxy_server)
* [`proxy_type`](#-prometheus--ssl_exporter--proxy_type)
* [`scrape_host`](#-prometheus--ssl_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--ssl_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--ssl_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--ssl_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--ssl_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--ssl_exporter--bin_name)

##### <a name="-prometheus--ssl_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--ssl_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--ssl_exporter--config_file"></a>`config_file`

Data type: `Stdlib::Absolutepath`

Path to SSL exporter configuration file

Default value: `'/etc/ssl_exporter.yaml'`

##### <a name="-prometheus--ssl_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--ssl_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--ssl_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--ssl_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/ribbybibby/ssl_exporter/releases'`

##### <a name="-prometheus--ssl_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--ssl_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--ssl_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'ssl-exporter'`

##### <a name="-prometheus--ssl_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--ssl_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--ssl_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ssl_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--ssl_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--ssl_exporter--modules"></a>`modules`

Data type: `Hash`

Hash of SSL exporter modules

Default value: `{}`

##### <a name="-prometheus--ssl_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--ssl_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--ssl_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'ssl_exporter'`

##### <a name="-prometheus--ssl_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--ssl_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--ssl_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--ssl_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--ssl_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'ssk_exporter')

Default value: `'ssl_exporter'`

##### <a name="-prometheus--ssl_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'ssl-exporter'`

##### <a name="-prometheus--ssl_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'2.4.3'`

##### <a name="-prometheus--ssl_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--ssl_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--ssl_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--ssl_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--ssl_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9219`

##### <a name="-prometheus--ssl_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'ssl'`

##### <a name="-prometheus--ssl_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--ssl_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

### <a name="prometheus--statsd_exporter"></a>`prometheus::statsd_exporter`

This module manages prometheus statsd_exporter

#### Parameters

The following parameters are available in the `prometheus::statsd_exporter` class:

* [`arch`](#-prometheus--statsd_exporter--arch)
* [`bin_dir`](#-prometheus--statsd_exporter--bin_dir)
* [`config_mode`](#-prometheus--statsd_exporter--config_mode)
* [`download_extension`](#-prometheus--statsd_exporter--download_extension)
* [`download_url`](#-prometheus--statsd_exporter--download_url)
* [`download_url_base`](#-prometheus--statsd_exporter--download_url_base)
* [`extra_groups`](#-prometheus--statsd_exporter--extra_groups)
* [`extra_options`](#-prometheus--statsd_exporter--extra_options)
* [`group`](#-prometheus--statsd_exporter--group)
* [`init_style`](#-prometheus--statsd_exporter--init_style)
* [`install_method`](#-prometheus--statsd_exporter--install_method)
* [`manage_group`](#-prometheus--statsd_exporter--manage_group)
* [`manage_service`](#-prometheus--statsd_exporter--manage_service)
* [`manage_user`](#-prometheus--statsd_exporter--manage_user)
* [`manage_mappings`](#-prometheus--statsd_exporter--manage_mappings)
* [`os`](#-prometheus--statsd_exporter--os)
* [`package_ensure`](#-prometheus--statsd_exporter--package_ensure)
* [`package_name`](#-prometheus--statsd_exporter--package_name)
* [`purge_config_dir`](#-prometheus--statsd_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--statsd_exporter--restart_on_change)
* [`service_enable`](#-prometheus--statsd_exporter--service_enable)
* [`service_ensure`](#-prometheus--statsd_exporter--service_ensure)
* [`service_name`](#-prometheus--statsd_exporter--service_name)
* [`mappings`](#-prometheus--statsd_exporter--mappings)
* [`user`](#-prometheus--statsd_exporter--user)
* [`version`](#-prometheus--statsd_exporter--version)
* [`proxy_server`](#-prometheus--statsd_exporter--proxy_server)
* [`proxy_type`](#-prometheus--statsd_exporter--proxy_type)
* [`mapping_config_path`](#-prometheus--statsd_exporter--mapping_config_path)
* [`export_scrape_job`](#-prometheus--statsd_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--statsd_exporter--scrape_host)
* [`scrape_port`](#-prometheus--statsd_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--statsd_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--statsd_exporter--scrape_job_labels)

##### <a name="-prometheus--statsd_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--statsd_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--statsd_exporter--config_mode"></a>`config_mode`

Data type: `String[1]`

The permissions of the configuration files

Default value: `$prometheus::config_mode`

##### <a name="-prometheus--statsd_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--statsd_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--statsd_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus/statsd_exporter/releases'`

##### <a name="-prometheus--statsd_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--statsd_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--statsd_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'statsd-exporter'`

##### <a name="-prometheus--statsd_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--statsd_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--statsd_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--statsd_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--statsd_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--statsd_exporter--manage_mappings"></a>`manage_mappings`

Data type: `Boolean`

Whether to create mappings or rely on external code for that

Default value: `true`

##### <a name="-prometheus--statsd_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--statsd_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--statsd_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'statsd_exporter'`

##### <a name="-prometheus--statsd_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--statsd_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--statsd_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--statsd_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--statsd_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the statsd exporter service (default 'statsd_exporter')

Default value: `'statsd_exporter'`

##### <a name="-prometheus--statsd_exporter--mappings"></a>`mappings`

Data type: `Array[Hash]`

The hiera array for mappings:
  - map: 'test.dispatcher.*.*.*'
    name: 'dispatcher_events_total'
    labels:
      processor: '$2'
      action: '$1'

Default value: `[]`

##### <a name="-prometheus--statsd_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'statsd-exporter'`

##### <a name="-prometheus--statsd_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.28.0'`

##### <a name="-prometheus--statsd_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--statsd_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--statsd_exporter--mapping_config_path"></a>`mapping_config_path`

Data type: `Stdlib::Absolutepath`



Default value: `'/etc/statsd-exporter-mapping.yaml'`

##### <a name="-prometheus--statsd_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--statsd_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--statsd_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9102`

##### <a name="-prometheus--statsd_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'statsd'`

##### <a name="-prometheus--statsd_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--systemd_exporter"></a>`prometheus::systemd_exporter`

This module manages prometheus systemd_exporter

#### Parameters

The following parameters are available in the `prometheus::systemd_exporter` class:

* [`arch`](#-prometheus--systemd_exporter--arch)
* [`bin_dir`](#-prometheus--systemd_exporter--bin_dir)
* [`download_extension`](#-prometheus--systemd_exporter--download_extension)
* [`download_url`](#-prometheus--systemd_exporter--download_url)
* [`download_url_base`](#-prometheus--systemd_exporter--download_url_base)
* [`extra_groups`](#-prometheus--systemd_exporter--extra_groups)
* [`extra_options`](#-prometheus--systemd_exporter--extra_options)
* [`group`](#-prometheus--systemd_exporter--group)
* [`init_style`](#-prometheus--systemd_exporter--init_style)
* [`install_method`](#-prometheus--systemd_exporter--install_method)
* [`manage_group`](#-prometheus--systemd_exporter--manage_group)
* [`manage_service`](#-prometheus--systemd_exporter--manage_service)
* [`manage_user`](#-prometheus--systemd_exporter--manage_user)
* [`namespace`](#-prometheus--systemd_exporter--namespace)
* [`os`](#-prometheus--systemd_exporter--os)
* [`package_name`](#-prometheus--systemd_exporter--package_name)
* [`purge_config_dir`](#-prometheus--systemd_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--systemd_exporter--restart_on_change)
* [`service_enable`](#-prometheus--systemd_exporter--service_enable)
* [`service_ensure`](#-prometheus--systemd_exporter--service_ensure)
* [`service_name`](#-prometheus--systemd_exporter--service_name)
* [`user`](#-prometheus--systemd_exporter--user)
* [`version`](#-prometheus--systemd_exporter--version)
* [`export_scrape_job`](#-prometheus--systemd_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--systemd_exporter--scrape_host)
* [`scrape_port`](#-prometheus--systemd_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--systemd_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--systemd_exporter--scrape_job_labels)

##### <a name="-prometheus--systemd_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--systemd_exporter--bin_dir"></a>`bin_dir`

Data type: `String[1]`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--systemd_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--systemd_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--systemd_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/prometheus-community/systemd_exporter/releases'`

##### <a name="-prometheus--systemd_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--systemd_exporter--extra_options"></a>`extra_options`

Data type: `String`

Extra options added to the startup command
For a full list of the exporter's supported extra options
please refer to https://github.com/prometheus-community/systemd_exporter

Default value: `''`

##### <a name="-prometheus--systemd_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'systemd-exporter'`

##### <a name="-prometheus--systemd_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$facts['service_provider']`

##### <a name="-prometheus--systemd_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--systemd_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--systemd_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--systemd_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--systemd_exporter--namespace"></a>`namespace`

Data type: `String[1]`

Namespace for the metrics, defaults to `systemd`.

Default value: `'systemd'`

##### <a name="-prometheus--systemd_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--systemd_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'systemd_exporter'`

##### <a name="-prometheus--systemd_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--systemd_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--systemd_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--systemd_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--systemd_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the node exporter service (default 'systemd_exporter')

Default value: `'systemd_exporter'`

##### <a name="-prometheus--systemd_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'systemd-exporter'`

##### <a name="-prometheus--systemd_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.7.0'`

##### <a name="-prometheus--systemd_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--systemd_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--systemd_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9558`

##### <a name="-prometheus--systemd_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'systemd'`

##### <a name="-prometheus--systemd_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--unbound_exporter"></a>`prometheus::unbound_exporter`

This module manages prometheus unbound exporter.

* **Note** The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21)

* **See also**
  * https://github.com/kumina/unbound_exporter

#### Parameters

The following parameters are available in the `prometheus::unbound_exporter` class:

* [`arch`](#-prometheus--unbound_exporter--arch)
* [`bin_dir`](#-prometheus--unbound_exporter--bin_dir)
* [`download_extension`](#-prometheus--unbound_exporter--download_extension)
* [`download_url`](#-prometheus--unbound_exporter--download_url)
* [`download_url_base`](#-prometheus--unbound_exporter--download_url_base)
* [`extra_groups`](#-prometheus--unbound_exporter--extra_groups)
* [`extra_options`](#-prometheus--unbound_exporter--extra_options)
* [`group`](#-prometheus--unbound_exporter--group)
* [`init_style`](#-prometheus--unbound_exporter--init_style)
* [`install_method`](#-prometheus--unbound_exporter--install_method)
* [`manage_group`](#-prometheus--unbound_exporter--manage_group)
* [`manage_service`](#-prometheus--unbound_exporter--manage_service)
* [`manage_user`](#-prometheus--unbound_exporter--manage_user)
* [`os`](#-prometheus--unbound_exporter--os)
* [`package_ensure`](#-prometheus--unbound_exporter--package_ensure)
* [`package_name`](#-prometheus--unbound_exporter--package_name)
* [`purge_config_dir`](#-prometheus--unbound_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--unbound_exporter--restart_on_change)
* [`service_enable`](#-prometheus--unbound_exporter--service_enable)
* [`service_ensure`](#-prometheus--unbound_exporter--service_ensure)
* [`service_name`](#-prometheus--unbound_exporter--service_name)
* [`user`](#-prometheus--unbound_exporter--user)
* [`version`](#-prometheus--unbound_exporter--version)
* [`proxy_server`](#-prometheus--unbound_exporter--proxy_server)
* [`proxy_type`](#-prometheus--unbound_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--unbound_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--unbound_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--unbound_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--unbound_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--unbound_exporter--bin_name)
* [`env_vars`](#-prometheus--unbound_exporter--env_vars)

##### <a name="-prometheus--unbound_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--unbound_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `'/usr/local/bin'`

##### <a name="-prometheus--unbound_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `''`

##### <a name="-prometheus--unbound_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--unbound_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/kumina/unbound_exporter/releases'`

##### <a name="-prometheus--unbound_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `['unbound']`

##### <a name="-prometheus--unbound_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--unbound_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'unbound-exporter'`

##### <a name="-prometheus--unbound_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--unbound_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `'none'`

##### <a name="-prometheus--unbound_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--unbound_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service?

Default value: `true`

##### <a name="-prometheus--unbound_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--unbound_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--unbound_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure

Default value: `'installed'`

##### <a name="-prometheus--unbound_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'unbound_exporter'`

##### <a name="-prometheus--unbound_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--unbound_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change?

Default value: `true`

##### <a name="-prometheus--unbound_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet

Default value: `true`

##### <a name="-prometheus--unbound_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service

Default value: `'running'`

##### <a name="-prometheus--unbound_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the unbound exporter service

Default value: `'unbound_exporter'`

##### <a name="-prometheus--unbound_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'unbound-exporter'`

##### <a name="-prometheus--unbound_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'0.5.0'`

##### <a name="-prometheus--unbound_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--unbound_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--unbound_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--unbound_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9167`

##### <a name="-prometheus--unbound_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'unbound'`

##### <a name="-prometheus--unbound_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--unbound_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

##### <a name="-prometheus--unbound_exporter--env_vars"></a>`env_vars`

Data type: `Hash`



Default value: `{ 'GODEBUG' => 'x509ignoreCN=0' }`

### <a name="prometheus--varnish_exporter"></a>`prometheus::varnish_exporter`

This module manages prometheus varnish_exporter

#### Parameters

The following parameters are available in the `prometheus::varnish_exporter` class:

* [`arch`](#-prometheus--varnish_exporter--arch)
* [`bin_dir`](#-prometheus--varnish_exporter--bin_dir)
* [`download_extension`](#-prometheus--varnish_exporter--download_extension)
* [`download_url`](#-prometheus--varnish_exporter--download_url)
* [`download_url_base`](#-prometheus--varnish_exporter--download_url_base)
* [`extra_groups`](#-prometheus--varnish_exporter--extra_groups)
* [`extra_options`](#-prometheus--varnish_exporter--extra_options)
* [`group`](#-prometheus--varnish_exporter--group)
* [`init_style`](#-prometheus--varnish_exporter--init_style)
* [`install_method`](#-prometheus--varnish_exporter--install_method)
* [`manage_group`](#-prometheus--varnish_exporter--manage_group)
* [`manage_service`](#-prometheus--varnish_exporter--manage_service)
* [`manage_user`](#-prometheus--varnish_exporter--manage_user)
* [`os`](#-prometheus--varnish_exporter--os)
* [`package_ensure`](#-prometheus--varnish_exporter--package_ensure)
* [`package_name`](#-prometheus--varnish_exporter--package_name)
* [`purge_config_dir`](#-prometheus--varnish_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--varnish_exporter--restart_on_change)
* [`service_enable`](#-prometheus--varnish_exporter--service_enable)
* [`service_ensure`](#-prometheus--varnish_exporter--service_ensure)
* [`service_name`](#-prometheus--varnish_exporter--service_name)
* [`user`](#-prometheus--varnish_exporter--user)
* [`version`](#-prometheus--varnish_exporter--version)
* [`proxy_server`](#-prometheus--varnish_exporter--proxy_server)
* [`proxy_type`](#-prometheus--varnish_exporter--proxy_type)
* [`export_scrape_job`](#-prometheus--varnish_exporter--export_scrape_job)
* [`scrape_host`](#-prometheus--varnish_exporter--scrape_host)
* [`scrape_port`](#-prometheus--varnish_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--varnish_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--varnish_exporter--scrape_job_labels)

##### <a name="-prometheus--varnish_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--varnish_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--varnish_exporter--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `'tar.gz'`

##### <a name="-prometheus--varnish_exporter--download_url"></a>`download_url`

Data type: `Optional[Prometheus::Uri]`

Complete URL corresponding to the where the release binary archive can be downloaded

Default value: `undef`

##### <a name="-prometheus--varnish_exporter--download_url_base"></a>`download_url_base`

Data type: `Prometheus::Uri`

Base URL for the binary archive

Default value: `'https://github.com/jonnenauha/prometheus_varnish_exporter/releases'`

##### <a name="-prometheus--varnish_exporter--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--varnish_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--varnish_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'varnish'`

##### <a name="-prometheus--varnish_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `$prometheus::init_style`

##### <a name="-prometheus--varnish_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `$prometheus::install_method`

##### <a name="-prometheus--varnish_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--varnish_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--varnish_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--varnish_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--varnish_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'latest'`

##### <a name="-prometheus--varnish_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'prometheus_varnish_exporter'`

##### <a name="-prometheus--varnish_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--varnish_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change? (default true)

Default value: `true`

##### <a name="-prometheus--varnish_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--varnish_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--varnish_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the varnish exporter service (default 'varnish_exporter')

Default value: `'prometheus_varnish_exporter'`

##### <a name="-prometheus--varnish_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'varnish_exporter'`

##### <a name="-prometheus--varnish_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'1.6.1'`

##### <a name="-prometheus--varnish_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--varnish_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--varnish_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--varnish_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--varnish_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9131`

##### <a name="-prometheus--varnish_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'varnish'`

##### <a name="-prometheus--varnish_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

### <a name="prometheus--wireguard_exporter"></a>`prometheus::wireguard_exporter`

This module manages prometheus wireguard_exporter

#### Parameters

The following parameters are available in the `prometheus::wireguard_exporter` class:

* [`arch`](#-prometheus--wireguard_exporter--arch)
* [`bin_dir`](#-prometheus--wireguard_exporter--bin_dir)
* [`extra_groups`](#-prometheus--wireguard_exporter--extra_groups)
* [`extra_options`](#-prometheus--wireguard_exporter--extra_options)
* [`group`](#-prometheus--wireguard_exporter--group)
* [`init_style`](#-prometheus--wireguard_exporter--init_style)
* [`install_method`](#-prometheus--wireguard_exporter--install_method)
* [`manage_group`](#-prometheus--wireguard_exporter--manage_group)
* [`manage_service`](#-prometheus--wireguard_exporter--manage_service)
* [`manage_user`](#-prometheus--wireguard_exporter--manage_user)
* [`os`](#-prometheus--wireguard_exporter--os)
* [`package_ensure`](#-prometheus--wireguard_exporter--package_ensure)
* [`package_name`](#-prometheus--wireguard_exporter--package_name)
* [`purge_config_dir`](#-prometheus--wireguard_exporter--purge_config_dir)
* [`restart_on_change`](#-prometheus--wireguard_exporter--restart_on_change)
* [`service_enable`](#-prometheus--wireguard_exporter--service_enable)
* [`service_ensure`](#-prometheus--wireguard_exporter--service_ensure)
* [`service_name`](#-prometheus--wireguard_exporter--service_name)
* [`user`](#-prometheus--wireguard_exporter--user)
* [`version`](#-prometheus--wireguard_exporter--version)
* [`env_vars`](#-prometheus--wireguard_exporter--env_vars)
* [`env_file_path`](#-prometheus--wireguard_exporter--env_file_path)
* [`proxy_server`](#-prometheus--wireguard_exporter--proxy_server)
* [`proxy_type`](#-prometheus--wireguard_exporter--proxy_type)
* [`download_url`](#-prometheus--wireguard_exporter--download_url)
* [`scrape_host`](#-prometheus--wireguard_exporter--scrape_host)
* [`export_scrape_job`](#-prometheus--wireguard_exporter--export_scrape_job)
* [`scrape_port`](#-prometheus--wireguard_exporter--scrape_port)
* [`scrape_job_name`](#-prometheus--wireguard_exporter--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--wireguard_exporter--scrape_job_labels)
* [`bin_name`](#-prometheus--wireguard_exporter--bin_name)
* [`use_tls_server_config`](#-prometheus--wireguard_exporter--use_tls_server_config)
* [`tls_cert_file`](#-prometheus--wireguard_exporter--tls_cert_file)
* [`tls_key_file`](#-prometheus--wireguard_exporter--tls_key_file)
* [`tls_client_ca_file`](#-prometheus--wireguard_exporter--tls_client_ca_file)
* [`tls_client_auth_type`](#-prometheus--wireguard_exporter--tls_client_auth_type)
* [`web_config_file`](#-prometheus--wireguard_exporter--web_config_file)
* [`tls_min_version`](#-prometheus--wireguard_exporter--tls_min_version)
* [`tls_max_version`](#-prometheus--wireguard_exporter--tls_max_version)
* [`tls_cipher_suites`](#-prometheus--wireguard_exporter--tls_cipher_suites)
* [`tls_curve_preferences`](#-prometheus--wireguard_exporter--tls_curve_preferences)
* [`tls_prefer_server_cipher_suites`](#-prometheus--wireguard_exporter--tls_prefer_server_cipher_suites)
* [`use_http_server_config`](#-prometheus--wireguard_exporter--use_http_server_config)
* [`http2`](#-prometheus--wireguard_exporter--http2)
* [`http2_headers`](#-prometheus--wireguard_exporter--http2_headers)
* [`basic_auth_users`](#-prometheus--wireguard_exporter--basic_auth_users)

##### <a name="-prometheus--wireguard_exporter--arch"></a>`arch`

Data type: `String[1]`

Architecture

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--wireguard_exporter--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--wireguard_exporter--extra_groups"></a>`extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `[]`

##### <a name="-prometheus--wireguard_exporter--extra_options"></a>`extra_options`

Data type: `Optional[String[1]]`

Extra options added to the startup command

Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--group"></a>`group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'wireguard_exporter'`

##### <a name="-prometheus--wireguard_exporter--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd)

Default value: `'none'`

##### <a name="-prometheus--wireguard_exporter--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package (only url is supported currently)

Default value: `'package'`

##### <a name="-prometheus--wireguard_exporter--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `false`

##### <a name="-prometheus--wireguard_exporter--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service?

Default value: `true`

##### <a name="-prometheus--wireguard_exporter--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `false`

##### <a name="-prometheus--wireguard_exporter--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `downcase($facts['kernel'])`

##### <a name="-prometheus--wireguard_exporter--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'latest'

Default value: `'installed'`

##### <a name="-prometheus--wireguard_exporter--package_name"></a>`package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'prometheus-wireguard-exporter'`

##### <a name="-prometheus--wireguard_exporter--purge_config_dir"></a>`purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: `true`

##### <a name="-prometheus--wireguard_exporter--restart_on_change"></a>`restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change?

Default value: `true`

##### <a name="-prometheus--wireguard_exporter--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet

Default value: `true`

##### <a name="-prometheus--wireguard_exporter--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service

Default value: `'running'`

##### <a name="-prometheus--wireguard_exporter--service_name"></a>`service_name`

Data type: `String[1]`

Name of the wireguard exporter service

Default value: `'prometheus-wireguard-exporter'`

##### <a name="-prometheus--wireguard_exporter--user"></a>`user`

Data type: `String[1]`

User which runs the service

Default value: `'wireguard_exporter'`

##### <a name="-prometheus--wireguard_exporter--version"></a>`version`

Data type: `String[1]`

The binary release version

Default value: `'3.6.6'`

##### <a name="-prometheus--wireguard_exporter--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`

hash with custom environment variables thats passed to the exporter via init script / unit file

Default value: `{}`

##### <a name="-prometheus--wireguard_exporter--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`

The path to the file with the environmetn variable that is read from the init script/systemd unit

Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--wireguard_exporter--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--download_url"></a>`download_url`

Data type: `Prometheus::Uri`



Default value: `'https://github.com/MindFlavor/prometheus_wireguard_exporter/releases/tag/3.6.6'`

##### <a name="-prometheus--wireguard_exporter--scrape_host"></a>`scrape_host`

Data type: `Optional[Stdlib::Host]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--wireguard_exporter--scrape_port"></a>`scrape_port`

Data type: `Stdlib::Port`



Default value: `9586`

##### <a name="-prometheus--wireguard_exporter--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `'wireguard'`

##### <a name="-prometheus--wireguard_exporter--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--bin_name"></a>`bin_name`

Data type: `Optional[String[1]]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--use_tls_server_config"></a>`use_tls_server_config`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--wireguard_exporter--tls_cert_file"></a>`tls_cert_file`

Data type: `Optional[Stdlib::Absolutepath]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--tls_key_file"></a>`tls_key_file`

Data type: `Optional[Stdlib::Absolutepath]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--tls_client_ca_file"></a>`tls_client_ca_file`

Data type: `Optional[Stdlib::Absolutepath]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--tls_client_auth_type"></a>`tls_client_auth_type`

Data type: `String[1]`



Default value: `'RequireAndVerifyClientCert'`

##### <a name="-prometheus--wireguard_exporter--web_config_file"></a>`web_config_file`

Data type: `Stdlib::Absolutepath`



Default value: `'/etc/wireguard_exporter_web-config.yml'`

##### <a name="-prometheus--wireguard_exporter--tls_min_version"></a>`tls_min_version`

Data type: `String[1]`



Default value: `'TLS12'`

##### <a name="-prometheus--wireguard_exporter--tls_max_version"></a>`tls_max_version`

Data type: `String[1]`



Default value: `'TLS13'`

##### <a name="-prometheus--wireguard_exporter--tls_cipher_suites"></a>`tls_cipher_suites`

Data type: `Optional[Array[String[1]]]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--tls_curve_preferences"></a>`tls_curve_preferences`

Data type: `Optional[Array[String[1]]]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--tls_prefer_server_cipher_suites"></a>`tls_prefer_server_cipher_suites`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--wireguard_exporter--use_http_server_config"></a>`use_http_server_config`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--wireguard_exporter--http2"></a>`http2`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--wireguard_exporter--http2_headers"></a>`http2_headers`

Data type: `Optional[Hash]`



Default value: `undef`

##### <a name="-prometheus--wireguard_exporter--basic_auth_users"></a>`basic_auth_users`

Data type: `Optional[Hash]`



Default value: `undef`

## Defined types

### <a name="prometheus--alerts"></a>`prometheus::alerts`

This module manages prometheus alert files for prometheus

#### Parameters

The following parameters are available in the `prometheus::alerts` defined type:

* [`alerts`](#-prometheus--alerts--alerts)
* [`location`](#-prometheus--alerts--location)
* [`version`](#-prometheus--alerts--version)
* [`user`](#-prometheus--alerts--user)
* [`group`](#-prometheus--alerts--group)
* [`bin_dir`](#-prometheus--alerts--bin_dir)

##### <a name="-prometheus--alerts--alerts"></a>`alerts`

Data type: `Hash`

alert definitions

##### <a name="-prometheus--alerts--location"></a>`location`

Data type: `String[1]`

Where to create the alert file for prometheus

Default value: `"${prometheus::config_dir}/rules"`

##### <a name="-prometheus--alerts--version"></a>`version`

Data type: `String[1]`



Default value: `$prometheus::version`

##### <a name="-prometheus--alerts--user"></a>`user`

Data type: `String[1]`



Default value: `$prometheus::user`

##### <a name="-prometheus--alerts--group"></a>`group`

Data type: `String[1]`



Default value: `$prometheus::group`

##### <a name="-prometheus--alerts--bin_dir"></a>`bin_dir`

Data type: `String[1]`



Default value: `$prometheus::bin_dir`

### <a name="prometheus--daemon"></a>`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`](#-prometheus--daemon--version)
* [`real_download_url`](#-prometheus--daemon--real_download_url)
* [`notify_service`](#-prometheus--daemon--notify_service)
* [`user`](#-prometheus--daemon--user)
* [`install_method`](#-prometheus--daemon--install_method)
* [`download_extension`](#-prometheus--daemon--download_extension)
* [`os`](#-prometheus--daemon--os)
* [`arch`](#-prometheus--daemon--arch)
* [`bin_dir`](#-prometheus--daemon--bin_dir)
* [`bin_name`](#-prometheus--daemon--bin_name)
* [`package_name`](#-prometheus--daemon--package_name)
* [`package_ensure`](#-prometheus--daemon--package_ensure)
* [`manage_user`](#-prometheus--daemon--manage_user)
* [`extra_groups`](#-prometheus--daemon--extra_groups)
* [`manage_group`](#-prometheus--daemon--manage_group)
* [`service_ensure`](#-prometheus--daemon--service_ensure)
* [`service_enable`](#-prometheus--daemon--service_enable)
* [`manage_service`](#-prometheus--daemon--manage_service)
* [`extract_command`](#-prometheus--daemon--extract_command)
* [`extract_path`](#-prometheus--daemon--extract_path)
* [`archive_bin_path`](#-prometheus--daemon--archive_bin_path)
* [`init_style`](#-prometheus--daemon--init_style)
* [`proxy_server`](#-prometheus--daemon--proxy_server)
* [`proxy_type`](#-prometheus--daemon--proxy_type)
* [`ensure`](#-prometheus--daemon--ensure)
* [`group`](#-prometheus--daemon--group)
* [`manage_bin_link`](#-prometheus--daemon--manage_bin_link)
* [`purge`](#-prometheus--daemon--purge)
* [`options`](#-prometheus--daemon--options)
* [`env_vars`](#-prometheus--daemon--env_vars)
* [`env_file_path`](#-prometheus--daemon--env_file_path)
* [`export_scrape_job`](#-prometheus--daemon--export_scrape_job)
* [`scrape_host`](#-prometheus--daemon--scrape_host)
* [`scrape_port`](#-prometheus--daemon--scrape_port)
* [`scrape_job_name`](#-prometheus--daemon--scrape_job_name)
* [`scrape_job_labels`](#-prometheus--daemon--scrape_job_labels)
* [`usershell`](#-prometheus--daemon--usershell)

##### <a name="-prometheus--daemon--version"></a>`version`

Data type: `String[1]`

The binary release version

##### <a name="-prometheus--daemon--real_download_url"></a>`real_download_url`

Data type: `Prometheus::Uri`

Complete URL corresponding to the where the release binary archive can be downloaded

##### <a name="-prometheus--daemon--notify_service"></a>`notify_service`

Data type: `Variant[Type[Exec],Type[Service],Undef]`

The service to notify when something changes in this define

##### <a name="-prometheus--daemon--user"></a>`user`

Data type: `String[1]`

User which runs the service

##### <a name="-prometheus--daemon--install_method"></a>`install_method`

Data type: `Prometheus::Install`

Installation method: url or package

Default value: `$prometheus::install_method`

##### <a name="-prometheus--daemon--download_extension"></a>`download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `$prometheus::download_extension`

##### <a name="-prometheus--daemon--os"></a>`os`

Data type: `String[1]`

Operating system (linux is the only one supported)

Default value: `$prometheus::os`

##### <a name="-prometheus--daemon--arch"></a>`arch`

Data type: `String[1]`

Architecture (amd64 or i386)

Default value: `$prometheus::real_arch`

##### <a name="-prometheus--daemon--bin_dir"></a>`bin_dir`

Data type: `Stdlib::Absolutepath`

Directory where binaries are located

Default value: `$prometheus::bin_dir`

##### <a name="-prometheus--daemon--bin_name"></a>`bin_name`

Data type: `String[1]`

The name of the binary to execute

Default value: `$name`

##### <a name="-prometheus--daemon--package_name"></a>`package_name`

Data type: `Optional[String]`

The binary package name

Default value: `undef`

##### <a name="-prometheus--daemon--package_ensure"></a>`package_ensure`

Data type: `String[1]`

If package, then use this for package ensure default 'installed'

Default value: `'installed'`

##### <a name="-prometheus--daemon--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: `true`

##### <a name="-prometheus--daemon--extra_groups"></a>`extra_groups`

Data type: `Array`

Extra groups of which the user should be a part

Default value: `[]`

##### <a name="-prometheus--daemon--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to create a group for or rely on external code for that

Default value: `true`

##### <a name="-prometheus--daemon--service_ensure"></a>`service_ensure`

Data type: `Stdlib::Ensure::Service`

State ensured for the service (default 'running')

Default value: `'running'`

##### <a name="-prometheus--daemon--service_enable"></a>`service_enable`

Data type: `Boolean`

Whether to enable the service from puppet (default true)

Default value: `true`

##### <a name="-prometheus--daemon--manage_service"></a>`manage_service`

Data type: `Boolean`

Should puppet manage the service? (default true)

Default value: `true`

##### <a name="-prometheus--daemon--extract_command"></a>`extract_command`

Data type: `Optional[String[1]]`

Custom command passed to the archive resource to extract the downloaded archive.

Default value: `$prometheus::extract_command`

##### <a name="-prometheus--daemon--extract_path"></a>`extract_path`

Data type: `Stdlib::Absolutepath`

Path where to find extracted binary

Default value: `'/opt'`

##### <a name="-prometheus--daemon--archive_bin_path"></a>`archive_bin_path`

Data type: `Stdlib::Absolutepath`

Path to the binary in the downloaded archive.

Default value: `"/opt/${name}-${version}.${os}-${arch}/${name}"`

##### <a name="-prometheus--daemon--init_style"></a>`init_style`

Data type: `Prometheus::Initstyle`

Service startup scripts style (e.g. rc or systemd).
Can also be set to `none` when you don't want the class to create a startup script/unit_file for you.
Typically this can be used when a package is already providing the file.

Default value: `$prometheus::init_style`

##### <a name="-prometheus--daemon--proxy_server"></a>`proxy_server`

Data type: `Optional[String[1]]`

Optional proxy server, with port number if needed. ie: https://example.com:8080

Default value: `undef`

##### <a name="-prometheus--daemon--proxy_type"></a>`proxy_type`

Data type: `Optional[Enum['none', 'http', 'https', 'ftp']]`

Optional proxy server type (none|http|https|ftp)

Default value: `undef`

##### <a name="-prometheus--daemon--ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Whether to install or remove the instance

Default value: `'present'`

##### <a name="-prometheus--daemon--group"></a>`group`

Data type: `String[1]`



##### <a name="-prometheus--daemon--manage_bin_link"></a>`manage_bin_link`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--daemon--purge"></a>`purge`

Data type: `Boolean`



Default value: `true`

##### <a name="-prometheus--daemon--options"></a>`options`

Data type: `String`



Default value: `''`

##### <a name="-prometheus--daemon--env_vars"></a>`env_vars`

Data type: `Hash[String[1], Scalar]`



Default value: `{}`

##### <a name="-prometheus--daemon--env_file_path"></a>`env_file_path`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::env_file_path`

##### <a name="-prometheus--daemon--export_scrape_job"></a>`export_scrape_job`

Data type: `Boolean`



Default value: `false`

##### <a name="-prometheus--daemon--scrape_host"></a>`scrape_host`

Data type: `Stdlib::Host`



Default value: `$facts['networking']['fqdn']`

##### <a name="-prometheus--daemon--scrape_port"></a>`scrape_port`

Data type: `Optional[Stdlib::Port]`



Default value: `undef`

##### <a name="-prometheus--daemon--scrape_job_name"></a>`scrape_job_name`

Data type: `String[1]`



Default value: `$name`

##### <a name="-prometheus--daemon--scrape_job_labels"></a>`scrape_job_labels`

Data type: `Hash`



Default value: `{ 'alias' => $scrape_host }`

##### <a name="-prometheus--daemon--usershell"></a>`usershell`

Data type: `Stdlib::Absolutepath`



Default value: `$prometheus::usershell`

### <a name="prometheus--scrape_job"></a>`prometheus::scrape_job`

This module manages prometheus scrape jobs.

* **Note** This define is used to export prometheus scrape settings from nodes to be scraped to the node
running prometheus itself.
This can be used to make prometheus find instances of your running service or application.

#### Parameters

The following parameters are available in the `prometheus::scrape_job` defined type:

* [`job_name`](#-prometheus--scrape_job--job_name)
* [`targets`](#-prometheus--scrape_job--targets)
* [`labels`](#-prometheus--scrape_job--labels)
* [`collect_dir`](#-prometheus--scrape_job--collect_dir)
* [`ensure`](#-prometheus--scrape_job--ensure)

##### <a name="-prometheus--scrape_job--job_name"></a>`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.

##### <a name="-prometheus--scrape_job--targets"></a>`targets`

Data type: `Array[String[1]]`

Array of hosts and ports in the form "host:port"

##### <a name="-prometheus--scrape_job--labels"></a>`labels`

Data type: `Hash[String[1], String[1]]`

Labels added to the scraped metrics on the prometheus side, as label:values pairs

Default value: `{}`

##### <a name="-prometheus--scrape_job--collect_dir"></a>`collect_dir`

Data type: `Stdlib::Absolutepath`

Directory used for collecting scrape definitions.
NOTE: this is a prometheus setting and will be overridden during collection.

Default value: `undef`

##### <a name="-prometheus--scrape_job--ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Whether the scrape job should be present or absent.

Default value: `'present'`

## Data types

### <a name="Prometheus--GsUri"></a>`Prometheus::GsUri`

Type for a Google Cloud Storage URI

Alias of `Pattern[/^gs:\/\//]`

### <a name="Prometheus--Initstyle"></a>`Prometheus::Initstyle`

A type to represent the init style of a Prometheus service

Alias of `Enum['sysv', 'systemd', 'sles', 'launchd', 'none']`

### <a name="Prometheus--Install"></a>`Prometheus::Install`

type to enforce the different installation methods for our exporters.

Alias of `Enum['url', 'package', 'none']`

### <a name="Prometheus--S3Uri"></a>`Prometheus::S3Uri`

Type for S3 URIs

Alias of `Pattern[/^s3:\/\//]`

### <a name="Prometheus--Uri"></a>`Prometheus::Uri`

A URI that can be used to fetch a Prometheus configuration file

Alias of `Variant[Stdlib::Filesource, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Prometheus::S3Uri, Prometheus::GsUri]`

### <a name="Prometheus--Web_config"></a>`Prometheus::Web_config`

webconfig for the exporter

* **See also**
  * https://github.com/prometheus/exporter-toolkit/blob/v0.10.0/docs/web-configuration.md

Alias of

```puppet
Struct[{
  Optional[tls_server_config] => Prometheus::Web_config::Tls_server_config,
  Optional[http_server_config] => Prometheus::Web_config::Http_server_config,
  Optional[basic_auth_users] => Hash[String[1],String[1],1],
}]
```

### <a name="Prometheus--Web_config--Http_server_config"></a>`Prometheus::Web_config::Http_server_config`

http_server_config of a exporter webconfig

* **See also**
  * https://github.com/prometheus/exporter-toolkit/blob/v0.10.0/docs/web-configuration.md

Alias of

```puppet
Struct[{
  Optional[http2] => Boolean,
  Optional[headers] => Struct[{
    Optional['Content-Security-Policy'] => String[1],
    Optional['X-Frame-Options'] => String[1],
    Optional['X-Content-Type-Options'] => String[1],
    Optional['X-XSS-Protection'] => String[1],
    Optional['Strict-Transport-Security'] => String[1],
  }]
}]
```

### <a name="Prometheus--Web_config--Tls_server_config"></a>`Prometheus::Web_config::Tls_server_config`

tls_server_config of a exporter webconfig

* **See also**
  * https://github.com/prometheus/exporter-toolkit/blob/v0.10.0/docs/web-configuration.md

Alias of

```puppet
Struct[{
  cert_file => Stdlib::Absolutepath,
  key_file => Stdlib::Absolutepath,
  Optional[client_ca_file] => Stdlib::Absolutepath,
  Optional[client_auth_type] => String[1],
  Optional[client_allowed_sans] => Array[String[1],1],
  Optional[min_version] => String[1],
  Optional[max_version] => String[1],
  Optional[cipher_suites] => Array[String[1],1],
  Optional[prefer_server_cipher_suites] => Boolean,
  Optional[curve_preferences] => Array[String[1],1],
}]
```