Broker-agnostic admin panel for Taskiq

Standalone admin panel with task results storage in SQLite or Postgres database

• Broker-agnostic admin panel for Taskiq
  • Previews
  • Usage
  • Docker Compose Example
  • Running without Docker
  • Task States
  • Development

Previews

Tasks Page	Task Details Page

Usage

1. Import and connect the middleware to the broker:

...
fromtaskiq.middlewares.taskiq_admin_middlewareimportTaskiqAdminMiddlewarebroker= (
RedisStreamBroker(
url=redis_url,
queue_name="my_lovely_queue",
)
.with_result_backend(result_backend)
.with_middlewares(
TaskiqAdminMiddleware(
url="http://localhost:3000", # the url to your taskiq-admin instanceapi_token="supersecret", # any secret enough stringtaskiq_broker_name="mybroker",
)
)
)
...

2. Pull the image from GitHub Container Registry: docker pull ghcr.io/taskiq-python/taskiq-admin:latest

3. Replace TASKIQ_ADMIN_API_TOKEN with any secret enough string and run:

docker run -d --rm \
-p "3000:3000" \
-v "./taskiq-admin-data/:/usr/database/" \
-e "TASKIQ_ADMIN_API_TOKEN=supersecret" \
--name "taskiq-admin" \
"ghcr.io/taskiq-python/taskiq-admin:latest"

4. Go to http://localhost:3000/tasks

Docker Compose Example

services:
queue:
build:
context: .dockerfile: ./Dockerfilecontainer_name: my_queuecommand: taskiq worker app.tasks.queue:broker --workers 1 --max-async-tasks 20environment:
- TASKIQ_ADMIN_URL=http://taskiq_admin:3000
- TASKIQ_ADMIN_API_TOKEN=supersecretdepends_on:
- redis
- taskiq_admintaskiq_admin:
image: ghcr.io/taskiq-python/taskiq-admin:latestcontainer_name: taskiq_adminports:
- 3000:3000environment:
- TASKIQ_ADMIN_API_TOKEN=supersecretvolumes:
- admin_data:/usr/database/volumes:
admin_data:

Running without Docker

1. cp env-example .env, enter .env file and fill in all needed variables
2. run make dev to run it locally in dev mode
3. run make prod to run it locally in prod mode

Environment variables for DB setup:

• TASKIQ_ADMIN_DB_DRIVER: required, one of sqlite or postgres
• TASKIQ_ADMIN_DB_FILE_PATH: required when TASKIQ_ADMIN_DB_DRIVER=sqlite
• TASKIQ_ADMIN_DB_URL: required when TASKIQ_ADMIN_DB_DRIVER=postgres

Task States

Let's assume we have a task 'do_smth', there are all states it can embrace:

1. queued - the task has been sent to the queue without an error
2. running - the task is grabbed by a worker and is being processed
3. success - the task is fully processed without any errors
4. failure - an error occured during the task processing
5. abandoned - taskiq-admin sets all 'running' tasks as 'abandoned' if there was a downtime between the time these tasks were in 'running' state and the time of next startup of taskiq-admin

Development

1. Run pnpm install to install all dependencies
2. Run pnpm db:push to create the sqlite database if needed
3. Run pnpm dev to run the project