Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement unbound_exporter #498

Merged
merged 1 commit into from
Feb 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
258 changes: 255 additions & 3 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The package method needs specific yum or apt repo settings which are not made ye
* [`prometheus::server`](#prometheusserver): class to manage the actual prometheus server. This class gets called from the init.pp
* [`prometheus::snmp_exporter`](#prometheussnmp_exporter): This module manages prometheus snmp_exporter
* [`prometheus::statsd_exporter`](#prometheusstatsd_exporter): This module manages prometheus statsd_exporter
* [`prometheus::unbound_exporter`](#prometheusunbound_exporter): This module manages prometheus unbound exporter. The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21)
* [`prometheus::varnish_exporter`](#prometheusvarnish_exporter): This module manages prometheus varnish_exporter

#### Private Classes
Expand Down Expand Up @@ -72,7 +73,7 @@ This can be used to make prometheus find instances of your running service or ap

### `prometheus`

This module manages prometheus.
This module manages prometheus

#### Parameters

Expand Down Expand Up @@ -1674,6 +1675,14 @@ The binary release version

Default value: `'1.2.4'`

##### `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: `{}`

##### `export_scrape_job`

Data type: `Boolean`
Expand Down Expand Up @@ -7918,6 +7927,249 @@ Data type: `Optional[Hash]`

Default value: ``undef``

### `prometheus::unbound_exporter`

This module manages prometheus unbound exporter. The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21)

* **See also**
* https://github.com/kumina/unbound_exporter

#### Parameters

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

##### `arch`

Data type: `String[1]`

Architecture

Default value: `$prometheus::real_arch`

##### `bin_dir`

Data type: `String[1]`

Directory where binaries are located

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

##### `download_extension`

Data type: `String`

Extension for the release binary archive

Default value: `''`

##### `download_url`

Data type: `Optional[String]`

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

Default value: ``undef``

##### `download_url_base`

Data type: `String[1]`

Base URL for the binary archive

Default value: `'https://github.com/kumina/unbound_exporter/releases'`

##### `extra_groups`

Data type: `Array[String]`

Extra groups to add the binary user to

Default value: `['unbound']`

##### `extra_options`

Data type: `String`

Extra options added to the startup command

Default value: `''`

##### `group`

Data type: `String[1]`

Group under which the binary is running

Default value: `'unbound-exporter'`

##### `init_style`

Data type: `Prometheus::Initstyle`

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

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

##### `install_method`

Data type: `String[1]`

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

Default value: `'none'`

##### `manage_group`

Data type: `Boolean`

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

Default value: ``true``

##### `manage_service`

Data type: `Boolean`

Should puppet manage the service?

Default value: ``true``

##### `manage_user`

Data type: `Boolean`

Whether to create user or rely on external code for that

Default value: ``true``

##### `os`

Data type: `String[1]`

Operating system (linux is the only one supported)

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

##### `package_ensure`

Data type: `String[1]`

If package, then use this for package ensure

Default value: `'installed'`

##### `package_name`

Data type: `String[1]`

The binary package name - not available yet

Default value: `'unbound_exporter'`

##### `purge_config_dir`

Data type: `Boolean`

Purge config files no longer generated by Puppet

Default value: ``true``

##### `restart_on_change`

Data type: `Boolean`

Should puppet restart the service on configuration change?

Default value: ``true``

##### `service_enable`

Data type: `Boolean`

Whether to enable the service from puppet

Default value: ``true``

##### `service_ensure`

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

State ensured for the service

Default value: `'running'`

##### `service_name`

Data type: `String[1]`

Name of the unbound exporter service

Default value: `'unbound_exporter'`

##### `user`

Data type: `String[1]`

User which runs the service

Default value: `'unbound-exporter'`

##### `version`

Data type: `String[1]`

The binary release version

Default value: `'0.3'`

##### `export_scrape_job`

Data type: `Boolean`



Default value: ``false``

##### `scrape_port`

Data type: `Stdlib::Port`



Default value: `9167`

##### `scrape_job_name`

Data type: `String[1]`



Default value: `'unbound'`

##### `scrape_job_labels`

Data type: `Optional[Hash]`



Default value: ``undef``

##### `bin_name`

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



Default value: ``undef``

##### `env_vars`

Data type: `Hash`



Default value: `{ 'GODEBUG' => 'x509ignoreCN=0' }`

### `prometheus::varnish_exporter`

This module manages prometheus varnish_exporter
Expand Down Expand Up @@ -8390,7 +8642,7 @@ Default value: `''`

##### `env_vars`

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



Expand Down Expand Up @@ -8504,7 +8756,7 @@ Alias of `Pattern[/^gs:\/\//]`

The Prometheus::Initstyle data type.

Alias of `Enum['sysv', 'redhat', 'systemd', 'sles', 'debian', 'launchd', 'upstart', 'none']`
Alias of `Enum['sysv', 'systemd', 'sles', 'launchd', 'upstart', 'none']`

### `Prometheus::Install`

Expand Down
Loading