Page locked

This page is currently locked for editing by another user. You have to wait until this user finishes editing or the lock expires.
Currently locked by: 216.73.216.68
Lock expires at: 2025/06/16 09:52 (14 min)
This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== rsnapshot-backup ======

rsnapshot-backup is a frontend to rsnapshot for managing larger backup sites (several dozen systems)
of un*x-like operation system instances. It is easy to use, esp. additional backup clients are configured in a jiffy.
If you have to backup several dozen uni*x-like systems this is your tool.

===== components ======

  * rsnapshot-backup
    * schedules and parallelizes the backup jobs
	* creates logfiles
	* logfile retention follows backup retention (or $keeplogs, whichever is less)
    * rsnapshot-backup -C - sanity checking for  
      * connectivity on all enabled backup jobs 
      * accessiblity i.e. unattended ssh login
      * remote hostname
      * rsync executable
  * rsnapshot-backup-conf
    * create new backup job description from a template
    * create corresponding directories
    * if mkdir fails it prompts for permission to use 'mkdir -p'
  * rsnapshot-backup-enable
    * enables a defined backup job after creation
  * rsnapshot-backup-stats
    * writes du and df stats to /var/log/rsnapshot-backup/00-stats/
    * cronjob @07:07

  * /etc/rsnapshot-backup.d/ - config directory
  * /etc/rsnapshot-backup.d/conf.template - backup job description template
  * /etc/rsnapshot-backup.d/exclude.template - backup job exclude template
  * /etc/rsnapshot-backup.d/conf.<somehost> - backup job description for <somehost>
  * /etc/rsnapshot-backup.d/script.<somehost> - supplementary prerequisite script (e.g. for database dumps) for <somehost> - (optional)
  * /etc/rsnapshot-backup.d/exclude.<somehost> - exclude file for <somehost>
  * /etc/rsnapshot-backup.d/enabled/ - config directory, contains symlinks to enabled backup jobs
  * /etc/rsnapshot-backup.d/enabled/conf.<somehost> - symlink to enabled backup job description for <somehost>. 
  * /etc/cron.d/rsnapshot-backup - cronjob for running rsnapshot-backup
  * /etc/cron.d/rsnapshot-backup-stats - cronjob for running rsnapshot-backup-stats

===== installation ======

<code>
cat << EOF >> /etc/apt/sources.list.d/lihas
deb http://ftp.lihas.de/debian stable main
EOF
wget -O - http://ftp.lihas.de/debian/apt-key-lihas.gpg | apt-key add -
apt-get update
apt-get install rsnapshot-backup
</code>

  * Take a look at /etc/rsnapshot-backup.d/conf
    * does the ''BACKUPDIR'' setting fit for your setup?
    * is there enough storage available for your backups?
    * is the ''parallel'' setting suitable for your environment? This depends on LAN/WAN speed and CPU and I/O speed of server and clients.
  * Take a look at /etc/rsnapshot-backup.d/conf.template
    * does the ''snapshot_root'' directory fit for your setup?
    * does the ''snapshot_root'' directory MATCH the ''BACKUPDIR'' setting from ''/etc/rsnapshot-backup.d/conf''? It has to!
    * is there enough storage available for your backups?
    * does the ''interval'' setting meet your requirements?
  * '''please''' do not remove the ''<HOST>'' tags from the template as they are needed by ''rsnapshot-backup-conf''.
  * Provide a ssh key pair for the ''root'' user. If you don't have one ''ssh-keygen -t rsa -b 4096 -N "" -C "rsnapshot-backup@$HOSTNAME" -f ~/.ssh/id_rsa'' will do just fine.

===== operation ======

Normally, rsnapshot-backup runs unattended. You just keep a watch on disk space.

<code>
usage: /usr/sbin/rsnapshot-backup [ -h ] [ -i { hourly | daily | weekly | monthly } ]
-h  help
-i interval. One of hourly, daily, weekly, monthly. Default: daily.
-c config file. Use alternate config file. Default: /etc/rsnapshot-backup.d/conf
-C check connectivity for all enabled backup jobs.
</code>

