docs: define lean_node_sync_status states - #41
Open
mzf11125 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolves the open questions in #17 by defining what each
lean_node_sync_statusstate means.What changed
The Usage column for
lean_node_sync_statusnow states that the metric tracks initial sync and any later catch-up, and defines the three states:idle: sync has not started.syncing: the node is catching up to the chain head.synced: the node is caught up to the chain head.This answers whether a node at the top of the chain is
syncedorsyncing, and whether the metric covers only initial sync.Related issues
lean_block_building_payload_aggregation_time_seconds. No change needed.Sync-Metricsitem remains in the repository, so there is nothing to remove.Closes #17