Struct MetricsDataSource 

pub struct MetricsDataSource {
    metrics: PrometheusMetrics,
}

A minimal data source for the status API provided in this crate, with no persistent storage.

MetricsDataSource uses the metrics provided by HotShot to implement StatusDataSource. It updates automatically whenever HotShot updates its metrics. All of the state for the metrics data source is kept in memory, so it does not require a persistent storage backend. This makes MetricsDataSource an attractive choice when only the status API is desired, not the availability API.

Since all the state required by MetricsDataSource is updated automatically by HotShot, there is no need to spawn an update loop to update the data source with new events, as is required with full archival data sources like SqlDataSource. Instead, MetricsDataSource will be populated with useful data as long as its populate_metrics is used to initialize HotShot:

let data_source = MetricsDataSource::default();
let hotshot = SystemContext::<AppTypes, AppNodeImpl, AppVersions>::init(
    ConsensusMetricsValue::new(&*data_source.populate_metrics()), panic!(),
    panic!(),
    // Other fields omitted
).await.map_err(Error::internal)?.0;

Fields

metrics: PrometheusMetrics

Trait Implementations

impl Clone for MetricsDataSource

fn clone(&self) -> MetricsDataSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSourceLifeCycle for MetricsDataSource

type Storage = PrometheusMetrics

Backing storage for the data source.

fn create<'async_trait>( _node_id: usize, ) -> Pin<Box<dyn Future<Output = Self::Storage> + Send + 'async_trait>>

where Self: 'async_trait,

fn connect<'life0, 'async_trait>( storage: &'life0 Self::Storage, ) -> Pin<Box<dyn Future<Output = Self> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn reset<'life0, 'async_trait>( storage: &'life0 Self::Storage, ) -> Pin<Box<dyn Future<Output = Self> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn handle_event<'life0, 'life1, 'async_trait>( &'life0 self, _event: &'life1 Event<MockTypes>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn leaf_only_ds<'life0, 'async_trait>( _storage: &'life0 Self::Storage, ) -> Pin<Box<dyn Future<Output = Self> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn setup<'life0, 'async_trait, V>( _network: &'life0 mut MockNetwork<Self, V>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where V: 'async_trait + Versions, Self: 'async_trait, 'life0: 'async_trait,

Setup runs after setting up the network but before starting a test.

impl Debug for MetricsDataSource

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

Formats the value using the given formatter.

impl Default for MetricsDataSource

fn default() -> MetricsDataSource

Returns the “default value” for a type.

impl HasMetrics for MetricsDataSource

fn metrics(&self) -> &PrometheusMetrics

impl StatusDataSource for MetricsDataSource

fn block_height<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = QueryResult<usize>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn consensus_metrics(&self) -> QueryResult<PrometheusMetrics>

fn elapsed_time_since_last_decide<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = QueryResult<u64>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

fn success_rate<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = QueryResult<f64>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,