linera-io/linera-protocol

Improve metric help messages

Open

#1.553 geöffnet am 24. Jan. 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (32.149 Stars) (2.354 Forks)batch import
documentationgood first issue

Beschreibung

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.

Contributor Guide

Tech Stack
rust
Domain
observabilitybackend
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic Rust syntaxUnderstanding of metrics/telemetry
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.