Merge pull request #28 from sil-org/uniform-msg

ensure app name is on every logged message

Author: briskt

application/backup.sh

@@ -4,7 +4,7 @@
 log() {
     local level="$1";
     local message="$2";
-    echo "[$(date '+%Y-%m-%d %H:%M:%S')] ${level}: ${message}";
+    echo "[$(date '+%Y-%m-%d %H:%M:%S')] ${level}: ${MYNAME}: ${message}";
 }
 
 # Function to remove sensitive values from sentry Event
@@ -41,7 +41,7 @@ error_to_sentry() {
 
     # Attempt to send event to Sentry
     if sentry-cli send-event \
-        --message "${error_message}" \
+        --message "${MYNAME}: ${error_message}" \
         --level error \
         --tag "database:${db_name}" \
         --tag "status:${status_code}"; then
@@ -56,8 +56,8 @@ error_to_sentry() {
 MYNAME="postgresql-backup-restore";
 STATUS=0;
 
-log "INFO" "${MYNAME}: backup: Started";
-log "INFO" "${MYNAME}: Backing up ${DB_NAME}";
+log "INFO" "backup: Started";
+log "INFO" "Backing up ${DB_NAME}";
 
 start=$(date +%s);
 $(PGPASSWORD=${DB_USERPASSWORD} pg_dump --host=${DB_HOST} --username=${DB_USER} --create --clean ${DB_OPTIONS} --dbname=${DB_NAME} > /tmp/${DB_NAME}.sql) || STATUS=$?;
@@ -68,81 +68,81 @@ export AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID:-$AWS_ACCESS_KEY}"
 export AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY:-$AWS_SECRET_KEY}"
 
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
+    error_message="FATAL: Backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}";
     exit $STATUS;
 else
-    log "INFO" "${MYNAME}: Backup of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds, ($(stat -c %s /tmp/${DB_NAME}.sql) bytes).";
+    log "INFO" "Backup of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds, ($(stat -c %s /tmp/${DB_NAME}.sql) bytes).";
 fi
 
 log "INFO" "Generating checksum for backup file"
 cd /tmp || {
-    error_message="${MYNAME}: FATAL: Failed to change directory to /tmp";
+    error_message="FATAL: Failed to change directory to /tmp";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "1";
     exit 1;
 }
 
 # Create checksum file format
 sha256sum "${DB_NAME}.sql" > "${DB_NAME}.sql.sha256" || {
-    error_message="${MYNAME}: FATAL: Failed to generate checksum for backup of ${DB_NAME}";
+    error_message="FATAL: Failed to generate checksum for backup of ${DB_NAME}";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "1";
     exit 1;
 }
 log "DEBUG" "Checksum file contents: $(cat "${DB_NAME}.sql.sha256")";
 
 # Validate checksum