==== create a backup job ====

  * Create a backup job description: ''rsnapshot-backup-conf <hostname> <ip>''. This creates ''/etc/rsnapshot-backup.d/conf.<hostname>'' and ''/etc/rsnapshot-backup.d/exclude.<hostname>''.
  * Provide the ssh public key to the backup client: ''ssh-copy-id root@<backup-client>''
  * Enable the backup job: ''rsnapshot-backup-enable <hostname>''.This creates the symlink ''/etc/rsnapshot-backup.d/enabled/conf.<hostname>'' .
  * Check for sanity: ''rsnapshot-backup -C''

  * To disable a backup job: ''rm /etc/rsnapshot-backup.d/enabled/conf.<hostname>'' .

===== resources ======

''/usr/share/doc/rsnapshot-backup'' holds some template and example files:

  * /usr/share/doc/rsnapshot-backup/examples/conf.template.gz
  * /usr/share/doc/rsnapshot-backup/examples/exclude.template
  * /usr/share/doc/rsnapshot-backup/examples/script.mysql5-zrmbackup
  * /usr/share/doc/rsnapshot-backup/examples/script.remote-backup-preparation

===== see also ======

  * ssh
  * rsync
  * rsnapshot
  * cron

===== tips & tricks ======

==== make rsnapshot-backup aware of ACLs and Extended Attributes ====

Debian 8 (Jessie) uses Capabilities (try: ''getcap /bin/ping'') which are stored 
as Extended Attributes.

Rsync needs ''--acls --xattrs'' to handle ACLs and XATTRs.

These parameters have to be added per backup job.

The copy & paste code below adds these. It extends 
existing lines beginning with ''rsync_long_args ..'' or inserts ''rsync_long_args\t\t--delete --numeric-ids --relative --delete-excluded --acls --xattrs'' into the files ''/etc/rsnapshot-backup.d/conf.*'' after the last line 
containing ''rsync_long_args'' which is usually found in a comment block.
If these comments don't exist the code throws an error leaving it to the admin to insert the line into the file.

This is because the code has no chance of finding the right spot in this case.

<code>
for C in /etc/rsnapshot-backup.d/conf.* ; do
vo -o $C
perl -e '
    $sq = "\x27"; # single quote
    $nl = "rsync_long_args\t\t--delete --numeric-ids --relative --delete-excluded --acls --xattrs\n";
    open F,$ARGV[0] or die "can${sq}t read ${sq}$ARGV[0]${sq}";
    my @L = <F>;
    close F;
    open F,">",$ARGV[0] or die "can${sq}t write ${sq}$ARGV[0]${sq}";
    @L2 = grep { /^rsync_long_args\t/ } @L;
    @L3 = grep { /\brsync_long_args\b/ } @L;
    if ( @L2 ) {
        print STDERR "adding to rsync_long_args\n";
        for my $l ( @L ) {
            if ( $l =~ /^rsync_long_args\t/ ) {
                $ll = $l;
                $ll =~ s/^rsync_long_args\t\t*//;
                $ll =~ s/\s*$//;
                %A = map { $_ => 1 } split /\s+/,$ll;
                unless ( $A{"--acls"} ) {
                    $l =~ s/\n/ --acls\n/;
                }
                unless ( $A{"--xattrs"} ) {
                    $l =~ s/\n/ --xattrs\n/;
                }
            }
            print F $l;
        }
    } elsif ( @L3 ) {
        print STDERR "adding rsync_long_args line\n";
        for (my $i=$#L; $i>=0; $i--) {
            if ( $L[$i] =~ /[^a-zA-Z_+]rsync_long_args\b/ ) {
                splice(@L,$i+1,0,$nl);
                last;
            }
        }
        print F @L;
    } else {
        # unchanged
        print STDERR "ERROR: doing nothing, add to ${sq}$ARGV[0]${sq} manually:\n";
        print STDERR $nl;
        print STDERR "Insert TABS after ${sq}rsync_long_args${sq}!\n";
        print F @L;
    }
    close F;
' $C
rcsdiff -u $C
vo -i $C
done
</code>

==== draw a plot showing disk usage of a job ====

<code>
JOB=mysystem
JOBDIR=$( awk '$1 == "snapshot_root" { print $2 }' /etc/rsnapshot-backup.d/conf.$JOB )

