Oxanus

https://docs.rs/oxanus/1.0.5
Admin
Oxanus is a Redis-backed job processing library for Rust that powers background job infrastructure...
Tokens:1,078
Snippets:16
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic Oxanus Setup and Job Processing

Source: https://docs.rs/oxanus

Illustrates setting up a component registry, storage, and running a basic job processing loop. Requires `serde` and `thiserror` for job serialization and error handling.

```rust
use oxanus::Storage;
use serde::{Serialize, Deserialize};

#[derive(oxanus::Registry)]
struct ComponentRegistry(oxanus::ComponentRegistry<MyContext, MyError>);

#[derive(Debug, thiserror::Error)]
enum MyError {}

#[derive(Debug, Clone)]
struct MyContext {}

#[derive(Debug, Serialize, Deserialize)]
struct MyJob {
    data: String,
}

#[derive(oxanus::Worker)]
struct MyWorker;

impl MyWorker {
    async fn process(&self, job: &MyJob, _ctx: &oxanus::JobContext) -> Result<(), MyError> {
        println!("Processing: {}", job.data);
        Ok(())
    }
}

#[derive(Serialize, oxanus::Queue)]
#[oxanus(key = "my_queue", concurrency = 2)]
struct MyQueue;

#[tokio::main]
async fn main() -> Result<(), oxanus::OxanusError> {
    let ctx = oxanus::ContextValue::new(MyContext {});
    let storage = Storage::builder().build_from_env()?;
    let config = ComponentRegistry::build_config(&storage)
        .with_graceful_shutdown(tokio::signal::ctrl_c());

    storage.enqueue(MyQueue, MyJob { data: "hello".into() }).await?;
    oxanus::run(config, ctx).await?;
    Ok(())
}
```

--------------------------------

### Expose Prometheus Metrics

Source: https://docs.rs/oxanus

Enable the 'prometheus' feature to expose metrics from the storage. The encoded metrics can then be served on a dedicated endpoint.

```rust
let metrics = storage.metrics().await?;
let output = metrics.encode_to_string()?;
// Serve `output` on your metrics endpoint
```

--------------------------------

### Add Oxanus Dependency

Source: https://docs.rs/oxanus

Add the oxanus crate to your project using Cargo.

```bash
cargo add oxanus
```

--------------------------------

### Integrate Oxanus Web Dashboard with Axum

Source: https://docs.rs/oxanus

Shows how to integrate the Oxanus web dashboard as a nested router within an Axum application. The dashboard provides monitoring and management UIs for jobs and queues.

```rust
use oxanus_web::OxanusWebState;

let config = ComponentRegistry::build_config(&storage)
    .with_graceful_shutdown(tokio::signal::ctrl_c());

let oxanus_router = oxanus_web::router(OxanusWebState::new(
    config.storage.clone(),
    config.catalog(),
    "/oxanus".to_string(),
));

let app = your_app_router().nest("/oxanus", oxanus_router);
```
Tokens:
Raw