Struct MetricsStore

pub struct MetricsStore {
    pub sled_db: Db,
    pub main: Tree,
    pub by_height: Tree,
    pub tx_gas_data: Tree,
}

The MetricStore serves as the entry point for managing metrics, offering an API for fetching, inserting, and resetting metrics backed by a Sled database.

It organizes data into separate Sled trees, including main storage for gas metrics by a defined time interval, a tree containing metrics by height for handling reorgs, and a transaction-specific gas data tree. Different keys, such as gas metric keys, block heights, and transaction hashes, are used to handle various use cases.

The MetricStore utilizes an overlay pattern for write operations, allowing unified management of metrics, by internally delegating write-related actions like adding metrics and handling reorgs to MetricsStoreOverlay.

Fields

sled_db: Db

Pointer to the underlying sled database used by the store and its associated overlay

main: Tree

Primary sled tree for storing gas metrics, utilizing GasMetricsKey as keys and serialized GasMetrics as values.

by_height: Tree

Sled tree for storing gas metrics by height, utilizing block height as keys and serialized GasMetrics as values.

tx_gas_data: Tree

Sled tree for storing transaction gas data, utilizing [TransactionHash] inner value as keys and serialized [GasData] as values.

Implementations

impl MetricsStore

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

Creates a MetricsStore instance by opening the necessary trees in the provided sled database [Db]

pub fn get(&self, keys: &[GasMetricsKey]) -> Result<Vec<GasMetrics>>

Fetches GasMetricss associated with the provided slice of GasMetricsKeys.

pub fn get_by_height(&self, heights: &[u32]) -> Result<Vec<GasMetrics>>

Fetches GasMetricss associated with the provided slice of u32 heights.

pub fn get_last(&self) -> Result<Option<(GasMetricsKey, GasMetrics)>>

Fetches the most recent GasMetrics and its associated GasMetricsKey from the main tree, returning None if no metrics are found.

pub fn get_all_metrics(&self) -> Result<Vec<GasMetrics>>

Fetches all GasMetrics from the main tree without corresponding key, returning an empty Vec if no metrics are found.

pub fn get_last_by_height(&self) -> Result<Option<(u32, GasMetrics)>>

Fetches the most recent GasMetrics and its associated height from the by_height tree, returning None if no metrics are found.

pub fn get_tx_gas_data( &self, tx_hash: &TransactionHash, ) -> Result<Option<GasData>>

Fetches the [GasData] associated with the provided [TransactionHash], or None if no gas data is found.

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

Adds gas metrics for a specific block of transactions to the store.

This function takes block height, [Timestamp], with associated pairs of [TransactionHash] and [GasData], and updates the accumulated gas metrics in the store. It handles the storage of metrics for both regular use and blockchain reorganizations.

Delegates operation to MetricsStoreOverlay::insert_gas_metrics, whose documentation provides more details.

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

Resets the gas metrics in the store to a specified height u32.

This function reverts all gas metrics data after the given height, effectively undoing changes made beyond that point. It’s useful for handling blockchain reorganizations.

Delegates operation to MetricsStoreOverlay::reset_gas_metrics, whose documentation provides more details.

pub fn contains(&self, key: &GasMetricsKey) -> Result<bool>

Checks if provided GasMetricsKey exists in the store’s main tree.

pub fn len(&self) -> usize

Provides the number of stored metrics in the main tree.

pub fn len_by_height(&self) -> usize

Provides the number of stored metrics by height.

pub fn len_tx_gas_data(&self) -> usize

Returns the number of transaction gas usage metrics stored.

pub fn is_empty(&self) -> bool

Checks if there are any gas metrics stored.

pub fn is_empty_tx_gas_data(&self) -> bool

Checks if transaction gas data metrics are stored.

Trait Implementations

impl Clone for MetricsStore

fn clone(&self) -> MetricsStore

Returns a copy of the value.

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

Performs copy-assignment from source.