echo -n > /tmp/abs 
echo -n > /tmp/inc
for i in /var/log/rsnapshot-backup/00-stats/*.xml ; do
	X=$( xmlstarlet sel -t -v 'rsnapshot-stats/du[@sys="'$JOBDIR'"]' $i ) 
	awk '$2 == "daily.0" { print $1 }' <<< "$X" >> /tmp/abs
	awk '$2 == "daily.1" { print $1 }' <<< "$X" >> /tmp/inc
done 

gnuplot
  set style data linespoints
  plot "/tmp/abs","/tmp/inc"
</code>

==== draw plots showing disk usage of all jobs ====

fetches the status files from the backup server and draws disk usage plots

<file txt rsnapshot-backup-stats-eval>
#!/bin/bash

# read cfg. file
. rsnapshot-backup-stats-eval.cfg

if [ -z "$BACKUPSERVER" ]; then
    echo "BACKUPSERVER unset. Use BACKUPSERVER=... $0"
    echo "valid values for BACKUPSERVER would be some hostname or ip address"
    exit 1;
fi

if [ "$MODE" = "FLATFILE" ]; then

    rsync -vaSHAX root@${BACKUPSERVER}:/var/log/rsnapshot-backup/00-stats/status-????????-?????? .

    rm      status.sqlite
    sqlite3 status.sqlite 'create table status (d int, s int, v varchar(255), bc varchar(255), bset varchar(10));'

    for i in status-* ; do
        d=${i#status-}
        d=${d%-*}
        echo -n $d ""
        awk -v d=$d 'BEGIN{
                print "begin transaction;";
            }
            { print "insert into status(d,s,v) values ("d","$1",\""$2"\");" }
            END {
                print "commit;";
            }
            ' $i |
            sqlite3 status.sqlite
    done
    echo

elif [ "$MODE" = "XML" ]; then
    rsync -vaSHAX root@${BACKUPSERVER}:/var/log/rsnapshot-backup/00-stats/20??-??-??T??:??:??.xml .

    rm      status.sqlite
    sqlite3 status.sqlite 'create table status (d int, s int, v varchar(255), bc varchar(255), bset varchar(10));'

    for i in 20??-??-??T??:??:??.xml ; do
        d=${i%.xml}
        echo -n $d ""
        cnt=$( xmlstarlet sel -t -v "count(/rsnapshot-stats/du)" < $i )
        echo -n $cnt ""
        (  # generate sql
            echo "begin transaction;"
            for j in $( seq 1 $cnt ); do
                sys=$(
                    xmlstarlet sel -t -v "/rsnapshot-stats/du[$j]/@sys" < $i
                )
                #dev# echo -n $j $sys "" 1>&2
                du_data=$(
                    xmlstarlet sel -t -v "/rsnapshot-stats/du[$j]" < $i
                )
                while read s bset ; do
                    if [ -z "$s" ]; then continue ; fi  ## skip empty lines
                    bc=${sys##*/}
                    #dev# echo "BC: $sys -> $bc" 1>&2
                    echo "insert into status(d,s,v,bc,bset) values (strftime('%Y%m%d','$d'),'$s','$sys/$bset','$bc','$bset');"
                done <<< "$du_data"
            done
            echo "commit;"
        ) | tee -a sql | sqlite3 status.sqlite
        #dev# echo -n ": "
    done
    echo

else
    echo "MODE unset. Use MODE=... $0"
    echo "valid values for MODE are: FLATFILE, XML"
    exit 1;
fi

echo "*** DB is loaded ***"

# normalize:
sqlite3 status.sqlite "update status set v = '/u/vhost15/daily.0' where v like '/u/213.178.162.74_vhost15/daily.0';"
sqlite3 status.sqlite "update status set v = '/u/vhost14/daily.0' where v like '/u/213.178.162.72_vhost14/daily.0';"
sqlite3 status.sqlite "update status set v = '/u/vhost13/daily.0' where v like '/u/213.178.162.70_vhost13/daily.0';"
sqlite3 status.sqlite "update status set v = '/u/vhost12/daily.0' where v like '/u/213.178.162.82_vhost12/daily.0';"

sqlite3 status.sqlite "update status set v = '/u/vhost15/daily.1' where v like '/u/213.178.162.74_vhost15/daily.1';"
sqlite3 status.sqlite "update status set v = '/u/vhost14/daily.1' where v like '/u/213.178.162.72_vhost14/daily.1';"
sqlite3 status.sqlite "update status set v = '/u/vhost13/daily.1' where v like '/u/213.178.162.70_vhost13/daily.1';"
sqlite3 status.sqlite "update status set v = '/u/vhost12/daily.1' where v like '/u/213.178.162.82_vhost12/daily.1';"

