39 releases
0.6.0-rc.8 | Oct 11, 2024 |
---|---|
0.6.0-rc.5 | Jul 25, 2024 |
0.5.5 | Sep 5, 2024 |
0.5.1 | Mar 13, 2024 |
0.2.0 | May 14, 2021 |
#200 in Asynchronous
13,077 downloads per month
Used in 5 crates
(via apalis)
280KB
6K
SLoC
apalis
Features
- Simple and predictable job handling model.
- Jobs handlers with a macro free API.
- Take full advantage of the tower ecosystem of middleware, services, and utilities.
- Runtime agnostic - Use tokio, smol etc.
- Optional Web interface to help you manage your jobs.
apalis job processing is powered by tower::Service
which means you have access to the tower middleware.
apalis has support for:
Source | Crate | Example |
---|---|---|
Cron Jobs | ||
Redis | ||
Sqlite | ||
Postgres | ||
MySQL | ||
Amqp | ||
From Scratch |
Getting Started
To get started, just add to Cargo.toml
[dependencies]
apalis = { version = "0.6" }
apalis-redis = { version = "0.6" }
# apalis-sql = { version = "0.6", features = ["postgres"] } # or mysql, sqlite
Usage
use apalis::prelude::*;
use apalis_redis::{RedisStorage, Config};
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize)]
struct Email {
to: String,
}
/// A function that will be converted into a service.
async fn send_email(job: Email, data: Data<usize>) -> Result<(), Error> {
/// execute job
Ok(())
}
#[tokio::main]
async fn main() -> {
std::env::set_var("RUST_LOG", "debug");
env_logger::init();
let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
let storage = RedisStorage::new(conn);
Monitor::new()
.register_with_count(2, {
WorkerBuilder::new(format!("email-worker"))
.data(0usize)
.backend(storage)
.build_fn(send_email)
})
.run()
.await
}
Then
//This can be in another part of the program or another application eg a http server
async fn produce_route_jobs(storage: &RedisStorage<Email>) -> Result<()> {
let mut storage = storage.clone();
storage
.push(Email {
to: "test@example.com".to_string(),
})
.await?;
}
Feature flags
- tracing (enabled by default) — Support Tracing 👀
- sentry — Support for Sentry exception and performance monitoring
- prometheus — Support Prometheus metrics
- retry — Support direct retrying jobs
- timeout — Support timeouts on jobs
- limit — 💪 Limit the amount of jobs
- filter — Support filtering jobs based on a predicate
- catch-panic - Catch panics that occur during execution
Storage Comparison
Since we provide a few storage solutions, here is a table comparing them:
Feature | Redis | Sqlite | Postgres | Sled | Mysql | Mongo | Cron |
---|---|---|---|---|---|---|---|
Scheduled jobs | ✓ | ✓ | ✓ | x | ✓ | x | ✓ |
Retry jobs | ✓ | ✓ | ✓ | x | ✓ | x | ✓ |
Persistence | ✓ | ✓ | ✓ | x | ✓ | x | BYO |
Rerun Dead jobs | ✓ | ✓ | ✓ | x | ✓ | x | x |
How apalis works
Here is a basic example of how the core parts integrate
sequenceDiagram
participant App
participant Worker
participant Backend
App->>+Backend: Add job to queue
Backend-->>+Worker: Job data
Worker->>+Backend: Update job status to 'Running'
Worker->>+App: Started job
loop job execution
Worker-->>-App: Report job progress
end
Worker->>+Backend: Update job status to 'completed'
External examples
- Shuttle: Using apalis-cron with shuttle.rs
- Actix-Web: Using apalis-redis with actix-web
Projects using apalis
- Ryot: A self hosted platform for tracking various facets of your life - media, fitness etc.
- Summarizer: Podcast summarizer
- Universal Inbox: Universal Inbox is a solution that centralizes all your notifications and tasks in one place to create a unique inbox.
Resources
Web UI
If you are running apalis Board, you can easily manage your jobs. See a working rest API example here
Thanks to
- tower - Tower is a library of modular and reusable components for building robust networking clients and servers.
- redis-rs - Redis library for rust
- sqlx - The Rust SQL Toolkit
Roadmap
v 0.5
- Refactor the crates structure
- Mocking utilities
- Support for SurrealDB and Mongo
- Lock free for Postgres
- Add more utility layers
- Use extractors in job fn structure
- Polish up documentation
- Improve and standardize apalis Board
- Benchmarks
v 0.4
- Move from actor based to layer based processing
- Graceful Shutdown
- Allow other types of executors apart from Tokio
- Mock/Test Worker
- Improve monitoring
- Add job progress via layer
- Add more sources
v 0.3
- Standardize API (Storage, Worker, Data, Middleware, Context )
- Introduce SQL
- Implement layers for Sentry and Tracing.
- Improve documentation
- Organized modules and features.
- Basic Web API Interface
- Sql Examples
- Sqlx migrations
v 0.2
- Redis Example
- Actix Web Example
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Njuguna Mureithi - Initial work - Njuguna Mureithi
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Dependencies
~37–51MB
~886K SLoC