Huey

Scout supports Huey 2.0+.

Add the following to instrument your Huey application:

1. Install the scout-apm package:

pip install scout-apm

2. If you are using Huey’s Django integration, you only need to set up the Django integration. Your Huey instance will be automatically instrumented.

If you’re using Huey outside of the Django integration, add Scout to your Huey instance:

from huey import SqliteHuey
from scout_apm.api import Config
from scout_apm.huey import attach_scout

broker = SqliteHuey()

 Config.set(
    monitor=True,
    name="A FRIENDLY NAME FOR YOUR APP",
    key="[AVAILABLE IN THE SCOUT UI]",
)
attach_scout(huey)

If you wish to configure Scout via environment variables, use SCOUT_MONITOR, SCOUT_NAME and SCOUT_KEY instead of calling Config.set().

If you’ve installed Scout via the Heroku Addon, the provisioning process automatically sets SCOUT_MONITOR and SCOUT_KEY via config vars. Only SCOUT_NAME is required.

3. Deploy.

It takes approximatively five minutes for your data to first appear within the Scout UI.

Tasks will appear in the “Background Jobs” area of the Scout UI.