-log "INFO" "${MYNAME}: Validating backup checksum";
-sha256sum -c "${DB_NAME}.sql.sha256" || {
-    error_message="${MYNAME}: FATAL: Checksum validation failed for backup of ${DB_NAME}";
+log "INFO" "Validating backup checksum";
+sha256sum --check --quiet "${DB_NAME}.sql.sha256" || {
+    error_message="FATAL: Checksum validation failed for backup of ${DB_NAME}";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "1";
     exit 1;
 }
-log "INFO" "${MYNAME}: Checksum validation successful";
+log "INFO" "Checksum validation successful";
 
 # Compression
 start=$(date +%s);
 gzip -f /tmp/${DB_NAME}.sql || STATUS=$?;
 end=$(date +%s);
 
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Compressing backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
+    error_message="FATAL: Compressing backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}";
     exit $STATUS;
 else
-    log "INFO" "${MYNAME}: Compressing backup of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
+    log "INFO" "Compressing backup of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
 fi
 
 # Compress checksum file
 gzip -f "${DB_NAME}.sql.sha256";
 if [ $? -ne 0 ]; then
-    log "WARN" "${MYNAME}: Failed to compress checksum file, but continuing backup process";
+    log "WARN" "Failed to compress checksum file, but continuing backup process";
 fi
 
 # Upload compressed backup file to S3
 start=$(date +%s);
-aws s3 cp "/tmp/${DB_NAME}.sql.gz" "${S3_BUCKET}/${DB_NAME}.sql.gz" || STATUS=$?
+aws s3 cp --quiet "/tmp/${DB_NAME}.sql.gz" "${S3_BUCKET}/${DB_NAME}.sql.gz" || STATUS=$?
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Copy backup to ${S3_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
+    error_message="FATAL: Copy backup to ${S3_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}";
     exit $STATUS;
 fi
 
 # Upload checksum file
-aws s3 cp "/tmp/${DB_NAME}.sql.sha256.gz" "${S3_BUCKET}/${DB_NAME}.sql.sha256.gz" || STATUS=$?;
+aws s3 cp --quiet "/tmp/${DB_NAME}.sql.sha256.gz" "${S3_BUCKET}/${DB_NAME}.sql.sha256.gz" || STATUS=$?;
 end=$(date +%s);
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Copy checksum to ${S3_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS).";
+    error_message="FATAL: Copy checksum to ${S3_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS).";
     log "ERROR" "${error_message}";
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}";
     exit $STATUS;
 else
-    log "INFO" "${MYNAME}: Copy backup and checksum to ${S3_BUCKET} of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
+    log "INFO" "Copy backup and checksum to ${S3_BUCKET} of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
 fi
 
 # Backblaze B2 Upload
@@ -155,20 +155,18 @@ if [ "${B2_BUCKET}" != "" ]; then
     STATUS=$?;
     end=$(date +%s);
     if [ $STATUS -ne 0 ]; then
-        error_message="${MYNAME}: FATAL: Copy backup to Backblaze B2 bucket ${B2_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
+        error_message="FATAL: Copy backup to Backblaze B2 bucket ${B2_BUCKET} of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds.";
         log "ERROR" "${error_message}";
         error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}";
         exit $STATUS;
     else
-        log "INFO" "${MYNAME}: Copy backup to Backblaze B2 bucket ${B2_BUCKET} of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
+        log "INFO" "Copy backup to Backblaze B2 bucket ${B2_BUCKET} of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds.";
     fi
 fi
 
-echo "postgresql-backup-restore: backup: Completed";
-
 # Clean up temporary files
 rm -f "/tmp/${DB_NAME}.sql.gz" "/tmp/${DB_NAME}.sql.sha256.gz";
 
-log "INFO" "${MYNAME}: backup: Completed";
+log "INFO" "backup: Completed";
 
 exit $STATUS;

application/restore.sh

