ClickHouse/docs/en/operations/monitoring.md

45 lines
2.7 KiB
Markdown
Raw Normal View History

2020-04-03 13:23:32 +00:00
---
toc_priority: 45
toc_title: Monitoring
---
2020-03-20 10:10:48 +00:00
# Monitoring {#monitoring}
2019-02-04 13:30:28 +00:00
You can monitor:
- Utilization of hardware resources.
- ClickHouse server metrics.
2019-02-04 13:30:28 +00:00
2020-03-20 10:10:48 +00:00
## Resource Utilization {#resource-utilization}
2019-02-04 13:30:28 +00:00
ClickHouse does not monitor the state of hardware resources by itself.
It is highly recommended to set up monitoring for:
- Load and temperature on processors.
2019-02-04 13:30:28 +00:00
You can use [dmesg](https://en.wikipedia.org/wiki/Dmesg), [turbostat](https://www.linux.org/docs/man8/turbostat.html) or other instruments.
2019-02-04 13:30:28 +00:00
- Utilization of storage system, RAM and network.
2019-02-04 13:30:28 +00:00
## ClickHouse Server Metrics {#clickhouse-server-metrics}
2019-02-04 13:30:28 +00:00
ClickHouse server has embedded instruments for self-state monitoring.
2020-04-03 13:23:32 +00:00
To track server events use server logs. See the [logger](server_configuration_parameters/settings.md#server_configuration_parameters-logger) section of the configuration file.
2019-02-04 13:30:28 +00:00
ClickHouse collects:
- Different metrics of how the server uses computational resources.
- Common statistics on query processing.
2020-04-03 13:23:32 +00:00
You can find metrics in the [system.metrics](../operations/system_tables.md#system_tables-metrics), [system.events](../operations/system_tables.md#system_tables-events), and [system.asynchronous\_metrics](../operations/system_tables.md#system_tables-asynchronous_metrics) tables.
2019-02-04 13:30:28 +00:00
2020-04-03 13:23:32 +00:00
You can configure ClickHouse to export metrics to [Graphite](https://github.com/graphite-project). See the [Graphite section](server_configuration_parameters/settings.md#server_configuration_parameters-graphite) in the ClickHouse server configuration file. Before configuring export of metrics, you should set up Graphite by following their official [guide](https://graphite.readthedocs.io/en/latest/install.html).
2019-02-04 13:30:28 +00:00
You can configure ClickHouse to export metrics to [Prometheus](https://prometheus.io). See the [Prometheus section](server_configuration_parameters/settings.md#server_configuration_parameters-prometheus) in the ClickHouse server configuration file. Before configuring export of metrics, you should set up Prometheus by following their official [guide](https://prometheus.io/docs/prometheus/latest/installation/).
Additionally, you can monitor server availability through the HTTP API. Send the `HTTP GET` request to `/ping`. If the server is available, it responds with `200 OK`.
2019-02-04 13:30:28 +00:00
2020-03-20 10:10:48 +00:00
To monitor servers in a cluster configuration, you should set the [max\_replica\_delay\_for\_distributed\_queries](settings/settings.md#settings-max_replica_delay_for_distributed_queries) parameter and use the HTTP resource `/replicas_status`. A request to `/replicas_status` returns `200 OK` if the replica is available and is not delayed behind the other replicas. If a replica is delayed, it returns `503 HTTP_SERVICE_UNAVAILABLE` with information about the gap.