linera-io/linera-protocol

Improve metric help messages

Open

#1,553 建立於 2024年1月24日

在 GitHub 查看
 (2 留言) (0 反應) (1 負責人)Rust (32,149 star) (2,354 fork)batch import
documentationgood first issue

描述

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.

貢獻者指南

技術棧
rust
領域
observabilitybackend
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic Rust syntaxUnderstanding of metrics/telemetry
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.