Struct Instrumentor 

pub struct Instrumentor { /* private fields */ }

The main entry point for instrumenting a message bus.

An Instrumentor collects metrics from registered modules and periodically emits snapshots to configured outputs.

Example

use buswatch_sdk::{Instrumentor, Output};
use std::time::Duration;

#[tokio::main]
async fn main() {
    let instrumentor = Instrumentor::builder()
        .output(Output::file("metrics.json"))
        .interval(Duration::from_secs(1))
        .build();

    let handle = instrumentor.register("my-service");

    // Start background emission
    instrumentor.start();

    // Record some metrics
    handle.record_read("events", 10);
    handle.record_write("results", 10);

    // Keep the application running
    tokio::time::sleep(Duration::from_secs(5)).await;
}

Implementations

impl Instrumentor

pub fn new() -> Self

Create a new instrumentor with default settings.

By default, no outputs are configured and the interval is 1 second.

pub fn builder() -> InstrumentorBuilder

Create a builder for configuring the instrumentor.

pub fn register(&self, name: &str) -> ModuleHandle

Register a module and get a handle for recording metrics.

If a module with this name already exists, returns a handle to the existing module.

Arguments

• name - The module name (e.g., “order-processor”, “notification-sender”)

pub fn collect(&self) -> Snapshot

Collect a snapshot of all current metrics.

This is useful if you want to emit snapshots manually rather than using the background emission.

pub fn start(&self) -> EmissionHandle

Start background emission of snapshots.

This spawns a tokio task that periodically collects and emits snapshots to all configured outputs.

Returns a handle that can be used to stop the emission.

pub async fn emit_now(&self)

Emit a snapshot to all outputs immediately.

Trait Implementations

impl Debug for Instrumentor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Instrumentor

fn default() -> Self

Returns the “default value” for a type.