Skip to content

Commit c5aaf3e

Browse files
authored
Merge pull request #1906 from siggy/siggy/fix-urls
Fix doc URLs in alerts and dashboards
2 parents e8c7efd + 1fc8198 commit c5aaf3e

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

deploy/helm/clickhouse-operator/files/Altinity_ClickHouse_Operator_dashboard.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,7 +1282,7 @@
12821282
{
12831283
"targetBlank": true,
12841284
"title": "max_concurent_queries",
1285-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
1285+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
12861286
},
12871287
{
12881288
"targetBlank": true,
@@ -1412,7 +1412,7 @@
14121412
{
14131413
"targetBlank": true,
14141414
"title": "max_concurent_queries",
1415-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-concurrent-queries"
1415+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
14161416
},
14171417
{
14181418
"targetBlank": true,
@@ -1727,7 +1727,7 @@
17271727
{
17281728
"targetBlank": true,
17291729
"title": "max_concurent_queries",
1730-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
1730+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
17311731
},
17321732
{
17331733
"targetBlank": true,
@@ -2253,7 +2253,7 @@
22532253
{
22542254
"targetBlank": true,
22552255
"title": "max_replica_delay_for_distributed_queries",
2256-
"url": "https://clickhouse.com/docs/en/operations/settings/settings#settings-max_replica_delay_for_distributed_queries"
2256+
"url": "https://clickhouse.com/docs/operations/settings/settings#max_replica_delay_for_distributed_queries"
22572257
}
22582258
],
22592259
"options": {
@@ -4298,7 +4298,7 @@
42984298
{
42994299
"targetBlank": true,
43004300
"title": "mark_cache_size",
4301-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-mark-cache-size"
4301+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#mark_cache_size"
43024302
},
43034303
{
43044304
"targetBlank": true,
@@ -5335,12 +5335,12 @@
53355335
{
53365336
"targetBlank": true,
53375337
"title": "max_connections",
5338-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-connections"
5338+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_connections"
53395339
},
53405340
{
53415341
"targetBlank": true,
53425342
"title": "max_distributed_connections",
5343-
"url": "https://clickhouse.com/docs/en/operations/settings/settings#max-distributed-connections"
5343+
"url": "https://clickhouse.com/docs/operations/settings/settings#max_distributed_connections"
53445344
},
53455345
{
53465346
"targetBlank": true,

deploy/prometheus/prometheus-alert-rules-clickhouse.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ spec:
7272
`increase(chi_clickhouse_event_DNSError[1m])` = {{ with printf "increase(chi_clickhouse_event_DNSError{hostname='%s',exported_namespace='%s'}[1m]) or increase(chi_clickhouse_event_NetworkErrors{hostname='%s',exported_namespace='%s'}[1m])" .Labels.hostname .Labels.exported_namespace .Labels.hostname .Labels.exported_namespace | query }}{{ . | first | value | printf "%.2f" }} errors{{ end }}
7373
Please check DNS settings in `/etc/resolve.conf` and `<remote_servers>` part of `/etc/clickhouse-server/`
7474
See documentation:
75-
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-remote-servers
76-
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-disable-internal-dns-cache
75+
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#remote_servers
76+
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#disable_internal_dns_cache
7777
- https://clickhouse.com/docs/en/sql-reference/statements/system/
7878
7979
- alert: ClickHouseDistributedFilesToInsertHigh
@@ -112,7 +112,7 @@ spec:
112112
`increase(chi_clickhouse_event_DistributedConnectionFailAtAll[1m])` = {{ with printf "increase(chi_clickhouse_event_DistributedConnectionFailAtAll{hostname='%s',exported_namespace='%s'}[1m])" .Labels.hostname .Labels.exported_namespace | query }}{{ . | first | value | printf "%.2f" }} errors{{ end }}
113113
114114
Please, check communications between clickhouse server and host `remote_servers` in `/etc/clickhouse-server/`
115-
https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-remote-servers
115+
https://clickhouse.com/docs/operations/server-configuration-parameters/settings#remote_servers
116116
117117
Also, you can check logs:
118118
```kubectl logs -n {{ $labels.exported_namespace }} $( echo {{ $labels.hostname }} | cut -d '.' -f 1)-0 -f```
@@ -178,7 +178,7 @@ spec:
178178
Please use Buffer table
179179
https://clickhouse.com/docs/en/engines/table-engines/special/buffer/
180180
or
181-
https://clickhouse.com/docs/en/operations/settings/settings/#async-insert
181+
https://clickhouse.com/docs/operations/settings/settings#async_insert
182182
183183
- alert: ClickHouseLongestRunningQuery
184184
expr: chi_clickhouse_metric_LongestRunningQuery > 600
@@ -259,7 +259,7 @@ spec:
259259
The ClickHouse is adapted to run not a very large number of parallel SQL requests, not every HTTP/TCP(Native)/MySQL protocol connection means a running SQL request, but a large number of open connections can cause a spike in sudden SQL requests, resulting in performance degradation.
260260
261261
Also read documentation:
262-
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#max-concurrent-queries
262+
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries
263263
264264
265265
- alert: ClickHouseTooManyRunningQueries
@@ -279,7 +279,7 @@ spec:
279279
Look at following documentation parts:
280280
- https://clickhouse.com/docs/en/operations/settings/query-complexity/
281281
- https://clickhouse.com/docs/en/operations/quotas/
282-
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#max-concurrent-queries
282+
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries
283283
- https://clickhouse.com/docs/en/operations/system-tables/query_log/
284284
285285
- alert: ClickHouseSystemSettingsChanged
@@ -527,7 +527,7 @@ spec:
527527
chi_clickhouse_metric_BackgroundMessageBrokerSchedulePoolTask = {{ with printf "chi_clickhouse_metric_BackgroundMessageBrokerSchedulePoolTask{exported_namespace='%s',chi='%s',hostname='%s'}" .Labels.exported_namespace .Labels.chi .Labels.hostname | query }}{{ . | first | value | printf "%.0f" }}{{ end }}
528528
chi_clickhouse_metric_BackgroundMessageBrokerSchedulePoolSize = {{ with printf "chi_clickhouse_metric_BackgroundMessageBrokerSchedulePoolSize{exported_namespace='%s',chi='%s',hostname='%s'}" .Labels.exported_namespace .Labels.chi .Labels.hostname | query }}{{ . | first | value | printf "%.0f" }}{{ end }}
529529
- https://kb.altinity.com/altinity-kb-integrations/altinity-kb-kafka/background_message_broker_schedule_pool_size/
530-
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#background_message_broker_schedule_pool_size
530+
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#background_message_broker_schedule_pool_size
531531
- https://clickhouse.com/docs/en/operations/system-tables/metrics#backgroundmessagebrokerschedulepoolsize
532532
This pool is used for tasks related to message streaming from Apache Kafka or other message brokers.
533533
You need to increase `background_message_broker_schedule_pool_size` to fix the problem.

grafana-dashboard/Altinity_ClickHouse_Operator_dashboard.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,7 +1282,7 @@
12821282
{
12831283
"targetBlank": true,
12841284
"title": "max_concurent_queries",
1285-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
1285+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
12861286
},
12871287
{
12881288
"targetBlank": true,
@@ -1412,7 +1412,7 @@
14121412
{
14131413
"targetBlank": true,
14141414
"title": "max_concurent_queries",
1415-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-concurrent-queries"
1415+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
14161416
},
14171417
{
14181418
"targetBlank": true,
@@ -1727,7 +1727,7 @@
17271727
{
17281728
"targetBlank": true,
17291729
"title": "max_concurent_queries",
1730-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
1730+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
17311731
},
17321732
{
17331733
"targetBlank": true,
@@ -2253,7 +2253,7 @@
22532253
{
22542254
"targetBlank": true,
22552255
"title": "max_replica_delay_for_distributed_queries",
2256-
"url": "https://clickhouse.com/docs/en/operations/settings/settings#settings-max_replica_delay_for_distributed_queries"
2256+
"url": "https://clickhouse.com/docs/operations/settings/settings#max_replica_delay_for_distributed_queries"
22572257
}
22582258
],
22592259
"options": {
@@ -4298,7 +4298,7 @@
42984298
{
42994299
"targetBlank": true,
43004300
"title": "mark_cache_size",
4301-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-mark-cache-size"
4301+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#mark_cache_size"
43024302
},
43034303
{
43044304
"targetBlank": true,
@@ -5335,12 +5335,12 @@
53355335
{
53365336
"targetBlank": true,
53375337
"title": "max_connections",
5338-
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-connections"
5338+
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_connections"
53395339
},
53405340
{
53415341
"targetBlank": true,
53425342
"title": "max_distributed_connections",
5343-
"url": "https://clickhouse.com/docs/en/operations/settings/settings#max-distributed-connections"
5343+
"url": "https://clickhouse.com/docs/operations/settings/settings#max_distributed_connections"
53445344
},
53455345
{
53465346
"targetBlank": true,

0 commit comments

Comments
 (0)