@@ -4,7 +4,7 @@
 log() {
     local level="$1"
     local message="$2"
-    echo "[$(date '+%Y-%m-%d %H:%M:%S')] ${level}: ${message}"
+    echo "[$(date '+%Y-%m-%d %H:%M:%S')] ${level}: ${MYNAME}: ${message}"
 }
 
 filter_sensitive_values() {
@@ -55,78 +55,78 @@ error_to_sentry() {
 
 MYNAME="postgresql-backup-restore"
 STATUS=0
-log "INFO" "${MYNAME}: restore: Started"
+log "INFO" "restore: Started"
 
 # Ensure the database user exists.
-log "INFO" "${MYNAME}: checking for DB user ${DB_USER}"
+log "INFO" "checking for DB user ${DB_USER}"
 result=$(psql --host=${DB_HOST} --username=${DB_ROOTUSER} --command='\du' | grep ${DB_USER})
 if [ -z "${result}" ]; then
     result=$(psql --host=${DB_HOST} --username=${DB_ROOTUSER} --command="create role ${DB_USER} with login password '${DB_USERPASSWORD}' inherit;")
     if [ "${result}" != "CREATE ROLE" ]; then
         error_message="Create role command failed: ${result}"
-        log "ERROR" "${MYNAME}: FATAL: ${error_message}"
+        log "ERROR" "FATAL: ${error_message}"
         error_to_sentry "${error_message}" "${DB_NAME}" "1"
         exit 1
     fi
 fi
 
 # Delete database if it exists.
-log "INFO" "${MYNAME}: checking for DB ${DB_NAME}"
+log "INFO" "checking for DB ${DB_NAME}"
 result=$(psql --host=${DB_HOST} --username=${DB_ROOTUSER} --list | grep ${DB_NAME})
 if [ -z "${result}" ]; then
-    log "INFO" "${MYNAME}: INFO: Database \"${DB_NAME}\" on host \"${DB_HOST}\" does not exist."
+    log "INFO" "INFO: Database \"${DB_NAME}\" on host \"${DB_HOST}\" does not exist."
 else
-    log "INFO" "${MYNAME}: finding current owner of DB ${DB_NAME}"
+    log "INFO" "finding current owner of DB ${DB_NAME}"
     db_owner=$(psql --host=${DB_HOST} --username=${DB_ROOTUSER} --command='\list' | grep ${DB_NAME} | cut -d '|' -f 2 | sed -e 's/ *//g')
-    log "INFO" "${MYNAME}: INFO: Database owner is ${db_owner}"
+    log "INFO" "INFO: Database owner is ${db_owner}"
 
-    log "INFO" "${MYNAME}: deleting database ${DB_NAME}"
+    log "INFO" "deleting database ${DB_NAME}"
     result=$(psql --host=${DB_HOST} --dbname=postgres --username=${db_owner} --command="DROP DATABASE ${DB_NAME};")
     if [ "${result}" != "DROP DATABASE" ]; then
         error_message="Drop database command failed: ${result}"
-        log "ERROR" "${MYNAME}: FATAL: ${error_message}"
+        log "ERROR" "FATAL: ${error_message}"
         error_to_sentry "${error_message}" "${DB_NAME}" "1"
         exit 1
     fi
 fi
 
 # Download the backup and checksum files
-log "INFO" "${MYNAME}: copying database ${DB_NAME} backup and checksum from ${S3_BUCKET}"
+log "INFO" "copying database ${DB_NAME} backup and checksum from ${S3_BUCKET}"
 start=$(date +%s)
 
 # maintain backward compatibility with key variables accepted by s3cmd
 export AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID:-$AWS_ACCESS_KEY}"
 export AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY:-$AWS_SECRET_KEY}"
 
 # Download database backup
-aws s3 cp "${S3_BUCKET}/${DB_NAME}.sql.gz" "/tmp/${DB_NAME}.sql.gz" || STATUS=$?
+aws s3 cp --quiet "${S3_BUCKET}/${DB_NAME}.sql.gz" "/tmp/${DB_NAME}.sql.gz" || STATUS=$?
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Copy backup of ${DB_NAME} from ${S3_BUCKET} returned non-zero status ($STATUS) in $(expr $(date +%s) - ${start}) seconds."
+    error_message="FATAL: Copy backup of ${DB_NAME} from ${S3_BUCKET} returned non-zero status ($STATUS) in $(expr $(date +%s) - ${start}) seconds."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}"
     exit $STATUS
 fi
 
 # Download checksum file
-aws s3 cp "${S3_BUCKET}/${DB_NAME}.sql.sha256.gz" "/tmp/${DB_NAME}.sql.sha256.gz" || STATUS=$?
+aws s3 cp --quiet "${S3_BUCKET}/${DB_NAME}.sql.sha256.gz" "/tmp/${DB_NAME}.sql.sha256.gz" || STATUS=$?
 end=$(date +%s)
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Copy checksum of ${DB_NAME} from ${S3_BUCKET} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
+    error_message="FATAL: Copy checksum of ${DB_NAME} from ${S3_BUCKET} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}"
     exit $STATUS
 else
-    log "INFO" "${MYNAME}: Copy backup and checksum of ${DB_NAME} from ${S3_BUCKET} completed in $(expr ${end} - ${start}) seconds."
+    log "INFO" "Copy backup and checksum of ${DB_NAME} from ${S3_BUCKET} completed in $(expr ${end} - ${start}) seconds."
 fi
 
 # Decompress both files
