172 lines
3.7 KiB
Markdown
172 lines
3.7 KiB
Markdown
# Cron Job Report Template — Bullet Style
|
|
|
|
Use this format for all cron job reports that deliver to Discord.
|
|
|
|
---
|
|
|
|
## Standard Header
|
|
|
|
```
|
|
## 🤖 [Job Name] Report — [Day, Month Date, Year]
|
|
|
|
**Check Time:** [Time] CT
|
|
```
|
|
|
|
---
|
|
|
|
## For Each Item Being Reported
|
|
|
|
### Success Format:
|
|
```
|
|
✅ **[Item Name]** — SUCCESS
|
|
• [Detail 1]: [Value]
|
|
• [Detail 2]: [Value]
|
|
• [Detail 3]: [Value]
|
|
```
|
|
|
|
### Failure Format:
|
|
```
|
|
❌ **[Item Name]** — FAILED
|
|
• [Detail 1]: [Value]
|
|
• Error: [Specific error message]
|
|
• Action Needed: [What to do]
|
|
```
|
|
|
|
### Warning Format:
|
|
```
|
|
⚠️ **[Item Name]** — WARNING
|
|
• [Detail 1]: [Value]
|
|
• Issue: [Description]
|
|
• Suggested: [Recommendation]
|
|
```
|
|
|
|
### Missed/Skipped Format:
|
|
```
|
|
⏸️ **[Item Name]** — MISSED
|
|
• Scheduled: [Time]
|
|
• Reason: [Why it didn't run]
|
|
• Next: [Next scheduled time]
|
|
```
|
|
|
|
---
|
|
|
|
## Summary Footer
|
|
|
|
```
|
|
---
|
|
|
|
**Summary:** [One line overview]
|
|
**Status:** [All clear / Attention required / X issues found]
|
|
**Next Check:** [When this runs again]
|
|
```
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
### Example 1: Job Verifier (Multiple Jobs)
|
|
```
|
|
## 🤖 Overnight Job Report — Wednesday, February 18, 2026
|
|
|
|
**Check Time:** 9:00 AM CT
|
|
|
|
✅ **Supermemory Backup** — SUCCESS
|
|
• Ran: 2:00 AM CT • Duration: 19.5s
|
|
• Document ID: sDny6ZVrdattvKjounQxRp
|
|
• Next: Tonight at 2:00 AM
|
|
|
|
✅ **Memory Worker Daily** — SUCCESS
|
|
• Ran: 3:01 AM CT • Duration: 44s
|
|
• Processed: 11KB daily notes
|
|
• Next: Tomorrow at 3:00 AM
|
|
|
|
✅ **Daily Cron Cleanup** — SUCCESS
|
|
• Ran: 3:00 AM CT • Duration: 82s
|
|
• Result: No cleanup needed (5 active jobs)
|
|
• Next: Tomorrow at 3:00 AM
|
|
|
|
✅ **Daily News Brief** — SUCCESS
|
|
• Ran: 8:00 AM CT • Duration: 108s
|
|
• Delivered: ~1,150 chars to #news-brief
|
|
• Next: Tomorrow at 8:00 AM
|
|
|
|
---
|
|
|
|
**Summary:** All 4 overnight jobs completed successfully.
|
|
**Status:** All systems green 🟢
|
|
**Next Check:** Tomorrow 9:00 AM CT
|
|
```
|
|
|
|
### Example 2: Single Task Report (Backup)
|
|
```
|
|
## 🤖 Supermemory Backup Report — Wednesday, February 18, 2026
|
|
|
|
✅ **Backup Job** — SUCCESS
|
|
• Ran: 2:00 AM CT • Duration: 19.5s
|
|
• Document ID: sDny6ZVrdattvKjounQxRp
|
|
• Status: Queued for cloud processing
|
|
• Last Backup: 24 hours ago
|
|
|
|
---
|
|
|
|
**Summary:** Backup completed and queued for Supermemory sync.
|
|
**Status:** All clear ✅
|
|
**Next Run:** Tonight at 2:00 AM CT
|
|
```
|
|
|
|
### Example 3: With Failures
|
|
```
|
|
## 🤖 System Check Report — Wednesday, February 18, 2026
|
|
|
|
✅ **Home Assistant** — SUCCESS
|
|
• Status: Online • Response: 45ms
|
|
• Last seen: Just now
|
|
|
|
❌ **Frigate NVR** — FAILED
|
|
• Status: Offline • Last seen: 3 hours ago
|
|
• Error: Connection timeout to port 5000
|
|
• Action Needed: Check if Frigate container is running
|
|
|
|
⚠️ **Nextcloud** — WARNING
|
|
• Status: Online • Response: 8.2s (slow)
|
|
• Issue: Response time degraded
|
|
• Suggested: Check server load
|
|
|
|
---
|
|
|
|
**Summary:** 1 failure and 1 warning require attention.
|
|
**Status:** Attention required ⚠️
|
|
**Next Check:** In 6 hours
|
|
```
|
|
|
|
---
|
|
|
|
## Key Rules
|
|
|
|
1. **Use bullet: •** (not - or *)
|
|
2. **One line per detail**
|
|
3. **Always include timestamps**
|
|
4. **Duration when applicable**
|
|
5. **Next run time if relevant**
|
|
6. **Summary line at end**
|
|
7. **Keep under 2000 characters** (Discord limit)
|
|
|
|
---
|
|
|
|
## Status Icons Reference
|
|
|
|
| Icon | Meaning | Use When |
|
|
|------|---------|----------|
|
|
| ✅ | Success | Job/task completed as expected |
|
|
| ❌ | Failed | Error occurred, manual intervention needed |
|
|
| ⚠️ | Warning | Succeeded but with issues or degraded performance |
|
|
| ⏸️ | Missed/Skipped | Didn't run (not an error, just didn't trigger) |
|
|
| 🔄 | In Progress | Currently running, check back later |
|
|
| 📊 | Stats/Info | Purely informational, no action needed |
|
|
|
|
---
|
|
|
|
*Template Version: 1.0*
|
|
*Created: 2026-02-18*
|
|
*Applies to: All cron job reports to Discord*
|