Espresso Systems Logo

status API 0.0.1 Reference

Node-specific state and uncommitted data.


Unlike the availability and node APIs, which deal only with committed data (albeit with different consistency properties), the status API offers a glimpse into internal consensus state and uncommitted data. Here you can find low-level information about a particular node, such as consensus and networking metrics.

The status API is intended to be a lightweight way to inspect the activities and health of a consensus node. It is the only API that can be run without any persistent storage, and its memory overhead is also very low. As a consequence, it only serves two types of data:

GET block_height

Routes

/hotshot-status//block-height

Parameters

None

Description

Get the height of the latest committed block.

METRICS metrics

Routes

/hotshot-status//metrics

Parameters

None

Description

Prometheus endpoint exposing various consensus-related metrics.

GET success_rate

Routes

/hotshot-status//success-rate

Parameters

None

Description

Get the view success rate.

Returns the fraction of views which resulted in a committed block, as a floating point number.

GET time_since_last_decide

Routes

/hotshot-status//time-since-last-decide

Parameters

None

Description

Get the time elapsed since the last decided time.

Returns the time elapsed in seconds since the Unix epoch.

 

Copyright © 2022 Espresso Systems. All rights reserved.