Cargo Features

[dependencies]
apalis = { version = "0.6.0-rc.4", default-features = false, features = ["tracing", "sentry", "prometheus", "retry", "timeout", "limit", "filter", "catch-panic", "async-std-comp", "tokio-comp", "layers", "docsrs", "ulid"] }
default = tokio-comp, tracing

These default features are set whenever apalis is added without default-features = false somewhere in the dependency tree.

tracing default layers?

Support Tracing 👀

Enables tracing and tracing-futures

Affects layers::tracing

sentry layers? = sentry-core, uuid

Support for Sentry exception and performance monitoring

Enables uuid of optional ulid

Affects layers::sentry

prometheus layers? = metrics, metrics-exporter-prometheus

Support Prometheus metrics

Affects layers::prometheus

retry layers?

Support direct retrying jobs

Enables retry of tower

Affects layers::retry

timeout layers?

Support timeouts on jobs

Enables timeout of tower

limit layers?

💪 Limit the amount of jobs

Enables limit of tower

Affects layers::limit

filter layers?

Support filtering jobs based on a predicate

Enables filter of tower

catch-panic layers?

Captures panics in executions and convert them to errors

Enables backtrace

Affects layers::catch_panic

async-std-comp = async-std

Compatibility with async-std and smol runtimes

Affects apalis::utils.AsyncStdExecutor

tokio-comp default = tokio

Compatibility with tokio and actix runtimes

Affects apalis::utils.TokioExecutor

layers = catch-panic, filter, limit, prometheus, retry, sentry, timeout, tracing
docsrs = document-features

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

tokio tokio-comp
async-std async-std-comp?
sentry-core sentry?
metrics prometheus?
metrics-exporter-prometheus prometheus?
uuid sentry?

Enables uuid

Needed only for sentry reporting

ulid implicit feature

Enables ulid

ulid:

a Universally Unique Lexicographically Sortable Identifier implementation

document-features docsrs?