Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SUMMARY_LOG option #77

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add SUMMARY_LOG option #77

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be04a57
Add SUMMARY_LOG option
mike2038 Nov 7, 2015
cf32624
FIX: Summary log when existing snapshot is found
mike2038 Nov 7, 2015
c0bab54
FIX Initial SUMMARY_LOG setup
mike2038 Nov 8, 2015
6d6f763
BUGFIX missing }
mike2038 Nov 8, 2015
51bdb6b
MinorFix - Spelling correction
mike2038 Nov 19, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion ghettoVCB.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ VM_STARTUP_ORDER=
# RSYNC LINK 1=yes, 0 = no
RSYNC_LINK=0

# Summary log file name. 0 = no log, or a filename
SUMMARY_LOG=0

# DO NOT USE - UNTESTED CODE
# Path to another location that should have backups rotated,
# this is useful when your backups go to a temporary location
Expand Down Expand Up @@ -164,6 +167,7 @@ printUsage() {
echo " -l File to output logging"
echo " -w ghettoVCB work directory (default: /tmp/ghettoVCB.work)"
echo " -d Debug level [info|debug|dryrun] (default: info)"
echo " -s Backup summary log filename"
echo
echo "(e.g.)"
echo -e "\nBackup VMs stored in a list"
Expand Down Expand Up @@ -205,6 +209,19 @@ logger() {
fi
}

summary_logger() {
VMLOG="$1"
STATUS="$2"

if [[ "${SUMMARY_LOG}" != "" ]] && [[ "${SUMMARY_LOG}" != "0" ]]
then
SUMMARY_END_TIME="$(date "+%Y/%m/%d %H:%M")"
echo "${VMLOG}|${STATUS}|${SUMMARY_START_TIME}|${SUMMARY_END_TIME}" >> "${SUMMARY_LOG}"
fi
SUMMARY_START_TIME=""
SUMMARY_END_TIME=""
}

sanityCheck() {
# ensure root user is running the script
if [ ! $(env | grep -e "^USER=" | awk -F = '{print $2}') == "root" ]; then
Expand Down Expand Up @@ -339,6 +356,7 @@ captureDefaultConfigurations() {
DEFAULT_VM_STARTUP_ORDER="${VM_STARTUP_ORDER}"
DEFAULT_RSYNC_LINK="${RSYNC_LINK}"
DEFAULT_BACKUP_FILES_CHMOD="${BACKUP_FILES_CHMOD}"
DEFAULT_SUMMARY_LOG="${SUMMARY_LOG}"
}

useDefaultConfigurations() {
Expand All @@ -361,6 +379,7 @@ useDefaultConfigurations() {
VM_STARTUP_ORDER="${DEFAULT_VM_STARTUP_ORDER}"
RSYNC_LINK="${RSYNC_LINK}"
BACKUP_FILES_CHMOD="${BACKUP_FILES_CHMOD}"
SUMMARY_LOG="${DEFAULT_SUMMARY_LOG}"
}

reConfigureGhettoVCBConfiguration() {
Expand Down Expand Up @@ -524,6 +543,7 @@ dumpVMConfigurations() {
logger "info" "CONFIG - EMAIL_TO = ${EMAIL_TO}"
logger "info" "CONFIG - WORKDIR_DEBUG = ${WORKDIR_DEBUG}"
fi
logger "info" "CONFIG - SUMMARY_LOG = ${SUMMARY_LOG}"
logger "info" ""
}

Expand Down Expand Up @@ -796,6 +816,10 @@ ghettoVCB() {
dumpVMConfigurations
fi

#Initial SUMMARY_LOG setup
[[ "${SUMMARY_LOG}" != "0" ]] && [[ ! -d "`dirname ${SUMMARY_LOG}`" ]] && mkdir -p "`dirname ${SUMMARY_LOG}`"
[[ -f "${SUMMARY_LOG}" ]] && rm -f "${SUMMARY_LOG}"

#dump out all virtual machines allowing for spaces now
${VMWARE_CMD} vmsvc/getallvms | sed 's/[[:blank:]]\{3,\}/ /g' | fgrep "[" | fgrep "vmx-" | fgrep ".vmx" | fgrep "/" | awk -F' ' '{print "\""$1"\";\""$2"\";\""$3"\""}' | sed 's/\] /\]\";\"/g' > ${WORKDIR}/vms_list

Expand Down Expand Up @@ -823,12 +847,15 @@ ghettoVCB() {
fi

for VM_NAME in $(cat "${VM_INPUT}" | grep -v "#" | sed '/^$/d' | sed -e 's/^[[:blank:]]*//;s/[[:blank:]]*$//'); do
SUMMARY_START_TIME="$(date "+%Y/%m/%d %H:%M")"
VM_SUMMARY_STATUS="UNKNOWN"
IGNORE_VM=0
if [[ "${EXCLUDE_SOME_VMS}" -eq 1 ]] ; then
grep -E "^${VM_NAME}" "${VM_EXCLUSION_FILE}" > /dev/null 2>&1
if [[ $? -eq 0 ]] ; then
IGNORE_VM=1
#VM_FAILED=0 #Excluded VM is NOT a failure. No need to set here, but listed for clarity
VM_SUMMARY_STATUS="EXCLUDED"
fi
fi

Expand All @@ -838,6 +865,7 @@ ghettoVCB() {
IGNORE_VM=1
#A VM ignored due to a problem, should be treated as a failure
VM_FAILED=1
VM_SUMMARY_STATUS="ERROR:Ignored as a problem VM"
fi
fi

Expand Down Expand Up @@ -870,6 +898,7 @@ ghettoVCB() {
elif [[ -z ${VM_ID} ]] ; then
logger "info" "ERROR: failed to locate and extract VM_ID for ${VM_NAME}!\n"
VM_FAILED=1
VM_SUMMARY_STATUS="ERROR:Failed to locate and extract VM_ID"

elif [[ "${LOG_LEVEL}" == "dryrun" ]] ; then
logger "dryrun" "###############################################"
Expand Down Expand Up @@ -925,13 +954,17 @@ ghettoVCB() {
logger "dryrun" "THIS VIRTUAL MACHINE WILL NOT BE BACKED UP DUE TO EMPTY VMDK LIST!"
fi
logger "dryrun" "###############################################\n"
VM_SUMMARY_STATUS="DRYRUN:No action taken"

#checks to see if the VM has any snapshots to start with
elif [[ -f "${VMX_PATH}" ]] && [[ ! -z "${VMX_PATH}" ]]; then
if ls "${VMX_DIR}" | grep -q "\-delta\.vmdk" > /dev/null 2>&1; then
if [ ${ALLOW_VMS_WITH_SNAPSHOTS_TO_BE_BACKEDUP} -eq 0 ]; then
logger "info" "Snapshot found for ${VM_NAME}, backup will not take place\n"
VM_FAILED=1
VM_SUMMARY_STATUS="ERROR:Existing snapshot found"
#call summary_logger here due to the following "continue"
summary_logger "${VM_NAME}" "${VM_SUMMARY_STATUS}"
continue
elif [ ${ALLOW_VMS_WITH_SNAPSHOTS_TO_BE_BACKEDUP} -eq 1 ]; then
logger "info" "Snapshot found for ${VM_NAME}, consolidating ALL snapshots now (this can take awhile) ...\n"
Expand Down Expand Up @@ -998,6 +1031,7 @@ ghettoVCB() {
if [[ ${POWER_OFF_EC} -eq 1 ]]; then
VM_FAILED=1
CONTINUE_TO_BACKUP=0
VM_SUMMARY_STATUS="ERROR:Failed to power off VM"
fi
fi

Expand All @@ -1022,6 +1056,7 @@ ghettoVCB() {
logger "info" "Snapshot timed out, failed to create snapshot: \"${SNAPSHOT_NAME}\" for ${VM_NAME}"
SNAP_SUCCESS=0
echo "ERROR: Unable to backup ${VM_NAME} due to snapshot creation" >> ${VM_BACKUP_DIR}/STATUS.error
VM_SUMMARY_STATUS="ERROR:Unable to create snapshot"
break
fi

Expand Down Expand Up @@ -1081,6 +1116,7 @@ ghettoVCB() {
if [[ "${FORMAT_OPTION}" == "UNKNOWN" ]] ; then
logger "info" "ERROR: wrong DISK_BACKUP_FORMAT \"${DISK_BACKUP_FORMAT}\ specified for ${VM_NAME}"
VM_VMDK_FAILED=1
VM_SUMMARY_STATUS="ERROR:Unknown disk format specified"
else
VMDK_OUTPUT=$(mktemp ${WORKDIR}/ghettovcb.XXXXXX)
tail -f "${VMDK_OUTPUT}" &
Expand All @@ -1106,11 +1142,13 @@ ghettoVCB() {
if [[ "${VMDK_EXIT_CODE}" != 0 ]] ; then
logger "info" "ERROR: error in backing up of \"${SOURCE_VMDK}\" for ${VM_NAME}"
VM_VMDK_FAILED=1
VM_SUMMARY_STATUS="ERROR:Error during VMDK backup"
fi
fi
else
logger "info" "WARNING: A physical RDM \"${SOURCE_VMDK}\" was found for ${VM_NAME}, which will not be backed up"
VM_VMDK_FAILED=1
VM_SUMMARY_STATUS="ERROR:Physical RDM found"
fi
fi
done
Expand Down Expand Up @@ -1154,6 +1192,7 @@ ghettoVCB() {
else
logger "info" "Error in compressing ${VM_NAME}!\n"
COMPRESSED_OK=0
VM_SUMMARY_STATUS="WARN:Error in compressing backup"
fi
rm -rf "${VM_BACKUP_DIR}"
checkVMBackupRotation "${BACKUP_DIR}" "${VM_NAME}"
Expand All @@ -1169,14 +1208,17 @@ ghettoVCB() {
logger "info" "ERROR: Unable to backup ${VM_NAME} due to snapshot creation!\n"
[[ ${ENABLE_COMPRESSION} -eq 1 ]] && [[ $COMPRESSED_OK -eq 1 ]] || echo "ERROR: Unable to backup ${VM_NAME} due to snapshot creation" >> ${VM_BACKUP_DIR}/STATUS.error
VM_FAILED=1
[[ "${VM_SUMMARY_STATUS}" = "UNKNOWN" ]] && VM_SUMMARY_STATUS="ERROR:Snapshot creation failed."
elif [[ ${VM_VMDK_FAILED} -ne 0 ]] ; then
logger "info" "ERROR: Unable to backup ${VM_NAME} due to error in VMDK backup!\n"
[[ ${ENABLE_COMPRESSION} -eq 1 ]] && [[ $COMPRESSED_OK -eq 1 ]] || echo "ERROR: Unable to backup ${VM_NAME} due to error in VMDK backup" >> ${VM_BACKUP_DIR}/STATUS.error
VMDK_FAILED=1
[[ "${VM_SUMMARY_STATUS}" = "UNKNOWN" ]] && VM_SUMMARY_STATUS="ERROR:VMDK backup failed."
elif [[ ${VM_HAS_INDEPENDENT_DISKS} -eq 1 ]] ; then
logger "info" "WARN: ${VM_NAME} has some Independent VMDKs that can not be backed up!\n";
[[ ${ENABLE_COMPRESSION} -eq 1 ]] && [[ $COMPRESSED_OK -eq 1 ]] || echo "WARN: ${VM_NAME} has some Independent VMDKs that can not be backed up" > ${VM_BACKUP_DIR}/STATUS.warn
VMDK_FAILED=1
[[ "${VM_SUMMARY_STATUS}" = "UNKNOWN" ]] && VM_SUMMARY_STATUS="WARN:Independent VMDKs not backed up."
#experimental
#create symlink for the very last backup to support rsync functionality for additinal replication
if [[ "${RSYNC_LINK}" -eq 1 ]] ; then
Expand All @@ -1196,6 +1238,9 @@ ghettoVCB() {
else
logger "info" "Successfully completed backup for ${VM_NAME}!\n"
[[ ${ENABLE_COMPRESSION} -eq 1 ]] && [[ $COMPRESSED_OK -eq 1 ]] || echo "Successfully completed backup" > ${VM_BACKUP_DIR}/STATUS.ok

[[ ${ENABLE_COMPRESSION} -eq 1 ]] && [[ $COMPRESSED_OK -ne 1 ]] && VM_SUMMARY_STATUS="WARN:Backup compression failed."
[[ "${VM_SUMMARY_STATUS}" = "UNKNOWN" ]] && VM_SUMMARY_STATUS="SUCCESS:Backup completed"
VM_OK=1

#experimental
Expand Down Expand Up @@ -1230,6 +1275,7 @@ ghettoVCB() {
fi
fi
fi
summary_logger "${VM_NAME}" "${VM_SUMMARY_STATUS}"
done
# UNTESTED CODE
# Why is this outside of the main loop & it looks like checkVMBackupRotation() could be called twice?
Expand Down Expand Up @@ -1401,7 +1447,7 @@ if [[ $# -lt 1 ]] || [[ $# -gt 12 ]]; then
fi

#read user input
while getopts ":af:c:g:w:m:l:d:e:" ARGS; do
while getopts ":af:c:g:w:m:l:d:e:s:" ARGS; do
case $ARGS in
w)
WORKDIR="${OPTARG}"
Expand Down Expand Up @@ -1435,6 +1481,9 @@ while getopts ":af:c:g:w:m:l:d:e:" ARGS; do
d)
LOG_LEVEL="${OPTARG}"
;;
s)
SUMMARY_LOG="${OPTARG}"
;;
:)
echo "Option -${OPTARG} requires an argument."
exit 1
Expand Down