prometheus.prometheus.pgbackrest_exporter role – Prometheus pgbackrest Exporter

Note

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

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

Entry point main – Prometheus pgbackrest Exporter

Synopsis

Parameters

Parameter

Comments

pgbackrest_exporter_backrest_backrest_config_include_path

string

Path to include additional pgBackRest configuration files.

pgbackrest_exporter_backrest_backup_type

string

Filter backups by type. Can be specified several times.

Choices:

  • "full" ← (default)

  • "diff"

  • "incr"

pgbackrest_exporter_backrest_config

string

Full path to pgBackRest configuration file.

Default: "/etc/pgbackrest/pgbackrest.conf"

pgbackrest_exporter_backrest_database_count

boolean

Exposing the number of databases in backups.

Choices:

  • false ← (default)

  • true

pgbackrest_exporter_backrest_database_count_latest

boolean

Exposing the number of databases in the latest backups.

Choices:

  • false ← (default)

  • true

pgbackrest_exporter_backrest_database_parrallel_processes

string

Number of parallel processes for collecting information about databases.

Default: 1

pgbackrest_exporter_backrest_reference_count

boolean

Exposing the number of references to other backups (backup reference list).

Choices:

  • false ← (default)

  • true

pgbackrest_exporter_backrest_stanza_exclude

string

Specific stanza to exclude from collecting metrics. Can be specified several times.

pgbackrest_exporter_backrest_stanza_include

string

Specific stanza for collecting metrics. Can be specified several times.

pgbackrest_exporter_backrest_verbose_wal

boolean

Exposing additional labels for WAL metrics.

Choices:

  • false ← (default)

  • true

pgbackrest_exporter_basic_auth_users

dictionary

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

pgbackrest_exporter_binary_install_dir

string

Advanced

Directory to install binaries

Default: "/usr/local/bin"

pgbackrest_exporter_binary_url

string

URL of the pgbackrest_exporter binaries .tar.gz file

Default: "https://github.com/{{ _pgbackrest_exporter_repo }}/releases/download/v{{ pgbackrest_exporter_version }}/pgbackrest_exporter-{{ pgbackrest_exporter_version }}.{{ ansible_facts['system'] | lower }}-{{ _pgbackrest_exporter_go_ansible_arch }}.tar.gz"

pgbackrest_exporter_checksums_url

string

URL of the pgbackrest_exporter checksums file

Default: "https://github.com/{{ _pgbackrest_exporter_repo }}/releases/download/v{{ pgbackrest_exporter_version }}/sha256sums.txt"

pgbackrest_exporter_collctor_pgbackrest

boolean

Enable pgBackRest collector. When disabled, only pgBackRest version and exporter build info are collected.

Choices:

  • false

  • true ← (default)

pgbackrest_exporter_collect_interval

string

Collecting metrics interval in seconds.

Default: "600"

pgbackrest_exporter_config_dir

string

Path to directory with pgbackrest_exporter configuration

Default: "/etc/pgbackrest_exporter"

pgbackrest_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in pgbackrest_exporter docs.

pgbackrest_exporter_local_cache_path

string

Local path to stash the archive and its extraction

Default: "/tmp/pgbackrest_exporter-{{ ansible_facts['system'] | lower }}-{{ _pgbackrest_exporter_go_ansible_arch }}/{{ pgbackrest_exporter_version }}"

pgbackrest_exporter_log_format

string

Output format of log messages

Choices:

  • "logfmt" ← (default)

  • "json"

pgbackrest_exporter_log_level

string

Only log messages with the given severity or above

Choices:

  • "debug"

  • "info" ← (default)

  • "warn"

  • "error"

pgbackrest_exporter_system_group

string

Advanced

System group for pgbackrest_exporter

Default: "pgbackrest-exp"

pgbackrest_exporter_system_user

string

Advanced

pgbackrest exporter user

Default: "pgbackrest-exp"

pgbackrest_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in pgbackrest_exporter docs.

pgbackrest_exporter_version

string

pgbackrest exporter package version. Also accepts latest as parameter.

Default: "0.23.0"

pgbackrest_exporter_web_listen_address

string

Address on which pgbackrest_exporter will listen

Default: "0.0.0.0:9854"

pgbackrest_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community