lodestar icon indicating copy to clipboard operation
lodestar copied to clipboard

docs: add attestation summary

Open emmaglorypraise opened this issue 8 months ago • 7 comments

Motivation

Adds Lodestar metric attestation_summary explainer in docs

Description

Adds a new page with details about Lodestar attestation metrics & labels

Resolves part of #6591

Steps to test or reproduce

yarn docs:build
yarn docs:serve

emmaglorypraise avatar Apr 24 '25 17:04 emmaglorypraise

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Apr 24 '25 17:04 CLAassistant

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Apr 24 '25 17:04 CLAassistant

Hi @nflaig, please review. I want to know if I'm on the right track.

emmaglorypraise avatar Apr 24 '25 18:04 emmaglorypraise

Hi @nflaig, please review. I want to know if I'm on the right track.

looks good to me but haven't reviewed in detail, leaving this one to @philknows

nflaig avatar Apr 26 '25 10:04 nflaig

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 56.27%. Comparing base (dd729f5) to head (8483c85). :warning: Report is 393 commits behind head on unstable.

Additional details and impacted files
@@             Coverage Diff              @@
##           unstable    #7744      +/-   ##
============================================
- Coverage     56.29%   56.27%   -0.03%     
============================================
  Files           837      837              
  Lines         58044    58055      +11     
  Branches       4469     4467       -2     
============================================
- Hits          32678    32672       -6     
- Misses        25298    25315      +17     
  Partials         68       68              
:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Apr 26 '25 11:04 codecov[bot]

@emmaglorypraise , this is a good start... but would also look to expand into some of the points that was mentioned in Discord and on the original issue as someone looking at it in this current state, probably has little to no context of what these attestation summaries are and how to debug problems.

Some additional content that can be added include:

  • High level summary of the attestation process (the more you detail to the user, the more they can understand how the different summaries explain the problem they might be having)

    • e.g. Workflow: Vote signing -> p2p subnet -> aggregators in committee wrapping aggregation -> broadcast
    • e.g. Post-Electra EIP-7549 now allowing identical votes from different committees aggregating voting together
    • e.g. The timing of the slots themselves. When is it important for attestations to be sent? When is it important for them to be aggregated and received by the next block proposer?
  • Better organize attestation labels and what they mean. Perhaps a table would work better here.

  • If you are experiencing sub-optimal attestation performance, what is a good flow to understand what might be happening? How do I check when I received the block? How do I find the debug logs and what "string logs" should I grep for potential indications of what is happening?

There might be some things here that require running a node to be more familiar with, specifically with Lodestar. However, if you put together the high level stuff (network-wide content), we can help with answering the deeper questions such as logging.

philknows avatar Apr 28 '25 02:04 philknows

Thank you @philknows, I will work on this feedback

emmaglorypraise avatar Apr 28 '25 13:04 emmaglorypraise

closing stale PR

wemeetagain avatar Sep 04 '25 15:09 wemeetagain