DAILY0=$(
    sqlite3 status.sqlite "select distinct(v) from status where v like '%daily.0';"
)
echo "DAILY0: $DAILY0"

rm tab.*_D0 img.*_D0.png

for i in $DAILY0 ; do
  h=${i%/*}
  h=${h##*/}_D0
  echo "### $i -> $h ###"
  sqlite3 status.sqlite -separator " " "select d,s from status where v like '$i';" > tab.$h
  gnuplot << ..EOF
  set key below
  set xdata time
  set timefmt "%Y%m%d"
  set format x "%d.%m.\n%Y"
  set terminal png medium size 1200,400
  set output "img.$h.png"
  plot "tab.$h" using 1:2 title "$h"
..EOF

done


DAILY1=$(
    sqlite3 status.sqlite "select distinct(v) from status where v like '%daily.1';"
)
echo "DAILY1: $DAILY1"

rm tab.*_D1 img.*_D1.png

for i in $DAILY1 ; do
  h=${i%/*}
  h=${h##*/}_D1
  echo "### $i -> $h ###"
  sqlite3 status.sqlite -separator " " "select d,s from status where v like '$i';" > tab.$h
  gnuplot << ..EOF
  set key below
  set xdata time
  set timefmt "%Y%m%d"
  set format x "%d.%m.\n%Y"
  set terminal png medium size 1200,400
  set output "img.$h.png"
  plot "tab.$h" using 1:2 title "$h"
..EOF

done

# print hit lists:
echo "### absolute sizes ###"
sqlite3 status.sqlite -separator " " "select max(s)/1E6,'GB',v from status where v like '%daily.0' group by v order by s;" | tail -10
echo "### incremental sizes ###"
sqlite3 status.sqlite -separator " " "select max(s)/1E6,'GB',v from status where v like '%daily.1' group by v order by s;" | tail -10

</file>

<file txt rsnapshot-backup-stats-eval.cfg>
BACKUPSERVER="backuphost.example"
MODE="XML"
</file>


==== how much time statistics take per backup client ====

<code>
STATSFILE=2017-02-25T07:07:01.xml

(
cd /var/log/rsnapshot-backup/00-stats
CNT=$(     xmlstarlet sel -t -v "count(rsnapshot-stats/du)"     $STATSFILE )
echo $CNT
for i in $( seq 1 $CNT ) ; do
    SYS=$( xmlstarlet sel -t -v "rsnapshot-stats/du[$i]/@sys"   $STATSFILE )
    B=$(   xmlstarlet sel -t -v "rsnapshot-stats/du[$i]/@t"     $STATSFILE )
    E=$(   xmlstarlet sel -t -v "rsnapshot-stats/du[$i]/end/@t" $STATSFILE )
    D=$(( $( date +%s -d $E ) - $( date +%s -d $B ) ))
    echo $SYS $D
done | sort -n -k2 | awk '{s+=$2; print $0,s}END{print s}' | nl -ba
)
</code>

==== show all error messages from last (daily) run ====

<code>
# extract timestamp from crontab file
HHMM=$(
awk '$1 ~ /^[0-9]+$/ && $2 ~ /^[0-9]+$/ && 
     $3 ~ /^\*$/     && $4 ~ /^\*$/     &&
	 $5 ~ /^\*$/     && $6 ~ /^[a-zA-Z0-9-]+$/ && 
	 $7 == "/usr/sbin/rsnapshot-backup" &&
	 $8 == "-i" &&
	 $9 == "daily" { print $2 $1-1 }' /etc/cron.d/rsnapshot-backup
) 
# assume the backup run started yesterday
CDATE=$( date -d "yesterday $HHMM" -Is ) 
# create a file with mtime for comparision
CFILE=$( mktemp /tmp/rsnapshot-backup-check-XXXXXX )
touch -d "$CDATE" "$CFILE"
FILES=$( 
	find /var/log/rsnapshot-backup -newer "$CFILE" -name "log-error*"
) 
for f in $FILES; do 
	echo "### $f ####"
	cat  $f
done | less
# clean up 
rm "$CFILE"
</code>

===== development information =====

[[project:rsnapshot-backup:development]]

===== changelog =====

[[project:rsnapshot-backup:changelog]]