prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter

Note

This role is part of the prometheus.prometheus collection (version 0.8.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install prometheus.prometheus.

To use it in a playbook, specify: prometheus.prometheus.smartctl_exporter.

Entry point main – Prometheus Smartctl Exporter

Synopsis

Parameters

Parameter

Comments

smartctl_exporter_basic_auth_users

dictionary

Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

smartctl_exporter_binary_install_dir

string

Advanced

Directory to install smartctl_exporter binary

Default: "/usr/local/bin"

smartctl_exporter_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the smartctl_exporter binary is stored on the host where ansible is run.

This overrides the smartctl_exporter_version parameter

smartctl_exporter_binary_url

string

URL of the Smartctl exporter binaries .tar.gz file

Default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{ go_arch }}.tar.gz"

smartctl_exporter_checksums_url

string

URL of the Smartctl exporter checksums file

Default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/sha256sums.txt"

smartctl_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in smartctl_exporter docs.

smartctl_exporter_log_format

string

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

Default: "logfmt"

smartctl_exporter_log_level

string

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

Default: "info"

smartctl_exporter_skip_install

boolean

Smartctl exporter installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

smartctl_exporter_smartctl_device_exclude

string

Regexp of devices to exclude from automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_include)

Default: ""

smartctl_exporter_smartctl_device_include

string

Regexp of devices to include in automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_exclude)

Default: ""

smartctl_exporter_smartctl_devices

list / elements=string

List of devices to be monitored by smartctl_exporter. Disables auto scan for available devices.

smartctl_exporter_smartctl_interval

string

The interval between smartctl polls

Default: "60s"

smartctl_exporter_smartctl_path

string

Advanced

The path to the smartctl binary

Default: "/usr/sbin/smartctl"

smartctl_exporter_smartctl_rescan

string

The interval between rescanning for new/disappeared devices.

If the interval is smaller than 1s norescanning takes place.

If any devices are configured with smartctl_exporter_smartctl_device also no rescanning takes place.

Default: "10m"

smartctl_exporter_system_group

string

Advanced

System group for Smartctl exporter

Default: "smartctl-exp"

smartctl_exporter_system_user

string

Advanced

Smartctl exporter user

Default: "smartctl-exp"

smartctl_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in smartctl_exporter docs.

smartctl_exporter_version

string

Smartctl exporter package version. Also accepts latest as parameter.

Default: "0.11.0"

smartctl_exporter_web_listen_address

string

Address on which smartctl exporter will listen

Default: "0.0.0.0:9633"

smartctl_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community