Documentation Index
Fetch the complete documentation index at: https://docs.sluice.sh/llms.txt
Use this file to discover all available pages before exploring further.
See your Celery.
Sluice is a monitoring and management platform for Celery job queues. Connect your workers in under two minutes and get real-time visibility into every job, queue, and worker — with persistent history, search, and management actions that Flower never had.What you get
Real-time job streaming
Watch jobs flow through your queues as they happen. SSE-powered live updates with sub-second latency.
Search and filter
Find any job by name, state, queue, or worker. Filter failed jobs, search by task name, sort by duration.
Retry and revoke
Retry failed jobs or cancel running ones — individually or in bulk. Management actions Flower could never persist.
Persistent history
Every job is stored in Postgres with full state history and tracebacks. No more losing data when you refresh the page.
Two ways to connect
Sluice offers two integration paths — pick the one that fits your workflow:Python SDK
pip install sluice-celery — one import and one function call, auto-configures Celery events, richest data. Best for teams that own the Celery codebase.Docker Agent
docker run ghcr.io/sluice-sh/agent — zero code changes, reads Redis directly. Best for platform teams or when you can’t modify the application.How it works
The SDK hooks into Celery’s event system via a Bootstep. The Go agent subscribes to Redis PUB/SUB channels and reads broker keys directly. Both normalize events into Sluice’s unified data model and forward them to the Sluice API over HTTPS.Sluice uses framework-agnostic terminology throughout — “jobs” instead of “tasks”, unified state names instead of Celery-specific ones. This is intentional: the architecture supports multiple job queue frameworks (BullMQ, Sidekiq) in future versions.
Quick links
- SDK Quickstart — from zero to seeing data in under 2 minutes
- Agent Quickstart — Docker-based, no code changes
- SDK Reference — every
sluice.init()parameter documented - REST API Reference — all endpoints with request/response examples
- Troubleshooting — common issues and fixes