sioncronaich 0.4.0

Capture stdout, stderr and exit codes from cron jobs and view them in a web UI

sioncronaich - A lightweight cron-job monitoring tool written in Python - from Gaelic "to synchronise, to chronicle"

sioncronaich wraps any shell command, captures its stdout, stderr and exit code, then POSTs the result to the sioncronaich web app, which stores everything in a local SQLite database and renders it in a simple web dashboard.

---

Quick start

1 — Start the web app

uv run uvicorn --factory sioncronaich.app:create_app --host 127.0.0.1 --port 8716

Pass --host, --port, and any other server options directly to uvicorn. See uvicorn --help for the full list.

The app reads the following environment variables:

Environment variable	Default	Purpose
SIONCRONAICH_DB	~/.local/share/sioncronaich/jobs.db	SQLite database path
SIONCRONAICH_ROOT_PATH	/sioncronaich	ASGI root path when mounted behind a reverse proxy
LOG_CONFIG	(unset — logs to stderr at INFO)	Path to a YAML logging config file

2 — Wrap a command

sioncronaich --name "daily-backup" -- /usr/local/bin/backup.sh --full

The wrapper exits with the same exit code as the wrapped command, so existing cron alerting is unaffected. If posting to the web app fails, the error is printed to stderr but the exit code is still that of the wrapped job.

Usage: sioncronaich [OPTIONS] COMMAND...

Options:
  --name TEXT      Human-readable label for this job  [required]
  --endpoint TEXT  URL of the POST /jobs endpoint
                   [default: http://127.0.0.1:8716/jobs]
    --timeout INT    HTTP request timeout in seconds  [default: 10]

The endpoint can also be set via the SIONCRONAICH_ENDPOINT environment variable so you don't have to repeat it in every crontab entry. The --endpoint flag takes precedence if both are set.

export SIONCRONAICH_ENDPOINT=http://mon.example.com/sioncronaich/jobs

3 — Add to crontab

# m   h  dom mon dow  command
0     3  *   *   *    sioncronaich --name daily-backup -- /usr/local/bin/backup.sh
*/5   *  *   *   *    sioncronaich --name health-check -- /usr/local/bin/check.sh

4 — View the dashboard

Open http://127.0.0.1:8716 in a browser for a colour-coded table of recent job runs. stdout / stderr are available in collapsible panels.

The raw JSON API is also available:

Method	Path	Description
POST	/jobs	Ingest a new job result (used by sioncronaich)
GET	/jobs	List job results as JSON (newest first)
GET	/	HTML dashboard

Interactive API docs are served at http://127.0.0.1:8716/docs.

---

Reverse proxy with Caddy

sioncronaich is designed to be mounted at a sub-path behind a reverse proxy. The default sub-path is /sioncronaich; override it with SIONCRONAICH_ROOT_PATH.

example.com {
        reverse_proxy /sioncronaich/* 127.0.0.1:8716
        reverse_proxy /sioncronaich* 127.0.0.1:8716
}

Start the app with the matching root path:

SIONCRONAICH_ROOT_PATH=/sioncronaich \
  uv run uvicorn --factory sioncronaich.app:create_app --host 127.0.0.1 --port 8716

The dashboard is then available at https://example.com/sioncronaich and the ingest endpoint at https://example.com/sioncronaich/jobs.

---

Logging

By default the app logs to stderr at INFO level. To use a custom logging configuration, point LOG_CONFIG at a YAML file in the standard logging.config.dictConfig format. A ready-to-use example is provided at logging.yaml:

LOG_CONFIG=logging.yaml uv run uvicorn --factory sioncronaich.app:create_app

---

Development

uv sync --all-extras
uv run prek install