cronsafe 1.0.0

Official Python SDK for CronSafe cron job monitoring

CronSafe Python SDK

Official Python SDK for CronSafe cron job monitoring.

Install

pip install cronsafe

Quick Start

from cronsafe import CronSafe

cs = CronSafe()

# Simple ping after your job completes
cs.ping("my-monitor-id")

# Track duration (start before, ping after)
cs.start("my-monitor-id")
run_backup()
cs.ping("my-monitor-id")

# Report failure with output
cs.fail("my-monitor-id", output="disk full")

# Context manager (recommended)
with cs.monitor("my-monitor-id"):
    run_backup()
    # Automatically sends /start, then /ping on success or /fail on error

Usage

Simple ping

Send a heartbeat after your job completes. If CronSafe does not receive the ping within the expected window, it fires an alert.

from cronsafe import CronSafe

cs = CronSafe()
cs.ping("nightly-backup")

Duration tracking

Send a /start ping before your job and a /ping after. CronSafe measures the time between them.

cs.start("nightly-backup")
run_backup()
cs.ping("nightly-backup")

Explicit failure

Report a failure immediately instead of waiting for a missed deadline. Include an optional output message that appears in your alert.

try:
    run_backup()
    cs.ping("nightly-backup")
except Exception as e:
    cs.fail("nightly-backup", output=str(e))
    raise

Context manager

The recommended way to monitor a job. Sends /start before the block, /ping on success, and /fail with the exception message on error.

with cs.monitor("nightly-backup"):
    run_backup()

Wrap a function

Same as the context manager but for a callable.

result = cs.wrap("nightly-backup", run_backup, arg1, arg2)

Custom API URL

cs = CronSafe(base_url="https://your-self-hosted-instance.com")

API key (optional)

cs = CronSafe(api_key="your-api-key")

API Reference

Method	Description
ping(monitor_id)	Heartbeat ping. Send after job completes.
start(monitor_id)	Start a timed run. Send before job starts.
fail(monitor_id, output=None)	Report failure. Alert fires immediately.
wrap(monitor_id, func, *args, **kwargs)	Run a function with automatic monitoring.
monitor(monitor_id)	Context manager for automatic monitoring.

Full documentation at getcronsafe.com/docs.

Links

• CronSafe
• Documentation
• Status