Struct TransactionMetrics 

pub struct TransactionMetrics {
    pub metrics: Arc<Mutex<MetricsReport>>,
}

Re-export the foundationdb crate for convenience. Tracks metrics for a transaction.

This struct maintains transaction metrics protected by a mutex to allow safe concurrent access.

Fields

metrics: Arc<Mutex<MetricsReport>>

All metrics for the transaction, organized by category

Implementations

impl TransactionMetrics

pub fn new() -> TransactionMetrics

Create a new instance of TransactionMetrics

pub fn set_read_version(&self, version: i64)

Set the read version for the transaction

Arguments

• version - The read version

pub fn set_commit_version(&self, version: i64)

Set the commit version for the transaction

Arguments

• version - The commit version

pub fn reset_current(&self)

Resets the current metrics and increments the retry counter in total metrics.

This method is called when a transaction is retried due to a conflict or other retryable error. It increments the retry count in the transaction info and resets the current metrics to zero. It also merges current custom metrics into total custom metrics before clearing them.

pub fn increment_retries(&self)

Increment the retry counter

pub fn report_metrics(&self, fdb_command: FdbCommand)

Reports metrics for a specific FDB command by incrementing the appropriate counters.

This method updates both the current and total metrics for the given command.

Arguments

• fdb_command - The FDB command to report metrics for

pub fn get_retries(&self) -> u64

Get the number of retries

Returns

• u64 - The number of retries

pub fn get_metrics_data(&self) -> MetricsReport

Returns a clone of all metrics data.

Returns

• MetricsData - A clone of all metrics data

pub fn get_transaction_info(&self) -> TransactionInfo

Returns a clone of the transaction information.

Returns

• TransactionInfo - A clone of the transaction information

pub fn set_custom(&self, name: &str, value: u64, labels: &[(&str, &str)])

Set a custom metric

Arguments

• name - The name of the metric
• value - The value to set
• labels - Key-value pairs for labeling the metric

pub fn increment_custom(&self, name: &str, amount: u64, labels: &[(&str, &str)])

Increment a custom metric

Arguments

• name - The name of the metric
• amount - The amount to increment by
• labels - Key-value pairs for labeling the metric

pub fn record_commit_time(&self, duration_ms: u64)

Record commit execution time

Arguments

• duration_ms - The duration of the commit execution in milliseconds

pub fn add_error_time(&self, duration_ms: u64)

Add an error execution time to the list

Arguments

• duration_ms - The duration of the error handling in milliseconds

pub fn set_execution_time(&self, duration_ms: u64)

Set the total execution time

Arguments

• duration_ms - The total duration of the transaction in milliseconds

pub fn get_total_error_time(&self) -> u64

Get the sum of all error handling times

Returns

• u64 - The total time spent handling errors in milliseconds

Trait Implementations

impl Clone for TransactionMetrics

fn clone(&self) -> TransactionMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionMetrics

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

Formats the value using the given formatter.

impl Default for TransactionMetrics

fn default() -> TransactionMetrics

Returns the “default value” for a type.