Suggestion: Add Monitoring Metric Descriptions for Each Monitoring Item in Grafana

Translated
1

Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.

Original topic: 建议：为Grafana每个监控项增加监控指标描述

| username: OnTheRoad

Suggestion: Improve the Description field in the Grafana monitoring panel to describe the content or purpose of the monitoring items. This will make monitoring more intuitive.

2
| username: HACK | Original post link

Yes, there are too many monitoring panels, and each panel contains many monitoring metrics for which the specific meanings are not explained.

3
| username: h5n1 | Original post link

The monitoring documentation is still not detailed enough.

4
| username: Mark | Original post link

It would be even nicer if the metric descriptions were more detailed. The community can pool their efforts to produce a version and then give it to TUG for adjustments. Practical and awesome :v:

5
| username: 箱子NvN | Original post link

Indeed, making this change will make it much more convenient to read and more beginner-friendly.

6
| username: Billmay表妹 | Original post link

If you encounter the following issues:

  • Documentation errors
  • Difficulty understanding parts of the documentation
  • Missing explanations in certain parts of the documentation

You can provide feedback at: Suggestions & Feedback - Documentation Optimization, and we will address your issues or needs one by one.

Documentation Errors

If you encounter documentation errors, please provide feedback using the template below to help us quickly locate the issue and make corrections promptly:

  • Issue Category: Outdated information, description errors, code errors, parameter errors, link errors, typos
  • Affected Page: Link + Screenshot
  • Error Description:

Unclear or Incomplete Documentation

If you find parts of the documentation unclear, please submit feedback using the template below to help us better understand your confusion:

  • Issue Category: Content too brief, unclear or ambiguous descriptions, incomplete steps
  • Affected Page: Link + Screenshot
  • Issue Description:

New Documentation Request

If this is a new documentation request, please submit feedback using the template below to help us understand your needs and optimize accordingly:

  • Request Type: New documentation
  • Background: For example, which part of the documentation is missing and how it affects usage
  • Expected Additions: Which components or features should be documented and where in the existing documentation they should be added

According to the Points Rules, participating in documentation optimization can earn you 10 points and 10 experience points. We also thank all TiDB community members for contributing to the community.

【TiDB Chinese Documentation Contribution Guide】

Refer to the correct way to request documentation.

7
| username: OnTheRoad | Original post link

There are indeed too many monitoring dashboards. Having too many monitoring dashboards is almost equivalent to having no monitoring at all. Additionally, many of the monitoring dashboards are redundant. At a glance, it’s hard to know where to start. In fact, the main metrics to focus on are nothing more than server load, space, and the like. However, these primary metrics are nowhere to be found.

8
| username: HACK | Original post link

:sweat_smile: I feel the same, totally confused.

9
| username: h5n1 | Original post link

Download a performance overview JSON file for version 6.0 and perform a top-level performance analysis.

10
| username: system | Original post link

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.