Struct ModuleHandle 

pub struct ModuleHandle { /* private fields */ }

A handle for recording metrics for a specific module.

This is the primary interface for instrumenting your message bus. Obtain a handle by calling Instrumentor::register().

Example

use buswatch_sdk::Instrumentor;

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

// Record a read from a topic
handle.record_read("orders.new", 1);

// Record a write to a topic
handle.record_write("orders.processed", 1);

// Track pending operations
let guard = handle.start_read("orders.new");
// ... do the read ...
drop(guard); // Clears pending state

Implementations

impl ModuleHandle

pub fn record_read(&self, topic: &str, count: u64)

Record that messages were read from a topic.

Arguments

• topic - The topic name
• count - Number of messages read

pub fn record_write(&self, topic: &str, count: u64)

Record that messages were written to a topic.

Arguments

• topic - The topic name
• count - Number of messages written

pub fn start_read(&self, topic: &str) -> PendingGuard

Start tracking a pending read operation.

Returns a guard that clears the pending state when dropped. This is useful for tracking how long reads are blocked.

Example

let guard = handle.start_read("events");
// ... blocking read operation ...
drop(guard); // Clears pending state
handle.record_read("events", 1);

pub fn start_write(&self, topic: &str) -> PendingGuard

Start tracking a pending write operation.

Returns a guard that clears the pending state when dropped. This is useful for tracking backpressure (slow consumers).

pub fn set_read_pending(&self, topic: &str, since: Option<Instant>)

Set the pending duration for a read directly.

Use this if you’re computing pending time yourself rather than using the guard-based API.

pub fn set_write_pending(&self, topic: &str, since: Option<Instant>)

Set the pending duration for a write directly.

pub fn name(&self) -> &str

Get the module name.

Trait Implementations

impl Clone for ModuleHandle

fn clone(&self) -> ModuleHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModuleHandle

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

Formats the value using the given formatter.