prometheus.prometheus.nvme_exporter role – Prometheus NVMe Exporter

Note

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

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.nvme_exporter.

Entry point main – Prometheus NVMe Exporter

Synopsis

Parameters

Parameter

Comments

nvme_exporter_binary_install_dir

string

Advanced

Directory to install nvme_exporter binary

Default: "/usr/local/bin"

nvme_exporter_binary_url

string

URL of the NVMe exporter binaries .tar.gz file

Default: "https://github.com/{{ _nvme_exporter_repo }}/releases/download/v{{ nvme_exporter_version }}/nvme_exporter_{{ nvme_exporter_version }}_{{ ansible_facts['system'] | lower }}_{{ _nvme_exporter_go_ansible_arch }}.tar.gz"

nvme_exporter_checksums_url

string

URL of the NVMe exporter checksums file

Default: "https://github.com/{{ _nvme_exporter_repo }}/releases/download/v{{ nvme_exporter_version }}/checksums.txt"

nvme_exporter_config_dir

string

Path to directory with nvme_exporter configuration

Default: "/etc/nvme_exporter"

nvme_exporter_disable_defaults

boolean

Disable all default collectors. Only the collectors listed in nvme_exporter_enabled_collectors will be enabled.

Choices:

  • false ← (default)

  • true

nvme_exporter_disabled_collectors

list / elements=string

List of collectors to disable explicitly (for example ocp).

Default: []

nvme_exporter_enabled_collectors

list / elements=string

List of collectors to enable explicitly (for example info, smart, ocp).

Mostly useful in combination with nvme_exporter_disable_defaults.

Default: []

nvme_exporter_local_cache_path

string

Local path to stash the archive and its extraction

Default: "/tmp/nvme_exporter-{{ ansible_facts['system'] | lower }}-{{ _nvme_exporter_go_ansible_arch }}/{{ nvme_exporter_version }}"

nvme_exporter_system_group

string

Advanced

System group for NVMe exporter

Default: "nvme-exp"

nvme_exporter_system_user

string

Advanced

NVMe exporter user

Default: "nvme-exp"

nvme_exporter_version

string

NVMe exporter package version. Also accepts latest as parameter.

Default: "3.0.0"

nvme_exporter_web_listen_address

string

Address on which NVMe exporter will listen

Default: "0.0.0.0:9998"

nvme_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community