DOCAPI-4994: Requirements, Monitoring and Troubleshooting are translated into Russian (#4269)

2024-11-10 01:25:21 +00:00 · 2019-02-05 17:35:58 +03:00 · 2019-02-05 17:35:58 +03:00 · af7c9bd2d7
commit af7c9bd2d7
parent d6c8b27c55
6 changed files with 255 additions and 20 deletions
--- a/docs/en/operations/monitoring.md
+++ b/docs/en/operations/monitoring.md
@ -21,9 +21,14 @@ It is highly recommended to set up monitoring for:

 ClickHouse server has embedded instruments for self-state monitoring.

-To monitor server events use server logs. See the [logger](#server_settings-logger) section of the configuration file.
+To track server events use server logs. See the [logger](#server_settings-logger) section of the configuration file.

-ClickHouse collects different metrics of computational resources usage and common statistics of queries processing. You can find metrics in tables [system.metrics](#system_tables-metrics), [system.events](#system_tables-events) и [system.asynchronous_metrics](#system_tables-asynchronous_metrics).
+ClickHouse collects:
+
+- Different metrics of how the server uses computational resources.
+- Common statistics of queries processing.
+
+You can find metrics in tables [system.metrics](#system_tables-metrics), [system.events](#system_tables-events) и [system.asynchronous_metrics](#system_tables-asynchronous_metrics).

 You can configure ClickHouse to export metrics to [Graphite](https://github.com/graphite-project). See the [Graphite section](server_settings/settings.md#server_settings-graphite) of ClickHouse server configuration file. Before configuring metrics export, you should set up Graphite by following their official guide https://graphite.readthedocs.io/en/latest/install.html.

--- a/docs/en/operations/requirements.md
+++ b/docs/en/operations/requirements.md
@ -2,7 +2,7 @@

 ## CPU

-In case of installation from prebuilt deb-packages use CPU with x86/64 architecture and SSE 4.2 instructions support. If you build ClickHouse from sources, you can use other processors.  
+In case of installation from prebuilt deb-packages use CPU with x86_64 architecture and SSE 4.2 instructions support. To run ClickHouse with processors than does not support SSE 4.2 or has AArch64 or PowerPC64LE architecture, you should build ClickHouse from sources.

 ClickHouse implements parallel data processing and uses all the hardware resources available. When choosing a processor, take into account that ClickHouse works more efficient at configurations with a large number of cores but lower clock rate than at configurations with fewer cores and a higher clock rate. For example, 16 cores with 2600 MHz is preferable than 8 cores with 3600 MHz.

@ -15,7 +15,7 @@ We recommend to use 4GB of RAM as minimum to be able to perform non-trivial quer
 The required volume of RAM depends on:

 - The complexity of queries.
- - Amount of the data in queries.
+ - Amount of the data, that processed in queries.

 To calculate the required volume of RAM, you should estimate the size of temporary data for [GROUP BY](../query_language/select.md#select-group-by-clause), [DISTINCT](../query_language/select.md#select-distinct), [JOIN](../query_language/select.md#select-join) and other operations you use.

@ -33,20 +33,22 @@ The volume of storage required for your data should be calculated separately. As

 - Estimation of a data volume.

-    You can take the sample of the data and get the size of a row from it. Then multiply the size of the row with a number of rows you plan to store.
+    You can take the sample of the data and get an average size of a row from it. Then multiply the value with a number of rows you plan to store.

 - Data compression coefficient.

-    To estimate the data compression coefficient, load some sample of your data into ClickHouse and compare the actual size of the data with the size of the table stored. For example, the typical compression coefficient for clickstream data lays in a range of 6-10 times.
+    To estimate the data compression coefficient, load some sample of your data into ClickHouse and compare the actual size of the data with the size of the table stored. For example, clickstream data are usually compressed by 6-10 times.

-To calculate the final volume of data to be stored, divide the estimated data volume by the compression coefficient.
+To calculate the final volume of data to be stored, apply the compression coefficient to the estimated data volume. If you plan to store data in several replicas, then multiply estimated volume with the number of replicas.

 ## Network

-If possible, use a 10G network.
+If possible, use networks of 10G of higher class.

 A bandwidth of the network is critical for processing of distributed queries with a large amount of intermediate data. Also, network speed affects replication processes.

 ## Software

-ClickHouse is developed for Linux family of operating systems. The recommended Linux distribution is Ubuntu. The `tzdata` package should be installed in the system. Name and version of an operating system where ClickHouse runs depend on the method of installation. See details in [Getting started](../getting_started/index.md) section of the documentation.
+ClickHouse is developed for Linux family of operating systems. The recommended Linux distribution is Ubuntu. The `tzdata` package should be installed in the system.
+
+ClickHouse also can work in other families of operating systems. See details in [Getting started](../getting_started/index.md) section of the documentation.
--- a/docs/en/operations/troubleshooting.md
+++ b/docs/en/operations/troubleshooting.md
@ -1,13 +1,11 @@
 # Troubleshooting

-Known issues:
+- [Installation](#troubleshooting-installation-errors)
+- [Connecting to the server](#troubleshooting-accepts-no-connections)
+- [Queries processing](#troubleshooting-does-not-process-queries)
+- [Efficiency of queries processing](#troubleshooting-too-slow)

- [Installation errors](#troubleshooting-installation-errors).
- [The server does not accept the connections](#troubleshooting-accepts-no-connections).
- [ClickHouse does not process queries](#troubleshooting-does-not-process-queries).
- [ClickHouse processes queries too slow](#troubleshooting-too-slow).
-
-## Installation Errors {#troubleshooting-installation-errors}
+## Installation {#troubleshooting-installation-errors}

 ### You Can Not Get Deb-packages from ClickHouse Repository With apt-get

@ -15,9 +13,9 @@ Known issues:
 - If you can not access the repository by any reason, download packages as described in the [Getting started](../getting_started/index.md) article and install them manually with `sudo dpkg -i <packages>` command. Also, you need `tzdata` package.


-## Server Does Not Accept the Connections {#troubleshooting-accepts-no-connections}
+## Connecting to the Server {#troubleshooting-accepts-no-connections}

-Possible reasons:
+Possible issues:

 - The server is not running.
 - Unexpected or wrong configuration parameters.
@ -122,7 +120,7 @@ Check:

    You may use the wrong user name or password for it.

-## ClickHouse Does Not Process Queries {#troubleshooting-does-not-process-queries}
+## Queries Processing {#troubleshooting-does-not-process-queries}

 If ClickHouse can not process the query, it sends the description of an error to the client. In the `clickhouse-client` you get a description of an error in console. If you use HTTP interface, ClickHouse sends error description in response body. For example,

@ -135,7 +133,7 @@ If you start `clickhouse-client` with `stack-trace` parameter, ClickHouse return

 It is possible that you see the message of connection broken. In this case, you can repeat query. If connection brakes any time you perform the query you should check the server logs for errors.

-## ClickHouse Processes Queries Not Fast Enough {#troubleshooting-too-slow}
+## Efficiency of Queries Processing {#troubleshooting-too-slow}

 If you see that ClickHouse works too slow, you need to profile the load of the server resources and network for your queries.

--- a/docs/ru/operations/monitoring.md
+++ b/docs/ru/operations/monitoring.md
@ -0,0 +1,37 @@
+# Мониторинг
+
+Вы можете отслеживать:
+
+- Использование аппаратных ресурсов.
+- Метрики сервера ClickHouse.
+
+## Использование ресурсов
+
+ClickHouse не отслеживает состояние аппаратных ресурсов самостоятельно.
+
+Рекомендуем контролировать:
+
+- Загрузку и температуру процессоров.
+
+    Можно использовать [dmesg](https://en.wikipedia.org/wiki/Dmesg), [turbostat](https://www.linux.org/docs/man8/turbostat.html) или другие инструменты.
+
+- Использование системы хранения, оперативной памяти и сети.
+
+## Метрики сервера ClickHouse.
+
+Сервер ClickHouse имеет встроенные инструменты мониторинга.
+
+Для отслеживания событий на сервере используйте логи. Подробнее смотрите в разделе конфигурационного файла [logger](#server_settings-logger).
+
+ClickHouse собирает:
+
+- Различные метрики того, как сервер использует вычислительные ресурсы.
+- Общую статистику обработки запросов.
+
+Метрики находятся в таблицах [system.metrics](#system_tables-metrics), [system.events](#system_tables-events) и [system.asynchronous_metrics](#system_tables-asynchronous_metrics).
+
+Можно настроить экспорт метрик из ClickHouse в [Graphite](https://github.com/graphite-project). Смотрите секцию [graphite](server_settings/settings.md#server_settings-graphite) конфигурационного файла ClickHouse. Перед настройкой экспорта метрик необходимо настроить Graphite, как указано в [официальном руководстве](https://graphite.readthedocs.io/en/latest/install.html).
+
+Также, можно отслеживать доступность сервера через HTTP API. Отправьте `HTTP GET` к ресурсу `/`. Если сервер доступен, он отвечает `200 OK`.
+
+Для мониторинга серверов в кластерной конфигурации необходимо установить параметр [max_replica_delay_for_distributed_queries](settings/settings.md#settings-max_replica_delay_for_distributed_queries) и использовать HTTP ресурс `/replicas-delay`. Если реплика доступна и не отстаёт от других реплик, то запрос к `/replicas-delay` возвращает `200 OK`. Если реплика отстаёт, то она возвращает информацию о размере отставания.
--- a/docs/ru/operations/requirements.md
+++ b/docs/ru/operations/requirements.md
@ -0,0 +1,54 @@
+# Требования
+
+## Процессор
+
+В случае установки из готовых deb-пакетов используйте процессоры с архитектурой x86_64 и поддержкой инструкций SSE 4.2. Для запуска ClickHouse на процессорах без поддержки SSE 4.2 или на процессорах с архитектурой AArch64 и PowerPC64LE необходимо собирать ClickHouse из исходников.
+
+ClickHouse реализует параллельную обработку данных и использует все доступные аппаратные ресурсы. При выборе процессора учитывайте, что ClickHouse работает более эффективно в конфигурациях с большим количеством ядер, но с более низкой тактовой частотой, чем в конфигурациях с меньшим количеством ядер и более высокой тактовой частотой. Например, 16 ядер с 2600 MHz предпочтительнее, чем 8 ядер с 3600 MHz.
+
+Рекомендуется использовать технологии **Turbo Boost** и **hyper-threading**. Их использование существенно улучшает производительность при типичной нагрузке.
+
+## RAM
+
+Мы рекомендуем использовать как минимум 4 ГБ оперативной памяти, чтобы иметь возможность выполнять нетривиальные запросы. Сервер ClickHouse может работать с гораздо меньшим объёмом RAM, память требуется для обработки запросов.
+
+Необходимый объем RAM зависит от:
+
+- Сложности запросов.
+- Объёма данных, обрабатываемых в запросах.
+
+Для расчета объема RAM необходимо оценить размер промежуточных данных для операций [GROUP BY](../query_language/select.md#select-group-by-clause), [DISTINCT](../query_language/select.md#select-distinct), [JOIN](../query_language/select.md#select-join) а также других операций, которыми вы пользуетесь.
+
+ClickHouse может использовать внешнюю память для промежуточных данных. Подробнее смотрите в разделе [GROUP BY во внешней памяти](../query_language/select.md#select-group-by-in-external-memory).
+
+## Файл подкачки
+
+Отключайте файл подкачки в продуктовых средах.
+
+## Подсистема хранения
+
+Для установки ClickHouse необходимо 2ГБ свободного места на диске.
+
+Объём дискового пространства, необходимый для хранения ваших данных, необходимо рассчитывать отдельно. Расчёт должен включать:
+
+- Приблизительную оценку объёма данных.
+
+    Можно взять образец данных и получить из него средний размер строки. Затем умножьте полученное значение на количество строк, которое вы планируете хранить.
+
+- Оценку коэффициента сжатия данных.
+
+    Чтобы оценить коэффициент сжатия данных, загрузите некоторую выборку данных в ClickHouse и сравните действительный размер данных с размером сохранённой таблицы. Например, данные типа clickstream обычно сжимаются в 6-10 раз.
+
+Для оценки объёма хранилища, примените коэффициент сжатия к размеру данных. Если вы планируете хранить данные в нескольких репликах, то необходимо полученный объём умножить на количество реплик.
+
+## Сеть
+
+По возможности, используйте сети 10G и более высокого класса.
+
+Пропускная способность сети критически важна для обработки распределенных запросов с большим количеством промежуточных данных. Также, скорость сети влияет на задержки в процессах репликации.
+
+## Программное обеспечение
+
+ClickHouse разработан для семейства операционных систем Linux. Рекомендуемый дистрибутив Linux — Ubuntu. В системе должен быть установлен пакет `tzdata`.
+
+ClickHouse может работать и в других семействах операционных систем. Подробнее смотрите разделе документации [Начало работы](../getting_started/index.md).
--- a/docs/ru/operations/troubleshooting.md
+++ b/docs/ru/operations/troubleshooting.md
@ -0,0 +1,139 @@
+# Устранение неисправностей
+
+- [Установка дистрибутива](#troubleshooting-installation-errors)
+- [Соединение с сервером](#troubleshooting-accepts-no-connections)
+- [Обработка запросов](#troubleshooting-does-not-process-queries)
+- [Скорость обработки запросов](#troubleshooting-too-slow)
+
+## Установка дистрибутива {#troubleshooting-installation-errors}
+
+### Не получается скачать deb-пакеты из репозитория ClickHouse с помощью apt-get
+
+- Проверьте настройки брандмауэра.
+- Если по какой-либо причине вы не можете получить доступ к репозиторию, скачайте пакеты как описано в разделе [Начало работы](../getting_started/index.md) и установите их вручную командой `sudo dpkg -i <packages>`. Также, необходим пакет `tzdata`.
+
+## Соединение с сервером {#troubleshooting-accepts-no-connections}
+
+Возможные проблемы:
+
+- Сервер не запущен.
+- Неожиданные или неправильные параметры конфигурации.
+
+### Сервер не запущен
+
+**Проверьте, запущен ли сервер**
+
+Команда:
+
+```
+sudo service clickhouse-server status
+```
+
+Если сервер не запущен, запустите его с помощью команды:
+
+```
+sudo service clickhouse-server start
+```
+
+**Проверьте журналы**
+
+Основной лог `clickhouse-server` по умолчанию — `/var/log/clickhouse-server/clickhouse-server.log`.
+
+В случае успешного запуска вы должны увидеть строки, содержащие:
+
+- `<Information> Application: starting up.` — сервер запускается.
+- `<Information> Application: Ready for connections.` — сервер запущен и готов принимать соединения.
+
+Если `clickhouse-server` не запустился из-за ошибки конфигурации вы  увидите `<Error>` строку с описанием ошибки. Например:
+
+```
+2019.01.11 15:23:25.549505 [ 45 ] {} <Error> ExternalDictionaries: Failed reloading 'event2id' external dictionary: Poco::Exception. Code: 1000, e.code() = 111, e.displayText() = Connection refused, e.what() = Connection refused
+```
+
+Если вы не видите ошибки в конце файла, просмотрите весь файл начиная со строки:
+
+```
+<Information> Application: starting up.
+```
+
+При попытке запустить второй экземпляр `clickhouse-server` журнал выглядит следующим образом:
+
+```
+2019.01.11 15:25:11.151730 [ 1 ] {} <Information> : Starting ClickHouse 19.1.0 with revision 54413
+2019.01.11 15:25:11.154578 [ 1 ] {} <Information> Application: starting up
+2019.01.11 15:25:11.156361 [ 1 ] {} <Information> StatusFile: Status file ./status already exists - unclean restart. Contents:
+PID: 8510
+Started at: 2019-01-11 15:24:23
+Revision: 54413
+
+2019.01.11 15:25:11.156673 [ 1 ] {} <Error> Application: DB::Exception: Cannot lock file ./status. Another server instance in same directory is already running.
+2019.01.11 15:25:11.156682 [ 1 ] {} <Information> Application: shutting down
+2019.01.11 15:25:11.156686 [ 1 ] {} <Debug> Application: Uninitializing subsystem: Logging Subsystem
+2019.01.11 15:25:11.156716 [ 2 ] {} <Information> BaseDaemon: Stop SignalListener thread
+```
+
+**Проверьте логи system.d**
+
+Если из логов `clickhouse-server` вы не получили необходимой информации или логов нет, то вы можете посмотреть логи `system.d` командой:
+
+```
+sudo journalctl -u clickhouse-server
+```
+
+**Запустите clickhouse-server в интерактивном режиме**
+
+```
+sudo -u clickhouse /usr/bin/clickhouse-server --config-file /etc/clickhouse-server/config.xml
+```
+
+Эта команда запускает сервер как интерактивное приложение со стандартными параметрами скрипта автозапуска. В этом режиме `clickhouse-server` выводит сообщения в консоль.
+
+### Параметры конфигурации
+
+Проверьте:
+
+- Настройки Docker.
+
+    При запуске ClickHouse в Docker в сети IPv6 убедитесь, что установлено `network=host`.
+
+- Параметры endpoint.
+
+    Проверьте настройки [listen_host](server_settings/settings.md#server_settings-listen_host) и [tcp_port](server_settings/settings.md#server_settings-tcp_port).
+
+    По умолчанию, сервер ClickHouse принимает только локальные подключения.
+
+- Настройки протокола HTTP.
+
+    Проверьте настройки протокола для HTTP API.
+
+- Параметры безопасного подключения.
+
+    Проверьте:
+
+    - Настройку `tcp_port_secure`.
+    - Параметры для SSL-сертификатов.
+
+     Используйте правильные параметры при подключении. Например, используйте параметр `port_secure` при использовании `clickhouse_client`.
+
+- Настройки пользователей.
+
+    Возможно, вы используете неверное имя пользователя или пароль.
+
+## Обработка запросов {#troubleshooting-does-not-process-queries}
+
+Если ClickHouse не может обработать запрос, он отправляет клиенту описание ошибки. В `clickhouse-client` вы получаете описание ошибки в консоли. При использовании интерфейса HTTP, ClickHouse отправляет описание ошибки в теле ответа. Например:
+
+```bash
+$ curl 'http://localhost:8123/' --data-binary "SELECT a"
+Code: 47, e.displayText() = DB::Exception: Unknown identifier: a. Note that there is no tables (FROM clause) in your query, context: required_names: 'a' source_tables: table_aliases: private_aliases: column_aliases: public_columns: 'a' masked_columns: array_join_columns: source_columns: , e.what() = DB::Exception
+```
+
+Если вы запускаете `clickhouse-client` c параметром `stack-trace`, то ClickHouse возвращает описание ошибки и соответствущий стек вызовов функций на сервере.
+
+Может появиться сообщение о разрыве соединения. В этом случае необходимо повторить запрос. Если соединение прерывается каждый раз при выполнении запроса, следует проверить журналы сервера на наличие ошибок.
+
+## Скорость обработки запросов {#troubleshooting-too-slow}
+
+Если вы видите, что ClickHouse работает слишком медленно, необходимо профилировать загрузку ресурсов сервера и сети для ваших запросов.
+
+Для профилирования запросов можно использовать утилиту clickhouse-benchmark. Она показывает количество запросов, обработанных за секунду, количество строк, обработанных за секунду и перцентили времени обработки запросов.