Improving cron logging and doco

Author: keith-moss

django/demsausage/app/sausage/cron/cron.py

@@ -8,16 +8,26 @@
 from demsausage.app.enums import StallStatus  # noqa: E402
 from demsausage.app.models import Stalls  # noqa: E402
 from demsausage.app.sausage.mailgun import (  # noqa: E402
-    send_monthly_reminder_heartbeat_email, send_pending_stall_reminder_email)
+    send_monthly_reminder_heartbeat_email,
+    send_pending_stall_reminder_email,
+)
 
+print("Sending monthly reminder heartbeat email...")
 send_monthly_reminder_heartbeat_email()
+print("Monthly reminder heartbeat email sent")
 
+print("Checking for pending stalls...")
 pending_stall_count = Stalls.objects.filter(status=StallStatus.PENDING).count()
+print(f"Found {pending_stall_count} pending stall(s)")
 
 if pending_stall_count > 0:
+    print(f"Sending pending stall reminder email for {pending_stall_count} stall(s)...")
     try:
         send_pending_stall_reminder_email(pending_stall_count)
+        print("Pending stall reminder email sent successfully")
     except Exception as e:
-        print(e)
+        print(f"Error sending pending stall reminder email: {e}")
+else:
+    print("No pending stalls, skipping reminder email")
 
-print("Fin")
+print("Cron job finished successfully")

django/demsausage/app/sausage/cron/cron.sh

@@ -1,3 +1,5 @@
 #!/bin/bash
 
-/usr/local/bin/python /app/demsausage/app/sausage/cron/cron.py
+echo "[$(date '+%Y-%m-%d %H:%M:%S')] Starting cron job"
+/usr/local/bin/python /app/demsausage/app/sausage/cron/cron.py
+echo "[$(date '+%Y-%m-%d %H:%M:%S')] Cron job completed"

django/demsausage/app/sausage/cron/crontab.txt

@@ -1,5 +1,9 @@
 SHELL=/bin/bash
 BASH_ENV=/app/demsausage/app/sausage/cron/demsausage.cron.env
-0 12 * * * /app/demsausage/app/sausage/cron/cron.sh >> /app/logs/cron/cron_output.log 2>&1
+
+# Daily cron job at midnight (00:00 UTC)
+# - Sends monthly reminder heartbeat email
+# - Checks for pending stalls and sends reminder emails if any exist
 0 0 * * * /app/demsausage/app/sausage/cron/cron.sh >> /app/logs/cron/cron_output.log 2>&1
+
 # Do not remove this new line, cron needs it