celery-exporter

(β˜… 559)

A Prometheus exporter for Celery metrics

  • .coveragerc
  • .dockerignore
  • .envrc
  • .gitignore
  • .pre-commit-config.yaml
  • .pylintrc
  • .python-version
  • buildInstaller.sh
  • cli.py
  • conftest.py
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.pyinstaller
  • jsonnetfile.json
  • jsonnetfile.lock.json
  • LICENSE.md
  • poetry.lock
  • pyproject.toml
  • pytest.ini
  • README.md
  • Taskfile.yml

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/danihodovic/celery-exporter

Downloads the entire project code from GitHub to your computer.

cd celery-exporter

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install prometheus-exporter-celery

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -p 9808:9808 danihodovic/celery-exporter --broker-url=redis://redis.service.consul/1

Runs the built image as an actual container.

docker run -p 9808:9808 -e CE_BROKER_URL=redis://redis danihodovic/celery-exporter

Runs the built image as an actual container.

docker run -p 9808:9808 danihodovic/celery-exporter --broker-url=redis://redis.service.consul/1 \

Runs the built image as an actual container.

docker run -p 9808:9808 danihodovic/celery-exporter --broker-url=sentinel://sentinel.service.consul/1 \

Runs the built image as an actual container.

docker-compose up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install prometheus-exporter-celery

Installs the package published on PyPI directly β€” no need to clone the source.

poetry install

Installs the libraries listed in pyproject.toml.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd celery-mixin/scripts

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd celery-mixin

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation