buswatch

#     _______   ____  ____   ________  __   __  ___       __  ___________  ______    __    __   
#    |   _  "\ ("  _||_ " | /"       )|"  |/  \|  "|     /""\("     _   ")/" _  "\  /" |  | "\  
#    (. |_)  :)|   (  ) : |(:   \___/ |'  /    \:  |    /    \)__/  \\__/(: ( \___)(:  (__)  :) 
#    |:     \/ (:  |  | . ) \___  \   |: /'        |   /' /\  \  \\_ /    \/ \      \/      \/  
#    (|  _  \\  \\ \__/ //   __/  \\   \//  /\'    |  //  __'  \ |.  |    //  \ _   //  __  \\  
#    |: |_)  :) /\\ __ //\  /" \   :)  /   /  \\   | /   /  \\  \\:  |   (:   _) \ (:  (  )  :) 
#    (_______/ (__________)(_______/  |___/    \___|(___/    \___)\__|    \_______) \__|  |__/  
#                                                                                               

A diagnostic TUI for monitoring Caryatid message bus activity.

Installation

From crates.io

cargo install buswatch

From source

cargo build -p buswatch --release

Usage

# Monitor a JSON file (default mode)
buswatch -f monitor.json

# Connect to a TCP stream
buswatch --connect localhost:9090

# Subscribe to RabbitMQ (requires --features subscribe)
buswatch --subscribe rabbitmq.toml --topic caryatid.monitor.snapshot

Options

Views

Controls

RabbitMQ Subscription

Build with the subscribe feature:

cargo build -p buswatch --features subscribe --release

Create a config file:

# rabbitmq.toml
[rabbitmq]
url = "amqp://127.0.0.1:5672/%2f"
exchange = "caryatid"

Enable publishing in your Caryatid process:

[monitor]
topic = "caryatid.monitor.snapshot"
frequency_secs = 5.0

[[message-router.route]]
pattern = "caryatid.monitor.*"
bus = "external"

Message Format

buswatch auto-detects the message format, supporting both:

• CBOR - Caryatid's native format (compact binary, used by default)
• JSON - Fallback for compatibility

No configuration needed - it just works.

Health Thresholds

Modules are marked unhealthy based on:

• Pending duration: Time waiting on reads/writes
• Unread count: Backlog of unread messages

A module's status is the worst across all its topics.

Library Usage

buswatch can also be used as a library for building custom monitoring solutions.

Add to your Cargo.toml:

[dependencies]
buswatch = "0.1"

Examples

See the examples directory for runnable examples:

• file_source.rs - Monitor from a JSON file
• channel_source.rs - Receive snapshots via channel
• stream_source.rs - Connect to a TCP stream

use buswatch::{App, FileSource, Thresholds};

let source = Box::new(FileSource::new("monitor.json"));
let app = App::new(source, Thresholds::default());

Features

Enable features:

cargo build --features subscribe

Or in Cargo.toml:

[dependencies]
buswatch = { version = "0.1", features = ["subscribe"] }

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.