Skip to main content

CLI tool to inspect and purge Celery Redis queues

Project description

Celery Queue Manager

Python Version License

A powerful, interactive CLI tool to inspect, monitor, and clean up Celery queues backed by Redis.

Designed for developers and DevOps engineers who need to "deep scan" Redis databases, inspect task payloads, and selectively delete tasks without direct access to workers or application code.

✨ Features

  • Deep Scan: Automatically scans all Redis databases (0-15) to discover hidden Celery queues.
  • Payload Inspection: Decode and view the JSON content (args, task names, IDs) of queued items.
  • Selective Delete: Remove specific tasks based on wildcards (e.g., delete only *.send_email tasks).
  • Total Purge: Quickly empty an entire queue to reset the state.
  • Safe: Includes confirmation prompts before deleting any data.
  • Zero Dependencies: (On the server side) - Just requires Python and access to Redis.

📦 Installation

You can install this tool directly via pip.

Option 1: Install from Git (Recommended for Teams)

If this repository is hosted on GitHub/GitLab:

pip install git+https://github.com/mbroekman/celery-queue-manager.git

Option 2: Install Locally (For Development)

Clone this folder and run:

pip install .

Option 3: Install from PyPI (If published)

pip install celery-queue-manager

⚙️ Configuration

By default, the tool connects to redis://localhost:6379. To connect to a different Redis server (e.g., in Docker or Production), set the CELERY_REDIS_URL environment variable before running the tool.

Linux/Mac:

export CELERY_REDIS_URL="redis://user:password@192.168.1.50:6379/0"

Windows (PowerShell):

$env:CELERY_REDIS_URL="redis://user:password@192.168.1.50:6379/0"

🚀 Usage

After installation, the command celery-manager is available globally in your terminal.

celery-manager

Interactive Menu

The tool will scan your Redis instance and present a menu:

--- Found Queues ---
1. [DB 0] celery                (Items: 42)
2. [DB 1] high_priority         (Items: 1500)

Options:
Type the queue NUMBER to select it.
Type 'q' to quit.

Actions

Once a queue is selected, you can:

  1. INSPECT CONTENT: Peeks at the top 5 tasks (shows Task Name, ID, and Args).
  2. PURGE ENTIRE QUEUE: Removes ALL items from the list.
  3. DELETE SPECIFIC TASKS: Prompts for a wildcard pattern (e.g., *invoice*) and removes only matching tasks.

🛠 Development

To build this package yourself (e.g., to create a .whl file):

  1. Install build tools:
    pip install build
    
  2. Build the package:
    python -m build
    
  3. The artifacts will appear in the dist/ directory.

👨‍💻 Creator

Created by: [Jouw Naam]

📄 License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

celery_queue_manager-1.0.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file celery_queue_manager-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for celery_queue_manager-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c57d77562a52a3ec186334e1f375ab3abc4065f5f64c02a01466a15bf7a0996e
MD5 c0ea4a2c2a496de82971d06aa1e900dc
BLAKE2b-256 bcbd3097c61fd4626e2cbefabf46c799c2c5e384043ebc10b16764bfb4abc782

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page