Trait scylla::history::HistoryListener

source · 
pub trait HistoryListener: Debug + Send + Sync {
    // Required methods
    fn log_query_start(&self) -> QueryId;
    fn log_query_success(&self, query_id: QueryId);
    fn log_query_error(&self, query_id: QueryId, error: &QueryError);
    fn log_new_speculative_fiber(&self, query_id: QueryId) -> SpeculativeId;
    fn log_attempt_start(
        &self,
        query_id: QueryId,
        speculative_id: Option<SpeculativeId>,
        node_addr: SocketAddr
    ) -> AttemptId;
    fn log_attempt_success(&self, attempt_id: AttemptId);
    fn log_attempt_error(
        &self,
        attempt_id: AttemptId,
        error: &QueryError,
        retry_decision: &RetryDecision
    );
}
Expand description

Any type implementing this trait can be passed to Session to collect execution history of specific queries.
In order to use it call set_history_listener on Query, PreparedStatement, etc…
The listener has to generate unique IDs for new queries, attempts and speculative fibers. These ids are then used by the caller to identify them.
It’s important to note that even after a query is finished there still might come events related to it. These events come from speculative futures that didn’t notice the query is done already.

Required Methods§

source

fn log_query_start(&self) -> QueryId

Log that a query has started on query start - right after the call to Session::query.

source

fn log_query_success(&self, query_id: QueryId)

Log that query was successful - called right before returning the result from Session::query, execute, etc.

source

fn log_query_error(&self, query_id: QueryId, error: &QueryError)

Log that query ended with an error - called right before returning the error from Session::query, execute, etc.

source

fn log_new_speculative_fiber(&self, query_id: QueryId) -> SpeculativeId

Log that a new speculative fiber has started.

source

fn log_attempt_start( &self, query_id: QueryId, speculative_id: Option<SpeculativeId>, node_addr: SocketAddr ) -> AttemptId

Log that an attempt has started - request has been sent on some Connection, now awaiting for an answer.

source

fn log_attempt_success(&self, attempt_id: AttemptId)

Log that an attempt succeeded.

source

fn log_attempt_error( &self, attempt_id: AttemptId, error: &QueryError, retry_decision: &RetryDecision )

Log that an attempt ended with an error. The error and decision whether to retry the attempt are also included in the log.

Implementors§