Skip to content

Commit ad8371b

Browse files
xheboxdjshow832
andauthored
Apply suggestions from code review
Co-authored-by: djshow832 <[email protected]>
1 parent f7dce74 commit ad8371b

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

tiproxy/tiproxy-grafana.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,42 @@ TiProxy has four panel groups. The metrics on these panels indicate the current
2121

2222
## Server
2323

24-
- CPU Usage: The CPU utilization per TiProxy instance.
25-
- Memory Usage: The memory usage per TiProxy instance.
26-
- Uptime: The runtime of TiProxy since last restart.
27-
- Goroutine Count: Running goroutine count of TiProxy instance.
28-
- Connection Count: SQL connections that TiProxy instance serve.
24+
- CPU Usage: the CPU utilization of each TiProxy instance
25+
- Memory Usage: the memory usage of each TiProxy instance
26+
- Uptime: the runtime of each TiProxy instance since last restart
27+
- Connection Count: the number of clients connected to each TiProxy instance
28+
- Create Connection OPM: the number of creating connections on each TiProxy instance every minute
29+
- Disconnection OPM: the number of disconnections for each reason every minute. Reasons include:
30+
- success: the client disconnects normally
31+
- client network break: the client does not send a `QUIT` command before it disconnects. It may also be caused by a network problem or the client shutting down
32+
- client handshake fail: the client fails to handshake with TiProxy
33+
- auth fail: the access is denied by TiDB
34+
- SQL error: TiDB returns other SQL errors
35+
- proxy shutdown: TiProxy is shutting down
36+
- malformed packet: TiProxy fails to parse the MySQL packet
37+
- get backend fail: TiProxy fails to find an available backend for the connection
38+
- proxy error: other TiProxy errors
39+
- backend network break: fails to read from or write to the TiDB. This may be caused by a network problem or the TiDB server shutting down
40+
- backend handshake fail: TiProxy fails to handshake with the TiDB server
41+
- Goroutine Count: the number of Goroutines on each TiProxy instance
2942

3043
## Query-Summary
3144

32-
- Duration: average, p95, p99 SQL statement execution duration.
33-
- CPS by Instance: command per second of all TiProxy instances.
34-
- CPS by Backend: command per second of all TiDB instances.
35-
- CPS by CMD: command per second grouped by SQL command type.
45+
- Duration: average, p95, p99 SQL statement execution duration. It includes the duration of SQL statement execution on TiDB servers, so it is higher than the duration on the TiDB Grafana panel
46+
- P99 Duration By Instance: p99 statement execution duration of each TiProxy instance
47+
- P99 Duration By Backend: p99 statement execution duration of the statements that are executed on each TiDB instance
48+
- CPS by Instance: command per second of each TiProxy instance
49+
- CPS by Backend: command per second of each TiDB instance
50+
- CPS by CMD: command per second grouped by SQL command type
3651

3752
## Balance
3853

39-
- Backend Connections: connection counts between each TiDB instance and each TiProxy instance.
40-
- Session Migrations: session migrations happened on all TiProxy instances, recording sessions on which TiDB instance migrated to the other.
54+
- Backend Connections: connection counts between each TiDB instance and each TiProxy instance. For example, `10.24.31.1:6000 | 10.24.31.2:4000` indicates the connections between TiProxy instance `10.24.31.1:6000` and TiDB instance `10.24.31.2:4000`
55+
- Session Migration OPM: the number of session migrations that happened every minute, recording sessions on which TiDB instance migrated to the other. For example, `succeed: 10.24.31.2:4000 => 10.24.31.3:4000` indicates the number of sessions that are successfully migrated from TiDB instance `10.24.31.2:4000` to TiDB instance `10.24.31.3:4000`
4156
- Session Migration Duration: average, p95, p99 session migration duration.
4257

4358
## Backend
4459

45-
- Get Backend Count: how many times did TiProxy instances try to connect the backend.
46-
- Get Backend Duration: average, p95, p99 duration of connecting backend, useful for debugging why TiProxy can not establish healthy connections.
47-
- Ping Backend Duration: latencies between each TiDB instance and each TiProxy instance.
60+
- Get Backend Duration: the average, p95, p99 duration of TiProxy connecting to a TiDB instance
61+
- Ping Backend Duration: the network latency between each TiProxy instance and each TiProxy instance. For example, `10.24.31.1:6000 | 10.24.31.2:4000` indicates the network latency between TiProxy instance `10.24.31.1:6000` and TiDB instance `10.24.31.2:4000`
62+
- Health Check Cycle: the duration of a cycle of the health check between a TiProxy instance and all TiDB instances. For example, `10.24.31.1:6000` indicates the duration of the latest health check that TiProxy instance `10.24.31.1:6000` executes on all the TiDB instances. If this duration is higher than 3 seconds, TiProxy may not be timely to refresh the backend TiDB list

0 commit comments

Comments
 (0)