backupninja/etc/backupninja.conf.in
Micah Anderson fa2528a083
Add basic prometheus metrics for backup status.
This requires that `prometheus-node-exporter` is installed.

If `reportprom` is set, then during the reporting phase, metrics will be written
to `${prom_textfile_dir}/backupninja.prom`, which will then be available for
scraping by prometheus.

The metrics simply report the hostname and the number of actions run, the number
of warnings, errors, fails, and halts that were produced in the backup run.

These are written to the prometheus-node-exporter directory in an atomic way.
2021-06-24 10:55:31 -04:00

96 lines
2.5 KiB
Plaintext

#
# |\_
# B A C K U P N I N J A /()/
# `\|
# main configuration file
#
# how verbose to make the logs
# 5 -- Debugging messages (and below)
# 4 -- Informational messages (and below)
# 3 -- Warnings (and below)
# 2 -- Errors (and below)
# 1 -- Fatal errors (only)
loglevel = 4
# Produce prometheus metrics of backup status (default = no).
# Requires `prometheus-node-exporter` to be installed
reportprom = false
# send a summary of the backup status to
# this email address:
reportemail = root
# if set to 'yes', a report email will be generated
# even if all modules reported success. (default = yes)
reportsuccess = yes
# if set to 'yes', info messages from handlers will be
# sent into the email (default = no)
reportinfo = no
# if set to 'yes', a report email will be generated
# even if there was no error. (default = yes)
reportwarning = yes
# if set to 'yes', disk space usage will be included in
# the backup email report
reportspace = no
# where to rsync the backupninja.log to be aggregated in
# a ninjareport
reporthost =
# what user to connect to reporthost to sync the
# backupninja.log
reportuser = ninja
# where on the reporthost should the report go
# NOTE: the name of the log will be used in the report,
# use a globally unique name, preferably the hostname
reportdirectory = /var/lib/backupninja/reports
# number of columns the report email body should wrap to
#reportwrap = 80
# set to the administration group that is allowed to
# read/write configuration files in /etc/backup.d
admingroup = root
#######################################################
# for most installations, the defaults below are good #
#######################################################
# where to log:
logfile = @localstatedir@/log/backupninja.log
# directory where all the backup configuration files live
configdirectory = @CFGDIR@/backup.d
# where backupninja helper scripts are found
scriptdirectory = @pkgdatadir@
# where backupninja libs are found
libdirectory = @pkglibdir@
# whether to use colors in the log file
usecolors = yes
# default value for 'when'
when = everyday at 01:00
# programs paths
# SLAPCAT=/usr/sbin/slapcat
# LDAPSEARCH=/usr/bin/ldapsearch
# RDIFFBACKUP=/usr/bin/rdiff-backup
# CSTREAM=/usr/bin/cstream
# MYSQL=/usr/bin/mysql
# MYSQLHOTCOPY=/usr/bin/mysqlhotcopy
# MYSQLDUMP=/usr/bin/mysqldump
# PSQL=/usr/bin/psql
# PGSQLDUMP=/usr/bin/pg_dump
# PGSQLDUMPALL=/usr/bin/pg_dumpall
# GZIP=/bin/gzip
# GZIP_OPTS='--rsyncable'
# RSYNC=/usr/bin/rsync