-log "INFO" "${MYNAME}: decompressing backup and checksum of ${DB_NAME}"
+log "INFO" "decompressing backup and checksum of ${DB_NAME}"
 start=$(date +%s)
 
 # Decompress backup file
 gunzip -f /tmp/${DB_NAME}.sql.gz || STATUS=$?
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Decompressing backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr $(date +%s) - ${start}) seconds."
+    error_message="FATAL: Decompressing backup of ${DB_NAME} returned non-zero status ($STATUS) in $(expr $(date +%s) - ${start}) seconds."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}"
     exit $STATUS
@@ -136,61 +136,61 @@ fi
 gunzip -f /tmp/${DB_NAME}.sql.sha256.gz || STATUS=$?
 end=$(date +%s)
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Decompressing checksum of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
+    error_message="FATAL: Decompressing checksum of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}"
     exit $STATUS
 else
-    log "INFO" "${MYNAME}: Decompressing backup and checksum of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds."
+    log "INFO" "Decompressing backup and checksum of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds."
 fi
 
 # Validate the checksum
-log "INFO" "${MYNAME}: Validating backup integrity with checksum"
+log "INFO" "Validating backup integrity with checksum"
 cd /tmp || {
-    error_message="${MYNAME}: FATAL: Failed to change directory to /tmp"
+    error_message="FATAL: Failed to change directory to /tmp"
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "1"
     exit 1
 }
 
-sha256sum -c "${DB_NAME}.sql.sha256" || {
-    error_message="${MYNAME}: FATAL: Checksum validation failed for backup of ${DB_NAME}. The backup may be corrupted or tampered with."
+sha256sum --check --quiet "${DB_NAME}.sql.sha256" || {
+    error_message="FATAL: Checksum validation failed for backup of ${DB_NAME}. The backup may be corrupted or tampered with."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "1"
     exit 1
 }
-log "INFO" "${MYNAME}: Checksum validation successful - backup integrity confirmed"
+log "INFO" "Checksum validation successful - backup integrity confirmed"
 
 # Restore the database
-log "INFO" "${MYNAME}: restoring ${DB_NAME}"
+log "INFO" "restoring ${DB_NAME}"
 start=$(date +%s)
 psql --host=${DB_HOST} --username=${DB_ROOTUSER} --dbname=postgres ${DB_OPTIONS} < /tmp/${DB_NAME}.sql || STATUS=$?
 end=$(date +%s)
 
 if [ $STATUS -ne 0 ]; then
-    error_message="${MYNAME}: FATAL: Restore of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
+    error_message="FATAL: Restore of ${DB_NAME} returned non-zero status ($STATUS) in $(expr ${end} - ${start}) seconds."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "${STATUS}"
     exit $STATUS
 else
-    log "INFO" "${MYNAME}: Restore of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds."
+    log "INFO" "Restore of ${DB_NAME} completed in $(expr ${end} - ${start}) seconds."
 fi
 
 # Verify database restore success
-log "INFO" "${MYNAME}: Verifying database restore success"
+log "INFO" "Verifying database restore success"
 result=$(psql --host=${DB_HOST} --username=${DB_ROOTUSER} --list | grep ${DB_NAME})
 if [ -z "${result}" ]; then
-    error_message="${MYNAME}: FATAL: Database ${DB_NAME} not found after restore attempt."
+    error_message="FATAL: Database ${DB_NAME} not found after restore attempt."
     log "ERROR" "${error_message}"
     error_to_sentry "${error_message}" "${DB_NAME}" "1"
     exit 1
 else
-    log "INFO" "${MYNAME}: Database ${DB_NAME} successfully restored and verified."
+    log "INFO" "Database ${DB_NAME} successfully restored and verified."
 fi
 
 # Clean up temporary files
 rm -f "/tmp/${DB_NAME}.sql" "/tmp/${DB_NAME}.sql.sha256"
-log "INFO" "${MYNAME}: Temporary files cleaned up"
+log "INFO" "Temporary files cleaned up"
 
-log "INFO" "${MYNAME}: restore: Completed"
+log "INFO" "restore: Completed"
 exit $STATUS