linera-io/linera-protocol

Improve metric help messages

Open

#1,553 opened on 2024年1月24日

GitHub で見る
 (2 comments) (0 reactions) (1 assignee)Rust (32,149 stars) (2,354 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.