Skip to content

Fix doc URLs in alerts and dashboards #1906

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

Merged
Slach merged 1 commit into from
Jan 15, 2026
+21 −21
Merged

Fix doc URLs in alerts and dashboards #1906

Show file tree
Hide file tree
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: 7 additions & 7 deletions deploy/helm/clickhouse-operator/files/Altinity_ClickHouse_Operator_dashboard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -1412,7 +1412,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-concurrent-queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -1727,7 +1727,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -2253,7 +2253,7 @@
{
"targetBlank": true,
"title": "max_replica_delay_for_distributed_queries",
"url": "https://clickhouse.com/docs/en/operations/settings/settings#settings-max_replica_delay_for_distributed_queries"
"url": "https://clickhouse.com/docs/operations/settings/settings#max_replica_delay_for_distributed_queries"
}
],
"options": {
Expand Down Expand Up @@ -4298,7 +4298,7 @@
{
"targetBlank": true,
"title": "mark_cache_size",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-mark-cache-size"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#mark_cache_size"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -5335,12 +5335,12 @@
{
"targetBlank": true,
"title": "max_connections",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-connections"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_connections"
},
{
"targetBlank": true,
"title": "max_distributed_connections",
"url": "https://clickhouse.com/docs/en/operations/settings/settings#max-distributed-connections"
"url": "https://clickhouse.com/docs/operations/settings/settings#max_distributed_connections"
},
{
"targetBlank": true,
Expand Down
14 changes: 7 additions & 7 deletions deploy/prometheus/prometheus-alert-rules-clickhouse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ spec:
`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 }}
Please check DNS settings in `/etc/resolve.conf` and `<remote_servers>` part of `/etc/clickhouse-server/`
See documentation:
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-remote-servers
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-disable-internal-dns-cache
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#remote_servers
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#disable_internal_dns_cache
- https://clickhouse.com/docs/en/sql-reference/statements/system/

- alert: ClickHouseDistributedFilesToInsertHigh
Expand Down Expand Up @@ -112,7 +112,7 @@ spec:
`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 }}

Please, check communications between clickhouse server and host `remote_servers` in `/etc/clickhouse-server/`
https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-settings-remote-servers
https://clickhouse.com/docs/operations/server-configuration-parameters/settings#remote_servers

Also, you can check logs:
```kubectl logs -n {{ $labels.exported_namespace }} $( echo {{ $labels.hostname }} | cut -d '.' -f 1)-0 -f```
Expand Down Expand Up @@ -178,7 +178,7 @@ spec:
Please use Buffer table
https://clickhouse.com/docs/en/engines/table-engines/special/buffer/
or
https://clickhouse.com/docs/en/operations/settings/settings/#async-insert
https://clickhouse.com/docs/operations/settings/settings#async_insert

- alert: ClickHouseLongestRunningQuery
expr: chi_clickhouse_metric_LongestRunningQuery > 600
Expand Down Expand Up @@ -259,7 +259,7 @@ spec:
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.

Also read documentation:
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#max-concurrent-queries
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries


- alert: ClickHouseTooManyRunningQueries
Expand All @@ -279,7 +279,7 @@ spec:
Look at following documentation parts:
- https://clickhouse.com/docs/en/operations/settings/query-complexity/
- https://clickhouse.com/docs/en/operations/quotas/
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#max-concurrent-queries
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries
- https://clickhouse.com/docs/en/operations/system-tables/query_log/

- alert: ClickHouseSystemSettingsChanged
Expand Down Expand Up @@ -527,7 +527,7 @@ spec:
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 }}
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 }}
- https://kb.altinity.com/altinity-kb-integrations/altinity-kb-kafka/background_message_broker_schedule_pool_size/
- https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#background_message_broker_schedule_pool_size
- https://clickhouse.com/docs/operations/server-configuration-parameters/settings#background_message_broker_schedule_pool_size
- https://clickhouse.com/docs/en/operations/system-tables/metrics#backgroundmessagebrokerschedulepoolsize
This pool is used for tasks related to message streaming from Apache Kafka or other message brokers.
You need to increase `background_message_broker_schedule_pool_size` to fix the problem.
Expand Down
14 changes: 7 additions & 7 deletions grafana-dashboard/Altinity_ClickHouse_Operator_dashboard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -1412,7 +1412,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-concurrent-queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -1727,7 +1727,7 @@
{
"targetBlank": true,
"title": "max_concurent_queries",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max_concurrent_queries"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_concurrent_queries"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -2253,7 +2253,7 @@
{
"targetBlank": true,
"title": "max_replica_delay_for_distributed_queries",
"url": "https://clickhouse.com/docs/en/operations/settings/settings#settings-max_replica_delay_for_distributed_queries"
"url": "https://clickhouse.com/docs/operations/settings/settings#max_replica_delay_for_distributed_queries"
}
],
"options": {
Expand Down Expand Up @@ -4298,7 +4298,7 @@
{
"targetBlank": true,
"title": "mark_cache_size",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings/#server-mark-cache-size"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#mark_cache_size"
},
{
"targetBlank": true,
Expand Down Expand Up @@ -5335,12 +5335,12 @@
{
"targetBlank": true,
"title": "max_connections",
"url": "https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#max-connections"
"url": "https://clickhouse.com/docs/operations/server-configuration-parameters/settings#max_connections"
},
{
"targetBlank": true,
"title": "max_distributed_connections",
"url": "https://clickhouse.com/docs/en/operations/settings/settings#max-distributed-connections"
"url": "https://clickhouse.com/docs/operations/settings/settings#max_distributed_connections"
},
{
"targetBlank": true,
Expand Down