Struct Meter

pub struct Meter(/* private fields */);

A wrapper around original self_meter::Meter that locks internal mutex on most operations and maybe used in multiple threads safely.

Implementations

impl Meter

pub fn new() -> Meter

Create a new meter with specified scan iterval of one second

pub fn spawn_scanner(&self, handle: &Handle)

Adds a scanner coroutine to tokio main loop

This must be called once per process (not per thread or tokio loop)

pub fn serialize<W: Write>(&self, buf: W)

Serialize response into JSON

pub fn report(&self) -> Report<'_>

Get serializable report

pub fn process_report(&self) -> ProcessReport<'_>

Get serializable report for process data

This is a part of report() / Report, and is needed for fine-grained serialization control.

pub fn thread_report(&self) -> ThreadReport<'_>

Get serializable report for thread data

This is a part of report() / Report, and is needed for fine-grained serialization control.

pub fn respond<S>(&self, e: Encoder<S>) -> EncoderDone<S>

Same as serialize but also adds required HTTP headers

pub fn track_thread(&self, tid: Pid, name: &str)

Start tracking specified thread

Note: you must add main thread here manually. Usually you should use track_current_thread() instead.

pub fn untrack_thread(&self, tid: Pid)

Stop tracking specified thread (for example if it’s dead)

pub fn track_current_thread(&self, name: &str) -> Pid

Add current thread using track_thread, returns thread id

pub fn track_current_thread_by_name(&self)

Track current thread by using name from std::thread::current().name()

This may not work if thread has no name, use track_current_thread if thread has no own name or if you’re unsure.

Panics

If no thread is set.

pub fn untrack_current_thread(&self)

Remove current thread using untrack_thread

Trait Implementations

impl Clone for Meter

fn clone(&self) -> Meter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Meter

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

Formats the value using the given formatter.