Struct WebDashboard 

pub struct WebDashboard { /* private fields */ }

Main web dashboard server.

The WebDashboard provides a complete web interface for monitoring and managing Hammerwork job queues. It includes REST API endpoints, WebSocket support for real-time updates, authentication, and a modern HTML/CSS/JS frontend.

Examples

use hammerwork_web::{WebDashboard, DashboardConfig};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = DashboardConfig::new()
        .with_bind_address("127.0.0.1", 8080)
        .with_database_url("postgresql://localhost/hammerwork")
        .with_static_dir(PathBuf::from("./assets"))
        .with_cors(false);

    let dashboard = WebDashboard::new(config).await?;
    dashboard.start().await?;

    Ok(())
}

Implementations

impl WebDashboard

pub async fn new(config: DashboardConfig) -> Result<Self>

Create a new web dashboard instance.

This initializes the dashboard with the provided configuration but does not start the web server. Call start() to begin serving requests.

Examples

use hammerwork_web::{WebDashboard, DashboardConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = DashboardConfig::new()
        .with_database_url("postgresql://localhost/hammerwork");

    let dashboard = WebDashboard::new(config).await?;
    // Dashboard is created but not yet started
    Ok(())
}

Errors

Returns an error if the configuration is invalid or if initialization fails.

pub fn with_event_manager(self, event_manager: Arc<EventManager>) -> Self

Also forward the job lifecycle events of event_manager to connected clients as they happen.

For a dashboard embedded in the same process as the workers that publish to event_manager. Without it (and in the standalone binary) the dashboard still pushes job and queue changes, by polling the database every websocket.live_update_interval; see crate::live.

pub async fn start(self) -> Result<()>

Start the web server.

The database backend is chosen from the scheme of database_url (postgres:///postgresql:// or mysql://), so with both the postgres and mysql features enabled the dashboard serves either kind of database.