linera-io/linera-protocol

Improve metric help messages

Open

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

GitHub で見る
 (2 comments) (0 reactions) (1 assignee)Rust (2,354 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (32,149 stars)
PR merge metrics
 (平均マージ 2d 22h) (30d で 111 merged PRs)

説明

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.

コントリビューターガイド