Documentation

Get CeleryRadar wired into your Celery app in about five minutes. The rest of these pages explain exactly what the SDK is doing inside your worker process.

Quick start

1. Install the SDK

pip install celeryradar-sdk

View source on GitHub

The package supports Python 3.9+ and Celery 5.x. It depends on redis for queue depth polling; everything else is stdlib.

2. Grab your API key

Sign up at celeryradar.com and copy the API key shown on the settings page. It's revealed once at signup; copy it now or you'll need to regenerate. Treat it like a secret — anyone with it can write to your account's ingest endpoint.

Your account starts with one environment, named production. On Developer or Business plans you can add more (staging, dev, etc.); each environment has its own API key, use a different one per deploy target so prod data stays isolated. See Environments.

3. Connect from your Celery app

Call celeryradar_sdk.connect() once during application startup, after your Celery app is created. A natural spot is wherever you call app = Celery(...):

import celeryradar_sdk
from celery import Celery

app = Celery('myapp', broker='redis://localhost:6379/0')

celeryradar_sdk.connect(api_key='cr_live_...', app_name='myapp')

app_name identifies this Celery app within your account. If you run multiple Celery apps under one API key, give each a distinct name (e.g. 'orders', 'workers'). See Configuration.

That's it. The SDK wires Celery's signal handlers, kicks off a background ingest thread, and starts a Redis-leader-elected queue depth poller. None of these block your worker's hot path.

4. Verify

Start your Celery worker and run any task. Within a few seconds it should appear on your overview page and in the task log. If nothing shows up, see Troubleshooting.

Where to next

About the dashboard

We've kept the dashboard self-explanatory on purpose. Column labels, range pills, and inline hints are meant to read without a manual. If something's unclear, that's a bug; tell us.