Struct sl4f_lib::system_metrics::facade::SystemMetricsFacade

pub struct SystemMetricsFacade {}

Implementations

impl SystemMetricsFacade

pub fn new() -> SystemMetricsFacade

pub async fn start_logging( &self, args: Value ) -> Result<CpuLoadLoggerResult, Error>

Start logging cpu load into trace events for a specified duration.

[start_logging] is preferred over [start_logging_forever] for automated tests, so that the logging session will end after some time even if the test fails to stop it due to failing or crashing.

pub async fn start_logging_forever( &self, args: Value ) -> Result<CpuLoadLoggerResult, Error>

Start logging cpu load into trace events until a call to [stop_logging].

pub async fn stop_logging( &self, _args: Value ) -> Result<CpuLoadLoggerResult, Error>

Stop cpu load logging.

This function will succeed even if cpu load logging is not in progress, so automated tests can call this before starting their logging session to clean up in case a prior test failed without stopping logging.

Trait Implementations

impl Debug for SystemMetricsFacade

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

Formats the value using the given formatter.

impl Facade for SystemMetricsFacade

fn handle_request<'life0, 'async_trait>( &'life0 self, method: String, args: Value ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Asynchronously handle the incoming request for the given method and arguments, returning a future object representing the pending operation.

fn cleanup(&self)

In response to a request to /cleanup, cleanup any cross-request state.

fn print(&self)

In response to a request to /print, log relevant facade state.