Struct MetricsStoreOverlay

struct MetricsStoreOverlay {
    overlay: SledDbOverlayPtr,
    db: Db,
}

The MetricsStoreOverlay provides write operations for managing metrics in conjunction with the underlying sled database. It supports inserting new [GasData] into the stored accumulated metrics, adding transaction gas data, and reverting metric changes after a specified height.

Fields

overlay: SledDbOverlayPtr

Pointer to the overlay used for accessing and performing database write operations to the store.

db: Db

Pointer managed by the MetricsStore that references the sled instance on which the overlay operates.

Implementations

impl MetricsStoreOverlay

pub fn new(db: Db) -> Result<Self>

Instantiate a MetricsStoreOverlay over the provided [SledDbPtr] instance.

pub fn insert_gas_metrics( &self, block_height: u32, block_timestamp: &Timestamp, tx_hashes: &[TransactionHash], tx_gas_data: &[GasData], ) -> Result<GasMetricsKey>

Adds the provided [TransactionHash] and [GasData] pairs to the accumulated GasMetrics in the store’s SLED_GAS_METRICS_BY_HEIGHT_TREE and SLED_GAS_METRICS_TREE trees, while also storing transaction gas data in the SLED_TX_GAS_DATA_TREE, committing all changes upon success.

This function retrieves the latest recorded metrics, updates them with the new gas data, and stores the accumulated result. It uses the provided block_timestamp to create a normalied time-sequenced GasMetricsKey for metrics storage. The block_height is used as a key to store metrics by height which are used to handle chain reorganizations. After updating the aggregate metrics, it stores the transaction gas data for each transaction in the block.

Returns the created GasMetricsKey that can be used to retrieve the metric upon success.

fn insert_tx_gas_data( &self, tx_hashes: &[TransactionHash], gas_data: &[GasData], lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<()>

Inserts [TransactionHash] and [GasData] pairs into the store’s SLED_TX_GAS_DATA_TREE, committing the changes upon success.

This function locks the overlay, verifies that the tx_hashes and gas_data arrays have matching lengths, then inserts them into the store while handling serialization and potential errors. Returns a successful result upon success.

pub fn reset_gas_metrics(&self, height: u32) -> Result<()>

Resets gas metrics in the SLED_GAS_METRICS_TREE and SLED_GAS_METRICS_BY_HEIGHT_TREE to a specified block height, undoing all entries after provided height and committing the changes upon success.

This function first obtains a lock on the overlay, then reverts changes by calling Self::revert_by_height_metrics and Self::revert_metrics. Upon successful revert, all modifications made after the specified height are permanently reverted.

fn insert( &self, keys: &[GasMetricsKey], metrics: &[GasMetrics], lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<()>

Inserts GasMetricsKey and GasMetrics pairs into the store’s SLED_GAS_METRICS_TREE.

This function verifies that the provided keys and metrics arrays have matching lengths, then inserts each pair while handling serialization. Returns a successful result if all insertions are completed without errors.

fn insert_by_height( &self, heights: &[u32], metrics: &[GasMetrics], lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<()>

Inserts provided u32 height and GasMetrics pairs into the store’s SLED_GAS_METRICS_BY_HEIGHT_TREE.

This function verifies matching lengths of provided heights and metrics arrays, and inserts each pair while handling serialization and errors. Returns a successful result if all insertions are completed without errors.

fn revert_metrics(&self, lock: &mut MutexGuard<'_, SledDbOverlay>) -> Result<()>

This function reverts gas metric entries in the SLED_GAS_METRICS_TREE to align with the latest metrics state in the SLED_GAS_METRICS_BY_HEIGHT_TREE.

It first determines the target timestamp to revert to based on the latest entry in the by_height tree timestamp. Then, it iteratively removes entries from the main metrics tree that are newer than the target timestamp. Once all that is complete, it adds the latest metrics by height to the main metrics tree, returning a successful result if revert processes without error.

fn revert_by_height_metrics( &self, height: u32, lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<()>

Reverts gas metric entries from SLED_GAS_METRICS_BY_HEIGHT_TREE to provided height.

This function iterates through the entries in gas metrics by height tree and removes all entries with heights greater than the specified height, effectively reverting all gas metrics beyond that point.

fn get_last( &self, lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<Option<(GasMetricsKey, GasMetrics)>>

Fetches the most recent gas metrics from SLED_GAS_METRICS_TREE, returning an option containing a metrics key GasMetricsKey and GasMetrics pair, or None if no metrics exist.

fn get_last_by_height( &self, lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<Option<(u32, GasMetrics)>>

Fetches the most recent gas metrics from SLED_GAS_METRICS_BY_HEIGHT_TREE, returning an option containing a height u32 and GasMetrics pair, or None if no metrics exist.