Skip to content

feat: add node info, sync, reorg and finalization metrics #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
KatyaRyazantseva wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add node info, sync, reorg and finalization metrics #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,34 @@
# Lean Metrics

- [Node Info Metrics](#node-info-metrics)
- [PQ Signature Metrics](#pq-signature-metrics)
- [Sync Metrics](#sync-metrics)
- [Fork-Choice Metrics](#fork-choice-metrics)
- [State Transition Metrics](#state-transition-metrics)
- [Validator Metrics](#validator-metrics)

## Node Info Metrics

| Name | Type | Usage | Sample collection event | Labels | Lantern | Qlean | Ream | Zeam |
|--------|-------|-------|-------------------------|--------|----------|----------|----------|----------|
| `lean_node_info` | Gauge | Node information (always 1) | On node start | name, version | □ | □ | □ | □ |
| `lean_node_start_time_seconds` | Gauge | Start timestamp | On node start | | □ | □ | □ | □ |


## PQ Signature Metrics

| Name | Type | Usage | Sample collection event | Labels | Buckets | Lantern | Qlean | Ream | Zeam |
|--------|-------|-------|-------------------------|--------|---------|----------|----------|----------|----------|
| `lean_pq_signature_attestation_signing_time_seconds` | Histogram | Time taken to sign an attestation | On each attestation signing | | 0.005, 0.01, 0.025, 0.05, 0.1, 1 | □ | □ | ✅ | □ |
| `lean_pq_signature_attestation_verification_time_seconds` | Histogram | Time taken to verify an attestation signature | On each `signature.verify()` on an attestation | | 0.005, 0.01, 0.025, 0.05, 0.1, 1 | □ | □ | ✅ | □ |

## Sync Metrics

| Name | Type | Usage | Sample collection event | Labels | Lantern | Qlean | Ream | Zeam |
|--------|-------|-------|-------------------------|--------|----------|----------|----------|----------|
| `lean_node_sync_status` | Gauge | Current sync status (always 1) | On sync status change | status=not_started,syncing,synced,stalled | □ | □ | □ | □ |
Copy link

@kamilsa kamilsa Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear what is the difference between synced, syncing, and stalled.
E.g. if we are on the top of the chain are we synced or syncing (waiting for a new block).
Also how do we define stalled?

If by sync we mean initial sync after the node is started, then it all makes more sense, but we need to write somewhere that this is initial sync



## Fork-Choice Metrics

| Name | Type | Usage | Sample collection event | Labels | Buckets | Lantern | Qlean | Ream | Zeam |
Expand All @@ -21,13 +38,16 @@
|`lean_attestations_valid_total`| Counter | Total number of valid attestations | On validate attestation | source=block,gossip | | ✅ | ✅ | ✅ | □ |
|`lean_attestations_invalid_total`| Counter | Total number of invalid attestations | On validate attestation | source=block,gossip | | ✅ | ✅ | ✅ | □ |
|`lean_attestation_validation_time_seconds`| Histogram | Time taken to validate attestation | On validate attestation | | 0.005, 0.01, 0.025, 0.05, 0.1, 1 | ✅ | ✅ | ✅ | □ |
| `lean_fork_choice_reorgs_total` | Counter | Total number of fork choice reorgs | On fork choice reorg | | | □ | □ | □ | □ |
| `lean_fork_choice_reorg_depth` | Histogram | Depth of fork choice reorgs (in blocks) | On fork choice reorg | | 1, 2, 3, 5, 7, 10, 20, 30, 50, 100 | □ | □ | □ | □ |

## State Transition Metrics

| Name | Type | Usage | Sample collection event | Labels | Buckets | Lantern | Qlean | Ream | Zeam |
|--------|-------|-------|-------------------------|--------|---------|----------|----------|----------|----------|
| `lean_latest_justified_slot` | Gauge | Latest justified slot | On state transition | | | ✅ | ✅ | ✅ | ✅ |
| `lean_latest_finalized_slot` | Gauge | Latest finalized slot | On state transition | | | ✅ | ✅ | ✅ | ✅ |
| `lean_finalizations_total` | Counter | Total number of finalization attempts | On finalization attempt | result=success,error | | □ | □ | □ | □ |
|`lean_state_transition_time_seconds`| Histogram | Time to process state transition | On state transition | | 0.25, 0.5, 0.75, 1, 1.25, 1.5, 2, 2.5, 3, 4 | ✅ | ✅ | ✅ | ✅ |
|`lean_state_transition_slots_processed_total`| Counter | Total number of processed slots | On state transition process slots | | | ✅ | ✅ | ✅ | ✅ |
|`lean_state_transition_slots_processing_time_seconds`| Histogram | Time taken to process slots | On state transition process slots | | 0.005, 0.01, 0.025, 0.05, 0.1, 1 | ✅ | ✅ | ✅ | ✅ |
Expand Down