Skip to content

cloud: align Starter and Essential metrics tabs with console #22969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Oreoxmt wants to merge 1 commit into
base: release-8.5
Choose a base branch
from
+11 −3
Open

cloud: align Starter and Essential metrics tabs with console #22969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions tidb-cloud/built-in-monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ To view the metrics on the **Metrics** page, take the following steps:

In TiDB Cloud, the metrics data is kept for 7 days.

<CustomContent plan="dedicated">

## Metrics for TiDB Cloud Dedicated clusters

The following sections illustrate the metrics on the **Metrics** page for TiDB Cloud Dedicated clusters.
Expand Down Expand Up @@ -86,16 +88,20 @@ The following sections illustrate the metrics on the **Metrics** page for TiDB C
| TiProxy Throughput | node | The bytes transferred per second on each TiProxy node. |
| TiProxy Sessions Migration Reasons | reason | The number of session migrations that happen every minute and the reasons for them. |

</CustomContent>

<CustomContent plan="starter,essential">

## Metrics for {{{ .starter }}} and {{{ .essential }}} instances

The **Metrics** page provides two tabs for metrics of {{{ .starter }}} and {{{ .essential }}} instances:

- **Cluster Status**: displays the cluster-level main metrics.
- **Instance Overview**: displays the instance-level main metrics.
- **Database Status**: displays the database-level main metrics.

### Cluster Status
### Instance Overview
Comment thread
Oreoxmt marked this conversation as resolved.

The following table illustrates the cluster-level main metrics under the **Cluster Status** tab.
The following table illustrates the instance-level main metrics under the **Instance Overview** tab.

| Metric name | Labels | Description |
| :------------| :------| :-------------------------------------------- |
Expand All @@ -121,6 +127,8 @@ The following table illustrates the database-level main metrics under the **Data
| Average Query Duration Per DB | All, {Database name} | The duration from receiving a request from the client to a database until the database executes the request and returns the result to the client.|
| Failed Query Per DB | All, {Database name} | The statistics of error types according to the SQL statement execution errors per second on every database.|

</CustomContent>

## FAQ

**1. Why are some panes empty on this page?**
Expand Down