woblerr/pgbackrest_exporter

pgBackRest Exporter

Prometheus exporter for pgBackRest。

指标基于pgbackrest info --output json命令的结果收集。默认情况下，会为该命令返回的所有备份集（stanza）收集指标。你可以指定需要收集指标的备份集。需在安装了pgBackRest的主机上或Docker容器内运行exporter。

Grafana仪表盘

如需可视化收集的指标，可使用现成的仪表盘https://grafana.com/grafana/dashboards/***-pgbackrest-exporter-dashboard/%E6%88%96%E8%87%AA%E8%A1%8C%E5%88%9B%E5%BB%BA%E3%80%82

收集的指标

备份集指标

仓库指标

备份指标

最近备份指标

WAL指标

Exporter指标

指标补充说明

对于差异备份（backup_type="diff"）的pgbackrest_*_last_*指标，应用以下逻辑：

• 若最近一次备份是完整备份，则指标取值为完整备份的值；
• 否则，取值为差异备份的值。

对于增量备份（backup_type="incr"）的pgbackrest_*_last_*指标，应用以下逻辑：

• 若最近一次备份是完整或差异备份，则指标取值为完整或差异备份的值；
• 否则，取值为增量备份的值。

对于pgbackrest_exporter_status指标，应用以下逻辑：

• 若为所有可用备份集收集信息，则stanza标签值为all-stanzas；
• 否则，标签值为具体备份集名称。

若pgbackrest_stanza_lock_status指标为1，表示备份集正在运行以下命令之一：backup、expire或stanza-*，极有可能是backup/expire。

对于pgBackRest >= v2.48，可判断是否有备份正在运行：

• 若pgbackrest_stanza_backup_compete_bytes和pgbackrest_stanza_backup_total_bytes指标非0且pgbackrest_stanza_lock_status指标为1，则有备份正在运行；
• 若上述两个指标为0且pgbackrest_stanza_lock_status指标为1，则备份集正在运行expire或stanza-*命令，极有可能是expire。

与pgBackRest版本的兼容性

收集的指标数量可能因pgBackRest版本而异。不同版本下，部分指标可能无法收集或标签值无意义：

• pgBackRest < v2.48

  以下指标恒为0：

  • pgbackrest_stanza_backup_compete_bytes，
  • pgbackrest_stanza_backup_total_bytes。

• pgBackRest >= v2.45

  pgbackrest_backup_repo_size_bytes指标对于块增量备份的值为0。

• pgBackRest < v2.44

  以下指标恒为0：

  • pgbackrest_backup_repo_size_map_bytes，
  • pgbackrest_backup_repo_delta_map_bytes。

  pgbackrest_backup_*指标的block_incr标签值为"n"。

• pgBackRest < v2.41

  以下指标恒为0：

  • pgbackrest_backup_databases，
  • pgbackrest_backup_last_databases，
  • pgbackrest_backup_annotations，
  • pgbackrest_backup_last_annotations。

• pgBackRest < v2.38

  pgbackrest_backup_info指标的lsn_start和lsn_stop标签值为"-"。

• pgBackRest < v2.36

  以下指标恒为0：

  • pgbackrest_backup_error_status。

• pgBackRest < v2.32

  以下指标恒为0：

  • pgbackrest_repo_status。

  所有指标的repo_key标签值为"0"。

使用入门

构建与运行

bash
git clone https://github.com/woblerr/pgbackrest_exporter.git
cd pgbackrest_exporter
make build
./pgbackrest_exporter <flags>

可用配置参数：

bash
./pgbackrest_exporter --help
usage: pgbackrest_exporter [<flags>]


