judoscale-python 1.0.0rc1

Official Python adapter for Judoscale—the advanced autoscaler for Heroku

judoscale-python

This is the official Python adapter for Judoscale. You can use Judoscale without it, but this gives you request queue time metrics and job queue time (for supported job processors).

Installation

Add judoscale-python to your requirements.txt file:

judoscale-python >= 1.0.0.rc1

Then run this from a terminal to install the package:

pip install -r requirements.txt

Supported web frameworks

• Django
• Flask
• FastAPI

Supported job processors

• Celery
• RQ

Using Judoscale with Django

Add Judoscale app to settings.py:

INSTALLED_APPS = [
    "judoscale.django",
    # ... other apps
]

Customize Judoscale options in settings.py (optional):

JUDOSCALE = {
    # LOG_LEVEL defaults to ENV["LOG_LEVEL"] or "INFO".
    "LOG_LEVEL": "DEBUG",

    # API_BASE_URL defaults to ENV["JUDOSCALE_URL"], which is set for you when you install Judoscale.
    # This is only exposed for testing purposes.
    "API_BASE_URL": "https://example.com",

    # REPORT_INTERVAL_SECONDS defaults to 10 seconds.
    "REPORT_INTERVAL_SECONDS": 5,
}

Once deployed, you will see your request queue time metrics available in the Judoscale UI.