mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-21 15:12:02 +00:00
add <prometheus> in server settings and monitoring section (#10015)
* add description for <prometheus> in server settings and monitoring section Signed-off-by: Slach <bloodjazman@gmail.com> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * Update docs/en/operations/server_settings/settings.md Co-Authored-By: BayoNet <da-daos@yandex.ru> * sync russian description with english Signed-off-by: Slach <bloodjazman@gmail.com> * Update docs/ru/operations/server_settings/settings.md * sync russian description with english Signed-off-by: Slach <bloodjazman@gmail.com> Co-authored-by: BayoNet <da-daos@yandex.ru> Co-authored-by: Ilya Yatsishin <2159081+qoega@users.noreply.github.com>
This commit is contained in:
Eugene Klimov
GitHub
parent
e86f549103
commit
68fa04054a
@ -37,6 +37,8 @@ You can find metrics in the [system.metrics](../operations/system_tables.md#syst
|
||||
|
||||
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).
|
||||
|
||||
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`.
|
||||
|
||||
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.
|
||||
|
||||
@ -536,6 +536,30 @@ The path to the directory containing data.
|
||||
<path>/var/lib/clickhouse/</path>
|
||||
```
|
||||
|
||||
## prometheus {#server_configuration_parameters-prometheus}
|
||||
|
||||
Exposing metrics data for scraping from [Prometheus](https://prometheus.io).
|
||||
|
||||
Settings:
|
||||
|
||||
- `endpoint` – HTTP endpoint for scraping metrics by prometheus server. Start from '/'.
|
||||
- `port` – Port for `endpoint`.
|
||||
- `metrics` – Flag that sets to expose metrics from the [system.metrics](../system_tables.md#system_tables-metrics) table.
|
||||
- `events` – Flag that sets to expose metrics from the [system.events](../system_tables.md#system_tables-events) table.
|
||||
- `asynchronous_metrics` – Flag that sets to expose current metrics values from the [system.asynchronous\_metrics](../system_tables.md#system_tables-asynchronous_metrics) table.
|
||||
|
||||
**Example**
|
||||
|
||||
``` xml
|
||||
<prometheus>
|
||||
<endpoint>/metrics</endpoint>
|
||||
<port>8001</port>
|
||||
<metrics>true</metrics>
|
||||
<events>true</events>
|
||||
<asynchronous_metrics>true</asynchronous_metrics>
|
||||
</prometheus>
|
||||
```
|
||||
|
||||
## query\_log {#server_configuration_parameters-query-log}
|
||||
|
||||
Setting for logging queries received with the [log\_queries=1](../settings/settings.md) setting.
|
||||
|
||||
@ -32,6 +32,8 @@ ClickHouse собирает:
|
||||
|
||||
Можно настроить экспорт метрик из ClickHouse в [Graphite](https://github.com/graphite-project). Смотрите секцию [graphite](server_configuration_parameters/settings.md#server_configuration_parameters-graphite) конфигурационного файла ClickHouse. Перед настройкой экспорта метрик необходимо настроить Graphite, как указано в [официальном руководстве](https://graphite.readthedocs.io/en/latest/install.html).
|
||||
|
||||
Можно настроить экспорт метрик из ClickHouse в [Prometheus](https://prometheus.io). Смотрите [prometheus](server_configuration_parameters/settings.md#server_configuration_parameters-prometheus) конфигурационного файла ClickHouse. Перед настройкой экспорта метрик необходимо настроить Prometheus, как указано в [официальном руководстве](https://prometheus.io/docs/prometheus/latest/installation/).
|
||||
|
||||
Также, можно отслеживать доступность сервера через HTTP API. Отправьте `HTTP GET` к ресурсу `/ping`. Если сервер доступен, он отвечает `200 OK`.
|
||||
|
||||
Для мониторинга серверов в кластерной конфигурации необходимо установить параметр [max\_replica\_delay\_for\_distributed\_queries](settings/settings.md#settings-max_replica_delay_for_distributed_queries) и использовать HTTP ресурс `/replicas_status`. Если реплика доступна и не отстаёт от других реплик, то запрос к `/replicas_status` возвращает `200 OK`. Если реплика отстаёт, то запрос возвращает `503 HTTP_SERVICE_UNAVAILABLE`, включая информацию о размере отставания.
|
||||
|
||||
@ -524,6 +524,30 @@ ClickHouse проверит условия `min_part_size` и `min_part_size_rat
|
||||
<path>/var/lib/clickhouse/</path>
|
||||
```
|
||||
|
||||
## prometheus {#server_configuration_parameters-prometheus}
|
||||
|
||||
Опубликовать данные о метриках, для сбора с помощью системы мониторинга [Prometheus](https://prometheus.io).
|
||||
|
||||
Настройки:
|
||||
|
||||
- `endpoint` – путь по которому будет осуществляться экспорт данных метрик по HTTP протоколу для сбора с помощью prometheus. Должен начинаться с '/'.
|
||||
- `port` – порт по которому будет доступен endpoint для сбора метрик.
|
||||
- `metrics` – флаг для экспорта текущих значений метрик из таблицы [system.metrics](../system_tables.md#system_tables-metrics).
|
||||
- `events` – флаг для экспорта текущих значений метрик из таблицы [system.events](../system_tables.md#system_tables-events).
|
||||
- `asynchronous_metrics` – флаг для экспорта текущих значений значения метрик из таблицы [system.asynchronous\_metrics](../system_tables.md#system_tables-asynchronous_metrics).
|
||||
|
||||
**Пример**
|
||||
|
||||
``` xml
|
||||
<prometheus>
|
||||
<endpoint>/metrics</endpoint>
|
||||
<port>8001</port>
|
||||
<metrics>true</metrics>
|
||||
<events>true</events>
|
||||
<asynchronous_metrics>true</asynchronous_metrics>
|
||||
</prometheus>
|
||||
```
|
||||
|
||||
## query\_log {#server_configuration_parameters-query-log}
|
||||
|
||||
Настройка логирования запросов, принятых с настройкой [log\_queries=1](../settings/settings.md).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user