linera-io/linera-protocol

Improve metric help messages

Open

#1.553 aberto em 24 de jan. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (1 assignee)Rust (32.149 stars) (2.354 forks)batch import
documentationgood first issue

Description

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.

Guia do colaborador

Pilha de tecnologia
rust
Domain
observabilitybackend
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic Rust syntaxUnderstanding of metrics/telemetry
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
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.