Skip to main content

Crate asyncq_axum

Crate asyncq_axum 

Source
Expand description

Axum integration for asyncq — admin REST endpoints with Prometheus metrics.

§Setup

Mount the admin router on any path in your axum application:

use asyncq::{Queue, backends::InMemoryBackend};
use asyncq_axum::admin;
use axum::Router;

let queue = Queue::new(InMemoryBackend::new());
let app = Router::new()
    .nest("/admin", admin(queue))
    /* ... your other routes ... */;

§Endpoints

MethodPathDescription
GET/admin/queues/:nameStats for a queue
GET/admin/queues/:name/dlqDead-letter queue (paginated)
POST/admin/queues/:name/dlq/retry-allRequeue all dead jobs
DELETE/admin/queues/:name/dlq/:idRetry one dead job by ID
GET/admin/metricsPrometheus text metrics

Functions§

admin
Build the admin Router. Mount it with router.nest("/admin", admin(queue)).
admin_with_queues
Build the admin Router with live Prometheus metrics for the given queue names.