241 lines
10 KiB
Bash
Executable File
241 lines
10 KiB
Bash
Executable File
#!/bin/bash
|
|
source /etc/borg_exporter.rc
|
|
source /variables.sh
|
|
|
|
TMP_FILE="/tmp/prometheus-borg.$$"
|
|
|
|
[ -e "$TMP_FILE" ] && rm -f "$TMP_FILE"
|
|
|
|
#prevent "Attempting to access a previously unknown unencrypted repository" prompt
|
|
export BORG_RELOCATED_REPO_ACCESS_IS_OK=yes
|
|
export BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes
|
|
HOSTNAME=$(hostname)
|
|
###################################################################################################
|
|
# Funktionen
|
|
###################################################################################################
|
|
function writeToFile() {
|
|
msg="$1"
|
|
local -n arr=$2
|
|
|
|
for key in "${!arr[@]}"; do
|
|
echo "$key$msg ${arr[$key]}" >> $TMP_FILE
|
|
done
|
|
}
|
|
|
|
function calc_bytes {
|
|
NUM=$1
|
|
UNIT=$2
|
|
|
|
case "$UNIT" in
|
|
kB)
|
|
echo $NUM | awk '{ print $1 * 1024 }'
|
|
;;
|
|
MB)
|
|
echo $NUM | awk '{ print $1 * 1024 * 1024 }'
|
|
;;
|
|
GB)
|
|
echo $NUM | awk '{ print $1 * 1024 * 1024 * 1024 }'
|
|
;;
|
|
TB)
|
|
echo $NUM | awk '{ print $1 * 1024 * 1024 * 1024 * 1024 }'
|
|
;;
|
|
B)
|
|
echo $NUM | awk '{ print $1 }'
|
|
;;
|
|
esac
|
|
}
|
|
|
|
function calc_hours_diff {
|
|
local start_ts="$1"
|
|
local end_ts="$2"
|
|
|
|
python3 - "$start_ts" "$end_ts" <<'PY'
|
|
from datetime import datetime
|
|
import sys
|
|
|
|
start = datetime.strptime(sys.argv[1], "%Y-%m-%d %H:%M:%S")
|
|
end = datetime.strptime(sys.argv[2], "%Y-%m-%d %H:%M:%S")
|
|
print(int((end - start).total_seconds() // 3600))
|
|
PY
|
|
}
|
|
|
|
function writeDefinitionsToMetrics() {
|
|
#print the definition of the metrics
|
|
echo "# HELP borg_hours_from_last_archive How many hours have passed since the last archive was added to the repo (counted by borg_exporter.sh)" >> $TMP_FILE
|
|
echo "# TYPE borg_hours_from_last_archive gauge" >> $TMP_FILE
|
|
echo "# HELP borg_last_archive_timestamp The timestamp of the last archive (unixtimestamp)" >> $TMP_FILE
|
|
echo "# TYPE borg_last_archive_timestamp gauge" >> $TMP_FILE
|
|
echo "# HELP borg_total_size The total size of all archives in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_total_size gauge" >> $TMP_FILE
|
|
echo "# HELP borg_total_size_compressed The total compressed size of all archives in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_total_size_compressed gauge" >> $TMP_FILE
|
|
echo "# HELP borg_total_size_dedup The total deduplicated size of all archives in the repo (size on disk)" >> $TMP_FILE
|
|
echo "# TYPE borg_total_size_dedup gauge" >> $TMP_FILE
|
|
echo "# HELP borg_archives_count The total number of archives in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_archives_count gauge" >> $TMP_FILE
|
|
echo "# HELP borg_archives_count_today The total number of archives created today in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_archives_count_today gauge" >> $TMP_FILE
|
|
echo "# HELP borg_files_count The number of files contained in the archive (today)" >> $TMP_FILE
|
|
echo "# TYPE borg_files_count gauge" >> $TMP_FILE
|
|
echo "# HELP borg_chunks_unique The number of unique chunks in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_chunks_unique gauge" >> $TMP_FILE
|
|
echo "# HELP borg_chunks_total The total number of chunks in the repo" >> $TMP_FILE
|
|
echo "# TYPE borg_chunks_total gauge" >> $TMP_FILE
|
|
echo "# HELP borg_last_size The size of the archive (today)" >> $TMP_FILE
|
|
echo "# TYPE borg_last_size gauge" >> $TMP_FILE
|
|
echo "# HELP borg_last_size_compressed The compressed size of the archive (today)" >> $TMP_FILE
|
|
echo "# TYPE borg_last_size_compressed gauge" >> $TMP_FILE
|
|
echo "# HELP borg_last_size_dedup The deduplicated size of the archive (today), (size on disk)" >> $TMP_FILE
|
|
echo "# TYPE borg_last_size_dedup gauge" >> $TMP_FILE
|
|
}
|
|
|
|
function getBorgDataForRepository {
|
|
REPOSITORY=$1 #repository we're looking into
|
|
host=$2 #the host for which the backups are made
|
|
declare -A repoData
|
|
|
|
ARCHIVES="$(BORG_PASSPHRASE=$BORG_PASSPHRASE borg list $REPOSITORY)"
|
|
COUNTER=0
|
|
BACKUPS_TODAY_COUNT=0
|
|
|
|
COUNTER=$(echo "$ARCHIVES" | wc -l)
|
|
TODAY=$(date +%Y-%m-%d)
|
|
BACKUPS_TODAY=$(echo "$ARCHIVES" | grep ", $TODAY ")
|
|
# Get correct Backup Count echo -n removes by 3 Backups got only 2, added sed command
|
|
BACKUPS_TODAY_COUNT=$(echo "$BACKUPS_TODAY" | sed '/^\s*$/d' | wc -l)
|
|
|
|
#extract data for last archive
|
|
LAST_ARCHIVE=$(BORG_PASSPHRASE=$BORG_PASSPHRASE borg list --last 1 $REPOSITORY)
|
|
#we need at least one valid backup to list anything meaningfull
|
|
if [ -n "${LAST_ARCHIVE}" ]; then
|
|
LAST_ARCHIVE_DATE=$(echo $LAST_ARCHIVE | awk '{print $3" "$4}')
|
|
CURRENT_DATE="$(date '+%Y-%m-%d %H:%M:%S')"
|
|
NB_HOUR_FROM_LAST_BCK="$(calc_hours_diff "$LAST_ARCHIVE_DATE" "$CURRENT_DATE")"
|
|
|
|
# in case the date parsing from BORG didn't work (e.g. archive with space in it), datediff will output
|
|
# a usage message on stdout and will break prometheus formatting. We need to
|
|
# check for that here
|
|
DATEDIFF_LINES=$(echo "$NB_HOUR_FROM_LAST_BCK" | wc -l)
|
|
if [ "${DATEDIFF_LINES}" -eq 1 ]; then
|
|
repoData["borg_hours_from_last_archive"]="$NB_HOUR_FROM_LAST_BCK"
|
|
repoData["borg_last_archive_timestamp"]=$(date -d "$LAST_ARCHIVE_DATE" +"%s")
|
|
|
|
BORG_INFO=$(BORG_PASSPHRASE="$BORG_PASSPHRASE" borg info "$REPOSITORY")
|
|
|
|
TOTAL_SIZE=$(calc_bytes $(echo "$BORG_INFO" |grep "All archives" |awk '{print $3}') $(echo "$BORG_INFO" |grep "All archives" |awk '{print $4}'))
|
|
TOTAL_SIZE_COMPRESSED=$(calc_bytes $(echo "$BORG_INFO" |grep "All archives" |awk '{print $5}') $(echo "$BORG_INFO" |grep "All archives" |awk '{print $6}'))
|
|
TOTAL_SIZE_DEDUP=$(calc_bytes $(echo "$BORG_INFO" |grep "All archives" |awk '{print $7}') $(echo "$BORG_INFO" |grep "All archives" |awk '{print $8}'))
|
|
|
|
#echo "Borg REPOSITORY: $REPOSITORY"
|
|
#echo "Total size: $TOTAL_SIZE, Compressed size: $TOTAL_SIZE_COMPRESSED, DEDUP size: $TOTAL_SIZE_DEDUP"
|
|
|
|
repoData["borg_total_size"]="$TOTAL_SIZE"
|
|
repoData["borg_total_size_compressed"]="$TOTAL_SIZE_COMPRESSED"
|
|
repoData["borg_total_size_dedup"]="$TOTAL_SIZE_DEDUP"
|
|
|
|
repoData["borg_chunks_unique"]=$(echo "$BORG_INFO" | grep "Chunk index" | awk '{print $3}')
|
|
repoData["borg_chunks_total"]=$(echo "$BORG_INFO" | grep "Chunk index" | awk '{print $4}')
|
|
fi
|
|
|
|
repoData["borg_archives_count"]="$COUNTER"
|
|
repoData["borg_archives_count_today"]="$BACKUPS_TODAY_COUNT"
|
|
|
|
#Write Repo Array to File
|
|
writeToFile "{host=\"$host\", backupserver=\"$HOSTNAME\", repo=\"$REPOSITORY\"}" repoData
|
|
|
|
#go through the day's archives and count the files/size/etc.
|
|
TODAY_ARCHIVES=$(echo -n "$BACKUPS_TODAY" | awk '{print $1}' | xargs echo )
|
|
#echo $TODAY_ARCHIVES
|
|
if [ -n "${TODAY_ARCHIVES}" ]; then
|
|
for archive in $TODAY_ARCHIVES; do
|
|
declare -A archiveData
|
|
|
|
echo "Looking at $REPOSITORY::$archive"
|
|
#ask for an info on it
|
|
CURRENT_INFO=$(BORG_PASSPHRASE="$BORG_PASSPHRASE" borg info "$REPOSITORY::$archive")
|
|
#cut out something that looks like a timestamp when reporting: 20210528-1315
|
|
readable_archive=$(echo $archive | sed -r "s/-[0-9]{8}-[0-9]{4,6}//")
|
|
|
|
archiveData['borg_files_count']=$(echo "$CURRENT_INFO" | grep "Number of files" | awk '{print $4}')
|
|
|
|
# byte size
|
|
LAST_SIZE=$(calc_bytes $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $3}') $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $4}'))
|
|
LAST_SIZE_COMPRESSED=$(calc_bytes $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $5}') $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $6}'))
|
|
LAST_SIZE_DEDUP=$(calc_bytes $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $7}') $(echo "$CURRENT_INFO" |grep "This archive" |awk '{print $8}'))
|
|
|
|
archiveData['borg_last_size']="$LAST_SIZE"
|
|
archiveData['borg_last_size_compressed']="$LAST_SIZE_COMPRESSED"
|
|
archiveData['borg_last_size_dedup']="$LAST_SIZE_DEDUP"
|
|
|
|
writeToFile "{host=\"$host\", backupserver=\"$HOSTNAME\", repo=\"$REPOSITORY\", archive=\"$readable_archive\"}" archiveData
|
|
done
|
|
else
|
|
echo "Unable to find any archives for today in $REPOSITORY."
|
|
fi
|
|
else
|
|
echo "Unable to find any archives in $REPOSITORY. Processing skipped for it"
|
|
fi
|
|
}
|
|
|
|
function findRepositorysAndGetData() {
|
|
REPOS=`find "$BASEREPODIR" -type f -name "README" | grep -v ".cache/borg"`
|
|
# e.g. /backup/servers/server_name/README
|
|
for REPO in $REPOS; do
|
|
#cut out the /README from the name
|
|
REPO=$(echo "$REPO" | sed -r "s/\/README//")
|
|
#assume the name convention for the repo contains the hostname as the repo name
|
|
# e.g. /backup/servers/server_name
|
|
host=$(basename "$REPO")
|
|
getBorgDataForRepository $REPO $host
|
|
done
|
|
}
|
|
|
|
function sendDataToGatewayOrNodeExplorer() {
|
|
if ! grep -q '^borg_' "$TMP_FILE"; then
|
|
echo "No borg metric data collected; keeping previous metrics output untouched."
|
|
return 1
|
|
fi
|
|
|
|
if [ -n "${PUSHGATEWAY_URL}" ]; then
|
|
#send data via pushgateway
|
|
curl --data-binary @"$TMP_FILE" "${PUSHGATEWAY_URL}/metrics/job/borg-exporter/host/$HOSTNAME/repository/${REPOSITORY:-auto}"
|
|
else
|
|
#send data via node_exporter
|
|
if [ -d "${NODE_EXPORTER_DIR}" ]; then
|
|
cp "$TMP_FILE" "${NODE_EXPORTER_DIR}/borg_exporter.prom"
|
|
else
|
|
echo "Please configure either PUSHGATEWAY_URL or NODE_EXPORTER_DIR in /etc/borg_exporter.rc"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
function cleanup() {
|
|
rm -f "$TMP_FILE"
|
|
}
|
|
|
|
###################################################################################################
|
|
# Main Code
|
|
###################################################################################################
|
|
writeDefinitionsToMetrics
|
|
if [ -n "${REPOSITORY}" ]; then
|
|
getBorgDataForRepository "${REPOSITORY}" "${HOSTNAME}"
|
|
if [ ! -z "${READ_BASEREPODIR}" ]; then
|
|
if [ -d "${BASEREPODIR}" ]; then
|
|
findRepositorysAndGetData
|
|
else
|
|
echo "Error: Set BASEREPODIR in /etc/borg_exporter.rc"
|
|
fi
|
|
fi
|
|
else
|
|
#discover (recursively) borg repositories starting from a path and extract info for each
|
|
#(e.g. when running on the backup server directly)
|
|
if [ -d "${BASEREPODIR}" ]; then
|
|
findRepositorysAndGetData
|
|
else
|
|
echo "Error: Either set REPOSITORY or BASEREPODIR in /etc/borg_exporter.rc"
|
|
fi
|
|
fi
|
|
|
|
sendDataToGatewayOrNodeExplorer
|
|
cleanup
|