Skip to content
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.

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

Improve track failure reason names #2488

Closed
corverroos opened this issue Jul 31, 2023 · 2 comments
Closed

Improve track failure reason names #2488

corverroos opened this issue Jul 31, 2023 · 2 comments
Assignees
Labels
protocol Protocol Team tickets V1

Comments

@corverroos
Copy link
Contributor

🎯 Problem to be solved

The tracker failure reasons that we instrument and describe here use names linked to the components or steps where the duty failed. This results in unintuitive logs and metrics which is hard for users to understand and require lookup in the reference.

We could improve operator UX by renaming these reasons to be more descriptive of the cause where applicable.

🛠️ Proposed solution

Few things we can do:

  • Prefix "bug" to reasons that are unexpected, also put this in a separate section in the docs.
  • If there is only one cause, use that as the reason, not the step.

Some suggestions:

  • bcast -> broadcast_bn_error
  • chain_inclusion -> not_included_onchain
  • consensus -> no_consensus
  • fetcher_aggregator_failed_prepare -> failed_aggregator_selection
  • fetcher_aggregator_few_prepares -> insufficient_aggregator_selections
  • fetcher_aggregator_no_external_prepares -> no_aggregator_selections
  • fetcher_aggregator_no_att_data -> missing_aggregator_attestation
  • fetcher_bn -> fetch_bn_error
  • fetcher_proposer_failed_randao -> failed_proposer_randao
  • par_sig_ex_receive -> no_peer_signatures
  • par_sig_db_insufficient -> insufficient_peer_signatures
  • validator_api -> no_local_vc_signature

Bugs:

  • agg_sig_db -> bug_aggregation_error
  • duty_db -> bug_duty_db_error
  • fetcher_error -> bug_fetch_error
@github-actions github-actions bot added the protocol Protocol Team tickets label Jul 31, 2023
@boulder225 boulder225 added the V1 label Mar 1, 2024
@boulder225
Copy link
Collaborator

since it introduces a breaking change, we prefer to revamp it in V2.

@pinebit pinebit self-assigned this Apr 11, 2024
obol-bulldozer bot pushed a commit that referenced this issue Apr 12, 2024
Improved operator UX by renaming tracker reasons to be more descriptive.

Verified Obol infra alerts and Dashboard V3 - these do not use the affected identifiers explicitly.

category: refactor
ticket: #2488
@gsora
Copy link
Collaborator

gsora commented Apr 18, 2024

Closed by #3033

@gsora gsora closed this as completed Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol Protocol Team tickets V1
Projects
None yet
Development

No branches or pull requests

4 participants