Skip to content

Commit 119c9e1

Browse files
AresonAreson
committed
error.host
1 parent fd7a253 commit 119c9e1

File tree

8 files changed

+703
-5
lines changed

8 files changed

+703
-5
lines changed

‎docs/content/metrics/domains/error.host/_index.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
title: "error.host"
3+
---
4+
5+
The `error.host` domain includes server error metrics grouped by host from [error summary tables](https://dev.mysql.com/doc/refman/en/performance-schema-error-summary-tables.html).
6+
7+
{{< toc >}}
8+
9+
## Usage
10+
11+
For example:
12+
13+
```
14+
mysql> SELECT * FROM performance_schema.events_errors_summary_by_host_by_error WHERE error_number = 3024 AND HOST IN ('host1')\G
15+
*************************** 1. row ***************************
16+
HOST: host1
17+
ERROR_NUMBER: 3024
18+
ERROR_NAME: ER_QUERY_TIMEOUT
19+
SQL_STATE: HY000
20+
SUM_ERROR_RAISED: 1
21+
SUM_ERROR_HANDLED: 0
22+
FIRST_SEEN: 2025-04-30 16:30:16
23+
LAST_SEEN: 2025-04-30 16:30:16
24+
```
25+
26+
The `SUM_ERR_RAISED` value is used for the Blip `raised` metric. `ERROR_NUMBER`, `ERROR_NAME`, and `HOST` are used to group the metric.
27+
28+
## Derived Metrics
29+
30+
None.
31+
32+
## Options
33+
34+
### `all`
35+
36+
|Value|Default|Description|
37+
|-----|-------|-----------|
38+
|yes |&check; |Collect metrics on _all_ errors (not recommended)|
39+
|no | |Collect only metrics for the errors listed in the plan|
40+
|exclude| |Collect metrics only for errors that are not listed in the plan|
41+
42+
### `total`
43+
44+
|Value|Default|Description|
45+
|-----|-------|-----------|
46+
|yes |&check; |Return the total number of errors raised|
47+
|no | |Do not return the total number of errors raised|
48+
|only| |Only return the total number of errors raised|
49+
50+
If `all` is not set to `yes` the total will only reflect those errors that are specifically included or not excluded from collection.
51+
52+
### `include`
53+
54+
| | |
55+
|---|---|
56+
|**Value Type**|CSV string of hosts|
57+
|**Default**||
58+
59+
A comma-separated list of hosts to include. Overrides option `exclude`.
60+
61+
### `exclude`
62+
63+
| | |
64+
|---|---|
65+
|**Value Type**|CSV string of hosts|
66+
|**Default**||
67+
68+
A comma-separated list of hosts to exclude. Ignored if `include` is set.
69+
70+
### `truncate-table`
71+
72+
|Value|Default|Description|
73+
|---|---|---|
74+
|yes| |Truncate table after each successful collection|
75+
|no|&check; |Do not truncate table|
76+
77+
If the table is truncated (default), the metrics are delta counters.
78+
Else, the values are cumulative counters.
79+
80+
### `truncate-timeout`
81+
82+
| | |
83+
|---|---|
84+
|**Value Type**|[Duration string](https://pkg.go.dev/time#ParseDuration)|250ms|
85+
|**Default**|250ms|
86+
87+
Sets `@@session.lock_wait_timeout` to avoid waiting too long when truncating the table.
88+
Normally, truncating a table is nearly instantaneous, but metadata locks can block the operation.
89+
90+
### `truncate-on-startup`
91+
92+
|Value|Default|Description|
93+
|---|---|---|
94+
|yes|&check;|Truncate source table on start of metric collection|
95+
|no| |Do not truncate source table on startup|
96+
97+
Truncates the source table when Blip starts. The timeout use will be the same as specified by `truncate-timeout`.
98+
99+
## Group Keys
100+
101+
|Key|Value|
102+
|---|---|
103+
|`error_nunmber`|The error number or an empty string for a total|
104+
|`error_name`|The short error name or an empty string for a total|
105+
106+
## Meta
107+
108+
None.
109+
110+
## Error Policies
111+
112+
|Name|MySQL Error|
113+
|----|-----------|
114+
|`truncate-timeout`|Error truncating table|
115+
116+
## MySQL Config
117+
118+
See
119+
* [29.12.20.11 Error Summary Tables](https://dev.mysql.com/doc/refman/8.4/en/performance-schema-error-summary-tables.html)
120+
121+
and related pages in the MySQL manual.
122+
123+
## Changelog
124+
125+
|Blip Version|Change|
126+
|------------|------|
127+
|TBD |Domain added|

‎docs/content/metrics/domains/error.user/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "errro.user"
2+
title: "error.user"
33
---
44

5-
The `errro.user` domain includes server error metrics grouped by user from [error summary tables](https://dev.mysql.com/doc/refman/en/performance-schema-error-summary-tables.html).
5+
The `error.user` domain includes server error metrics grouped by user from [error summary tables](https://dev.mysql.com/doc/refman/en/performance-schema-error-summary-tables.html).
66

77
{{< toc >}}
88

‎docs/content/metrics/quick-ref.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The rest are reserved for future use.
2020
|error|MySQL, client, and query errors||
2121
|error.client|Client errors||
2222
|[error.global](domains#error.global)|Global error counts and rates [`Error Summary Tables`](https://dev.mysql.com/doc/refman/8.4/en/performance-schema-error-summary-tables.html)|TBD|
23+
|[error.host](domains#error.host)|Error counts and rates by host [`Error Summary Tables`](https://dev.mysql.com/doc/refman/8.4/en/performance-schema-error-summary-tables.html)|TBD|
2324
|[error.user](domains#error.user)|Error counts and rates by user [`Error Summary Tables`](https://dev.mysql.com/doc/refman/8.4/en/performance-schema-error-summary-tables.html)|TBD|
2425
|error.query|Query errors||
2526
|error.repl|Replication errors||

0 commit comments

Comments
 (0)