linera-io/linera-protocol

Improve metric help messages

Open

Aperta il 24 gen 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (1 assegnatario)Rust (32.149 star) (2354 fork)batch import
documentationgood first issue

Descrizione

Motivation

When metric counters are created, they need a name string and a description string. The description is used as a help message, and should describe the metric in plain English. However, there are many metrics that use very similar strings for the names and the descriptions, which make the help message practically useless.

Here is an example: https://github.com/linera-io/linera-protocol/blob/589ddefa8cbafc731952bcab0b5c5c3150949111/linera-chain/src/chain.rs#L68-L69

Proposal

Go through all created metrics and ensure they have helpful and clear descriptions.

Guida contributor

Tech stack
rust
Dominio
observabilitybackend
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic Rust syntaxUnderstanding of metrics/telemetry
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
The issue requires examining all metric counter definitions across the repository. The example in linera chain/src/chain.rs lines 68-69 shows a metric with a weak description. Look for `Counter::new` calls (or similar) in the entire codebase and improve the description strings to be more informative. Since the issue has an assignee, check if the work is in progress before starting.