pingcap / pingcap/docs

grafana-pd-dashboard.md: 99% Completed commands duration description may be incorrect

Open Beginner friendly
#23,769 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

What is changed, added or deleted? (Required)

In the gRPC section of grafana-pd-dashboard.md, two adjacent bullets have identical description text apart from the trailing "(P99)":

- Completed commands rate: The rate per command type at which gRPC commands are completed
- 99% Completed commands duration: The rate per command type at which gRPC commands are completed (P99)

The second panel's name is "99% Completed commands duration", but its description still talks about "rate", which may be incorrect for a duration/latency panel.

For reference, the Chinese source (docs-cn/grafana-pd-dashboard.md) describes these two panels differently:

- Completed commands rate:gRPC 命令的完成速率
- 99% Completed commands duration:99% 命令的最长消耗时间

The second line translates to roughly "99% Completed commands duration: the maximum time consumed by 99% of commands" — i.e., a duration/latency description, not a rate. Please double check whether the English description for "99% Completed commands duration" should instead describe a duration metric (e.g., similar in shape to "The time it takes for 99% of gRPC commands to complete"), using the Chinese doc as a reference for the intended meaning.

Which TiDB version(s) do your changes apply to? (Required)
  • master (the latest development version)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?
  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open grafana-pd-dashboard.md and read the two adjacent gRPC bullets in its gRPC section. Compare the English wording with the corresponding lines in docs-cn/grafana-pd-dashboard.md, then revise only the 99% Completed commands duration description to explain a duration or latency metric rather than a rate. Done means the English description matches the intended meaning and is distinct from the completed commands rate description.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.