Flags:
  -h, --[no-]help                显示上下文相关帮助（也可尝试 --help-long 和 --help-man）。
      --web.telemetry-path="/metrics"  
                                 暴露指标的路径。
      --web.listen-address=:9854 ...  
                                 暴露指标和Web界面的地址。可重复指定多个地址。示例：`:9100` 或 `[::1]:9100`（HTTP），`vsock://:9100`（vsock）
      --web.config.file=""       启用TLS或认证的配置文件路径。详见：
                                 https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
      --collect.interval=600     指标收集间隔（秒）。
      --backrest.config=""       pgBackRest配置文件的完整路径。
      --backrest.config-include-path=""  
                                 额外pgBackRest配置文件的完整路径。
      --backrest.stanza-include="" ...  
                                 指定收集指标的备份集。可多次指定。
      --backrest.stanza-exclude="" ...  
                                 指定排除收集指标的备份集。可多次指定。
      --backrest.backup-type=""  指定收集指标的备份类型。可选值：[full, incr, diff]。
      --[no-]backrest.database-count  
                                 暴露备份中的数据库数量。
      --backrest.database-parallel-processes=1  
                                 收集数据库信息的并行进程数。
      --[no-]backrest.database-count-latest  
                                 暴露最近备份中的数据库数量。
      --[no-]backrest.reference-count  
                                 暴露引用其他备份的数量（备份引用列表）。
      --[no-]backrest.verbose-wal  
                                 为WAL指标暴露额外标签。
      --log.level=info           仅记录指定级别及以上的日志。可选值：[debug, info, warn, error]
      --log.format=logfmt        日志输出格式。可选值：[logfmt, json]
      --[no-]version             显示应用版本。

参数补充说明

可通过--backrest.config和--backrest.config-include-path参数指定pgBackRest的自定义配置文件和额外配置路径，需提供完整路径。例如：--backrest.config=/tmp/pgbackrest.conf和/或--backrest.config-include-path=/tmp/pgbackrest/conf.d。

通过--backrest.stanza-include参数指定收集指标的备份集，可多次指定。例如：--backrest.stanza-include=demo1 --backrest.stanza-include=demo2，此时仅为demo1和demo2备份集收集指标。

通过--backrest.stanza-exclude参数指定排除收集指标的备份集，可多次指定。例如：--backrest.stanza-exclude=demo1 --backrest.stanza-exclude=demo2，此时不为demo1和demo2备份集收集指标。若同一备份集同时指定包含和排除，则排除优先。例如：--backrest.stanza-include=demo1 --backrest.stanza-exclude=demo1，此时不为demo1备份集收集指标。

指定--backrest.verbose-wal参数后，WALMin和WALMax将作为指标标签添加，这会在每次WAL归档时创建新的时间序列。

指定--log.level=debug参数后，指标的取值和标签信息将打印到日志中。

--web.config.file参数可指定TLS和/或基本认证的配置文件路径，TLS配置和基本认证说明详见https://github.com/prometheus/exporter-toolkit/blob/v0.11.0/docs/web-configuration.md%E3%80%82

通过--backrest.backup-type参数指定收集指标的备份类型，有效值为full、incr或diff。例如：--backrest.backup-type=full，此时仅为完整备份收集指标。该参数适用于pgBackRest >= v2.38。当值为incr或diff时，所有pgbackrest_backup_last_*指标将不收集；当值为full时，指标将如同最近备份为完整备份（即差异和增量备份的指标取值与完整备份相同）。对于早期pgBackRest版本，会出现类似option 'type' not valid for command 'info'的错误。

指定--backrest.database-count参数后，将收集备份中的数据库数量信息。该参数适用于pgBackRest >= v2.41。对于早期版本，会出现类似option 'set' is currently only valid for text output的错误。对于大量备份集和备份，可能需要更多时间收集指标，每个备份集需执行pgBackRest命令获取数据。

--backrest.database-parallel-processes参数可增加收集数据库信息的并行进程数，仅在指定--backrest.database-count时有效。

Docker构建与运行

默认pgBackRest版本为2.55.1，可通过参数指定其他版本。基础镜像使用[docker-pgbackrest](https://github.com