Skip to content
Snippets Groups Projects
Commit 06d2da6b authored by Guillaume Subiron's avatar Guillaume Subiron
Browse files

Merge branch 'master' into 'master' 

Multiple improvements in borg handler

See merge request !69
parents a9da4a0b b37edd26
No related branches found
No related tags found
1 merge request!69Multiple improvements in borg handler
Hide whitespace changes
Inline Side-by-side
examples/example.borg
+ 46
− 9
View file @ 06d2da6b
......@@ -46,6 +46,22 @@
## Default:
# bwlimit = 0
## export "borg info last_archive" to a given file
## this is usefull for monitoring without using borg
##
## Example:
# borginfo = /var/backups/borginfo.json
## Default:
# borginfo =
## export "borg list repository" to a given file
## this is usefull for monitoring without using borg
##
## Example
# borglist = /var/backups/borglist.json
## Default:
# borglist =
######################################################
## source section
## (where the files to be backed up are coming from)
......@@ -114,6 +130,16 @@ exclude = /var/lib/mysql
## Default:
# keep = 30d
## define hourly, daily, weekly and monthly retention for the "borg prune" operation.
##
## theses options will be ignored if set to 0
##
## Default:
## keephourly = 0
## keepdaily = 0
## keepweekly = 0
## keepmonthly = 0
## define extra command-line options for the "borg prune" operation.
##
## Example:
......@@ -124,21 +150,32 @@ exclude = /var/lib/mysql
## Default:
# prune_options =
## by default borg emits a warning when a source file or directory
## vanishes during the backup operations
## set to yes to ignore such warnings
## Path to the directory that will hold borg's cache files. By default this is
## empty, which will let borg use its default path of "~/.cache/borg".
##
## Example:
## ignore_missing = yes
## Default:
# cache_directory =
## by default borg emits various warnings that are impossible to check on large
## infrastructures.
## - when some files/repositories included in borg create does not exists
## - when some files have changed during the backup (happens a lot on log files)
## This option allows to disable these warning.
##
## Default:
# ignore_missing =
# filter_warnings = yes
## Path to the directory that will hold borg's cache files. By default this is
## empty, which will let borg use its default path of "~/.cache/borg".
## when filter_warning == yes, allows to choose to disable warning if
## file changed during backup
##
## Default:
# cache_directory =
# warning_if_file_changed_during_backup = yes
## when warning_if_file_changed_during_backup == yes, allows to ignore some
## paths or filenames.
##
## Default:
# file_changes_to_ignore = /
######################################################
## destination section
......
handlers/borg.in
+ 135
− 32
View file @ 06d2da6b
#!/bin/bash
# shellcheck shell=bash
# shellcheck disable=SC2154
# -*- mode: sh; sh-basic-offset: 3; indent-tabs-mode: nil; -*-
# vim: set filetype=sh sw=3 sts=3 expandtab autoindent:
#
......@@ -28,6 +31,9 @@ getconf nicelevel 0
getconf ionicelevel
getconf bwlimit
getconf borginfo
getconf borglist
setsection source
getconf init yes
getconf include
......@@ -35,9 +41,15 @@ getconf exclude
getconf create_options
getconf prune yes
getconf keep 30d
getconf keephourly 0
getconf keepdaily 0
getconf keepweekly 0
getconf keepmonthly 0
getconf prune_options
getconf cache_directory
getconf ignore_missing
getconf filter_warnings yes
getconf warning_if_file_changed_during_backup yes
getconf file_changes_to_ignore /
setsection dest
getconf user
......@@ -46,7 +58,7 @@ getconf port
getconf directory
# strip trailing /
directory=${directory%/}
getconf archive {now:%Y-%m-%dT%H:%M:%S}
getconf archive "{now:%Y-%m-%dT%H:%M:%S}"
getconf compression lz4
getconf encryption none
getconf passphrase
......@@ -104,21 +116,23 @@ fi
# check the connection at the source and destination
[ -n "$test" ] || test=0
# shellcheck disable=SC2235
if [ "$host" != "localhost" ] && ([ "$testconnect" = "yes" ] || [ "${test}" -eq 1 ]); then
debug "ssh $sshoptions -o PasswordAuthentication=no ${host}${port:+ -p ${port}} -l $user 'echo -n 1'"
local ret=`ssh $sshoptions -o PasswordAuthentication=no ${host}${port:+ -p ${port}} -l $user 'echo -n 1'`
teststr="ssh $sshoptions -o PasswordAuthentication=no ${host}${port:+ -p ${port}} -l $user 'echo -n 1'"
debug "$teststr"
ret=$(su -c "$teststr")
if [ "$ret" = 1 ]; then
debug "Connected to $host as $user successfully"
else
teststr="borg list $options --show-rc -v $execstr_repository"
debug "$teststr"
output=`su -c "$teststr" 2>&1`
output=$(su -c "$teststr" 2>&1)
if echo "$output" | grep "terminating with success status" \
|| echo "$output" | grep "^\S\+ is not a valid repository." \
|| echo "$output" | grep "^Repository \S\+ does not exist."; then
debug "Connected to $host as $user successfully (forced command)"
else
error $output
error "$output"
fatal "Can't connect to $host as $user."
fi
fi
......@@ -130,13 +144,13 @@ if [ "$init" == "yes" ]; then
initstr="borg init $options --encryption=$encryption $execstr_repository"
debug "executing borg init"
debug "$initstr"
if [ $test = 0 ]; then
output="`su -c "$initstr" 2>&1`"
if [ "$test" = 0 ]; then
output="$(su -c "$initstr" 2>&1)"
if [ $? = 2 ]; then
debug $output
debug "$output"
info "Repository was already initialized"
else
warning $output
warning "$output"
warning "Repository has been initialized"
fi
fi
......@@ -166,11 +180,11 @@ IFS=$SAVEIFS
set +o noglob
if [ ! -z $bwlimit ]; then
if [ -n "$bwlimit" ]; then
execstr="${execstr} --remote-ratelimit=${bwlimit}"
fi
if [ ! -z "$create_options" ]; then
if [ -n "$create_options" ]; then
execstr="${execstr} ${create_options}"
fi
......@@ -180,24 +194,46 @@ execstr="${execstr} ${excludes} $execstr_repository::$execstr_archive ${includes
debug "executing borg create"
debug "$nice $execstr"
if [ $test = 0 ]; then
output=`$nice su -c "$execstr" 2>&1`
if [ "$test" = 0 ]; then
output=$($nice su -c "$execstr" 2>&1)
ret=$?
if [ $ret = 0 ]; then
debug $output
info "Successfully finished backing up source."
elif [ $ret = 1 ]; then
warnmsg=$(echo "$output" | @SED@ -n '1,/^-\+$/{x;p;d;}; x' | @SED@ '/^$/d')
if [ "$ignore_missing" = "yes" ] && ! echo "$warnmsg" | grep -qv '\[Errno 2\] No such file or directory:'; then
debug $output
info "Backing up source finished with missing file warnings."
if [ $ret = 0 ]; then # borg ok
debug "$output"
info "Successfully finished backing up source"
elif [ $ret = 1 ]; then # borg warning
# Borg can return 1 for warnings that are impossible to manually check on large infrastructures :
# - when some files/repositories included in borg create does not exist
# - when some files have changed during the backup (happens a lot on log files)
# So we need to filter the output line by line to print these warnings as debug.
# Warnings are always printed by borg before a long "---…" line.
# So we break the output in two along this line.
warning_output=$(echo "$output" | sed '/----------------------------/Q') # Before -----…
debug_output=$(echo "$output" | sed -n '/----------------------------/,$p') # After -----…
if [ -n "$warning_output" ] && [ "$filter_warnings" == "yes" ]; then
if [ "$warning_if_file_changed_during_backup" == "yes" ]; then
file_changes_to_ignore="($file_changes_to_ignore"'|/var/lib/apt/.*|/var/backups/atop/.*|/var/lib/postfix/.*|.*prometheus.*/wal/.*|.*/pg_wal/.*|.*/upload(s)?/.*|.*/(page_)?cache/.*|/var/mail/.*|.*/log(s)?/.*|.*/var/log/.*|.*(log\.json|\.log|\.err|\.wal|\.rrd(4j)?|\.wsp|\.part|\.seq|\.out|\.aof|\.rdb))'
else
file_changes_to_ignore=""
fi
non_warning_regex="(Attempting to access a previously unknown unencrypted repository|The repository at location.*was previously located at|Do you want to continue?|No such file or directory|$file_changes_to_ignore: file changed while we backed it up|Using a pure-python msgpack! This will result in lower performance.|/var/backups/drbd/.*scandir.)"
echo "$warning_output" | while IFS= read -r line; do
if echo "$line" | grep -Eq "$non_warning_regex"; then
debug "$line"
else
warning "$line"
fi
done
debug "$debug_output"
info "Successfully finished backing up source"
else
warning $output
warning "$output"
warning "Backing up source finished with warnings."
fi
else
error $output
fatal "Failed backing up source."
else # borg error
error "$output"
fatal "Failed backuping up source. Borg returned exit code ${ret}."
fi
fi
......@@ -208,21 +244,88 @@ if [ "$prune" == "yes" ]; then
if [ ! "$keep" == "0" ]; then
prune_options="${prune_options} --keep-within=${keep}"
fi
if [ ! "$keephourly" == "0" ]; then
prune_options="${prune_options} --keep-hourly=${keephourly}"
fi
if [ ! "$keepdaily" == "0" ]; then
prune_options="${prune_options} --keep-daily=${keepdaily}"
fi
if [ ! "$keepweekly" == "0" ]; then
prune_options="${prune_options} --keep-weekly=${keepweekly}"
fi
if [ ! "$keepmonthly" == "0" ]; then
prune_options="${prune_options} --keep-monthly=${keepmonthly}"
fi
prunestr="borg prune $options $prune_options $execstr_repository"
debug "executing borg prune"
debug "$prunestr"
if [ $test = 0 ]; then
output="`su -c "$prunestr" 2>&1`"
if [ "$test" = 0 ]; then
output="$(su -c "$prunestr" 2>&1)"
ret=$?
if [ $ret = 0 ]; then
debug $output
debug "$output"
info "Removing old backups succeeded."
if [[ "$(borg --version)" > "borg 1.2" ]] ; then
compactstr="borg compact $execstr_repository"
debug "$compactstr"
output="$(su -c "$compactstr" 2>&1)"
ret=$?
if [ $ret = 0 ]; then
debug "$output"
info "Compacting borg repository succeeded."
else
info "$output"
warning "Compacting borg repository failed. Borg returned exit code ${ret}."
fi
fi
elif [ $ret = 1 ]; then
warning $output
warning "$output"
warning "Removing old backups finished with warnings."
else
error $output
fatal "Failed removing old backups."
info "$output"
warning "Failed removing old backups. Borg returned exit code ${ret}."
fi
fi
fi
### WRITE STATS FILES ###
if [ -n "$borginfo" ]; then
mkdir -p "$(dirname "$borginfo")"
infostr="borg info $execstr_repository --last 1 --json > $borginfo"
debug "$infostr"
if [ "$test" = 0 ]; then
output=$(su -c "$infostr" 2>&1)
ret=$?
if [ $ret = 0 ]; then
debug "$output"
info "Successfully writing borg info to $borginfo"
else
info "$output"
error "Failed to write borg info to $borginfo"
fi
fi
fi
if [ -n "$borglist" ]; then
mkdir -p "$(dirname "$borglist")"
infostr="borg list $execstr_repository --json > $borglist"
debug "$infostr"
if [ "$test" = 0 ]; then
output=$(su -c "$infostr" 2>&1)
ret=$?
if [ $ret = 0 ]; then
debug "$output"
info "Successfully writing borg list to $borglist"
else
info "$output"
error "Failed to write borg list to $borglist"
fi
fi
fi
......
test/borg.bats
+ 2
− 2
View file @ 06d2da6b
......@@ -218,10 +218,10 @@ finish_borg() {
greplog 'Debug: export BORG_CACHE_DIR="/var/cache/borg"$'
}
@test "check config parameter source/ignore_missing" {
@test "check config parameter source/filter_warnings" {
delconfig source include
setconfig_repeat source include "$BN_SRCDIR/boot" "$BN_SRCDIR/etc" "$BN_SRCDIR/lib" "$BN_SRCDIR/var" "$BN_SRCDIR/foo"
setconfig source ignore_missing yes
setconfig source filter_warnings yes
setconfig dest archive testarchive
setconfig dest encryption none
setconfig dest compression zstd,16
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment