Fast Celery Ping

A fast, self-contained Go alternative to Python's celery inspect ping command.

Goal is to be faster and more resource efficient that python's implementation.

Features

• Fast: Significantly faster than the Python implementation
• Self-contained: Single binary with no external dependencies
• Redis Support: Currently supports Redis broker with easy extensibility
• Compatible: Maintains compatibility with existing Celery deployments
• Configurable: Supports both environment variables and command-line flags

Installation

From Source

# Build from source
git clone <repository-url>
cd fast-celery-ping
go build -o fast-celery-ping

Using Docker

Pre-built Image (Recommended)

A ready-to-use Docker image is available on Docker Hub at @nazriel/fast-celery-ping:

# Pull the pre-built image
docker pull nazriel/fast-celery-ping

# Run with Docker
docker run --rm nazriel/fast-celery-ping --help

# Run with custom broker URL
docker run --rm nazriel/fast-celery-ping --broker-url redis://host.docker.internal:6379/0

Building from Source

The project also includes a Dockerfile for building your own image:

# Build Docker image from source
docker build -t fast-celery-ping .

# Run with Docker
docker run --rm fast-celery-ping --help

# Run with custom broker URL
docker run --rm fast-celery-ping --broker-url redis://host.docker.internal:6379/0

Usage

Basic Usage

# Use default Redis connection (redis://localhost:6379/0)
./fast-celery-ping

# Specify custom Redis URL
./fast-celery-ping --broker-url redis://localhost:6379/1

# Set custom timeout and verbose output
./fast-celery-ping --timeout 5s --verbose

# Output in JSON format instead of text
./fast-celery-ping --format json

# Show version information
./fast-celery-ping version

Configuration Options

Flag	Environment Variable	Default	Description
--broker-url	BROKER_URL	redis://localhost:6379/0	Broker connection URL (Redis/AMQP)
--timeout	BROKER_TIMEOUT	1.5s	Timeout for ping responses
--format	OUTPUT_FORMAT	text	Output format (json/text)
--database	BROKER_DB	0	Broker database number
--username	BROKER_USERNAME		Broker username
--password	BROKER_PASSWORD		Broker password
--verbose	VERBOSE	false	Enable verbose output

Examples

# Using environment variables
export BROKER_URL="redis://localhost:6379/2"
export BROKER_TIMEOUT="3s"
./fast-celery-ping

# Authentication with Redis
./fast-celery-ping --broker-url redis://localhost:6379/0 --username myuser --password mypass

# Text output format
./fast-celery-ping --format text
# Output: worker@hostname: OK pong
#         1 nodes online.

# JSON output format
./fast-celery-ping --format json
# Output: {
#           "worker@hostname": {
#             "ok": "pong"
#           }
#         }

# Version information
./fast-celery-ping version
# Output: fast-celery-ping version 1.0.0
#         Build time: 2024-01-15T10:30:45Z
#         Go version: go1.21.5
#         Platform: darwin/arm64

Architecture

The application is built with a modular architecture that supports easy extension:

• Broker Interface: Abstract interface for different message brokers
• Redis Implementation: Handles Celery's pidbox control message protocol
• Protocol Handler: Manages Celery-specific message formatting
• CLI Interface: Command-line interface built with Cobra

Performance

This Go implementation provides significant performance improvements over the Python version:

• Faster startup time (no interpreter overhead)
• Lower memory usage
• More efficient Redis connection handling
• Concurrent message processing

Future Enhancements

• RabbitMQ broker support
• Additional output formats (XML, YAML)
• Prometheus metrics integration
• Helm chart for Kubernetes deployments

Development

This project includes a Justfile for convenient development tasks using Just, a command runner similar to Make but simpler.

Using Just

If you have Just installed, you can use the predefined tasks:

# List all available tasks
just --list

# Build the application
just build

# Run tests
just test

# Run tests with coverage
just test-coverage

# Format code
just fmt

# Run linter
just lint

# Build for multiple platforms
just build-all

# Quick development test with Redis
just dev-test

# Build Docker image
just docker-build

Docker Development

The project includes a Dockerfile optimized for production use with multi-stage builds:

# Build Docker image manually
docker build -t fast-celery-ping:latest .

# Build multi-platform images (requires Docker Buildx)
docker buildx build --platform linux/amd64,linux/arm64 -t fast-celery-ping:latest .

# Run containerized application (using pre-built image)
docker run --rm nazriel/fast-celery-ping --broker-url redis://host.docker.internal:6379/0

# Run with environment variables (using pre-built image)
docker run --rm \
  -e BROKER_URL=redis://host.docker.internal:6379/0 \
  -e BROKER_TIMEOUT=3s \
  nazriel/fast-celery-ping

# Run locally built image
docker run --rm fast-celery-ping:latest --broker-url redis://host.docker.internal:6379/0

Manual Development (without Just)

# Run tests
go test ./...

# Format code
go fmt ./...

# Check for issues
go vet ./...

# Build for multiple platforms
GOOS=linux GOARCH=amd64 go build -o fast-celery-ping-linux-amd64
GOOS=darwin GOARCH=amd64 go build -o fast-celery-ping-darwin-amd64
GOOS=windows GOARCH=amd64 go build -o fast-celery-ping-windows-amd64.exe

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Contributing

Contributions are welcome! Please open issues or submit pull requests.