Struct TracingFacade

pub struct TracingFacade { /* private fields */ }

Perform tracing operations.

Note this object is shared among all threads created by server.

This facade does not hold onto a Tracing proxy as the server may be long-running while individual tests set up and tear down Tracing.

Implementations

impl TracingFacade

pub fn new() -> TracingFacade

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

Initialize a trace session.

A trace session allows for starting and stopping the collection of trace data. Trace data is then returned all at once when [terminate] is called.

For documentation on the args parameter, see InitializeRequest.

There can only be one trace session active on the system at a time. If there is a trace session from another controller active on the system, initialize may still return success, as trace_manager accepts the initialize_tracing call as a no-op. If needed, [terminate] may be used to ensure that no trace session is active on the system.

pub async fn start(&self) -> Result<Value, Error>

Start tracing.

There must be a trace session initialized through this facade, otherwise an error is returned. Within a trace session, tracing may be started and stopped multiple times.

pub async fn stop(&self) -> Result<Value, Error>

Stop tracing.

There must be a trace session initialized through this facade, otherwise an error is returned. Within a trace session, tracing may be started and stopped multiple times.

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

Terminate tracing and optionally download the trace data.

Any trace session on the system will be terminated whether initialized through this facade or through other means. Downloading trace data will only work for sessions initialized through this facade. Attempting to download trace data from another trace session will likely result in the request hanging as trace_manager will attempt to write the data to a socket with no readers.

For documentation on the args parameter, see TerminateRequest.

Trait Implementations

impl Debug for TracingFacade

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

Formats the value using the given formatter.

impl Facade for TracingFacade

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.