Getting Started with SilentCanary

1 Create Your First Canary

2 Get Your Check-in URL

After creating your canary, you'll see a unique check-in URL on your dashboard:

3 Add Check-ins to Your Process

Add a simple HTTP request to your process. Here are examples for different scenarios:

• cURL
• Bash Script
• Python
• Cron Job

curl "https://silentcanary.com/checkin/your-token-here"

curl -X POST "https://silentcanary.com/checkin/your-token-here" \
     -d "status=success" \
     -d "message=Backup completed successfully"

#!/bin/bash
# database-backup.sh

CANARY_URL="https://silentcanary.com/checkin/your-token-here"
BACKUP_DIR="/backups/database"
DATE=$(date +%Y%m%d_%H%M%S)

echo "Starting database backup..."

# Your backup commands here
pg_dump -h localhost -U postgres mydb > "$BACKUP_DIR/backup_$DATE.sql"

# Check if backup was successful
if [ $? -eq 0 ]; then
    echo "Backup completed successfully"
    # Notify SilentCanary of success
    curl -X POST "$CANARY_URL" \
         -d "status=success" \
         -d "message=Database backup completed at $DATE"
else
    echo "Backup failed!"
    # You could optionally notify of failure too
    curl -X POST "$CANARY_URL" \
         -d "status=failed" \
         -d "message=Database backup failed at $DATE"
    exit 1
fi

#!/usr/bin/env python3
import requests
import sys
from datetime import datetime

CANARY_URL = "https://silentcanary.com/checkin/your-token-here"

def notify_silentcanary(status="success", message=""):
    """Send check-in to SilentCanary"""
    try:
        data = {"status": status, "message": message}
        response = requests.post(CANARY_URL, data=data, timeout=10)
        if response.status_code == 200:
            print(f"✅ SilentCanary notified: {status}")
        else:
            print(f"❌ SilentCanary notification failed: {response.status_code}")
    except Exception as e:
        print(f"❌ Error notifying SilentCanary: {e}")

def main():
    """Your main process logic"""
    try:
        print("Starting data processing...")
        
        # Your actual work here
        # process_data()
        # generate_reports()
        
        print("Processing completed successfully")
        notify_silentcanary("success", f"Data processing completed at {datetime.now()}")
        
    except Exception as e:
        print(f"❌ Processing failed: {e}")
        notify_silentcanary("failed", f"Data processing failed: {str(e)}")
        sys.exit(1)

if __name__ == "__main__":
    main()

# Edit your crontab with: crontab -e

# Daily backup at 2 AM
0 2 * * * /path/to/backup-script.sh && curl "https://silentcanary.com/checkin/your-token"

# Hourly health check
0 * * * * /path/to/health-check.py && curl -X POST "https://silentcanary.com/checkin/your-token" -d "status=healthy"

# Weekly report generation (Sundays at 6 AM)
0 6 * * 0 /path/to/weekly-report.sh && curl "https://silentcanary.com/checkin/your-token"

# Multiple commands with error handling
*/30 * * * * /path/to/sync-script.sh && curl "https://silentcanary.com/checkin/your-token" || curl -X POST "https://silentcanary.com/checkin/your-token" -d "status=failed"

4 Test Your Setup

# Test successful check-in
curl "https://silentcanary.com/checkin/your-token"

# Test with status data
curl -X POST "https://silentcanary.com/checkin/your-token" \
     -d "status=testing" \
     -d "message=Manual test from terminal"

5 Explore Advanced Features

Common Gotchas