Конфигурационные параметры

В этой статье описаны параметры, которые могут быть настроены для сервисов ADQM через ADCM. Процесс настройки сервисов приведен в статьях Online-установка и Offline-установка.

ПРИМЕЧАНИЕ
Некоторые из перечисленных параметров становятся доступны в UI ADCM после установки флага Show advanced.

ADQMDB

SSL
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable SSL.

  • В статье Шифрование SSL приведен пример, как настроить проверку SSL-сертификатов для соединений с ADQM.

Параметр Описание Значение по умолчанию

Enable https

Включает порт для соединения с ADQM по протоколу HTTPS

Активен

HTTPS port

Порт для соединения с ADQM по протоколу HTTPS

8443

Enable tcp secure

Включает TCP-порт для SSL-защищенного соединения

Активен

TCP secure port

TCP-порт для SSL-защищенного подключения

9440

Disable protocols

Протоколы, которые не разрешено использовать для подключения

 — 

Certificate file

Путь к файлу серверного SSL-сертификата в формате PEM

/etc/clickhouse-server/server.crt

Private key file

Путь к файлу закрытого ключа серверного SSL-сертификата

/etc/clickhouse-server/server.key

Certificate authority file

Путь к файлу корневого сертификата центра сертификации (Certification Authority, CA)

/etc/clickhouse-server/ca.crt

Client certificate verification mode

Режим проверки пользовательских SSL-сертификатов, подписанных корневым сертификатом (путь к файлу корневого сертификата должен быть указан в Certificate authority file). Возможные значения: none, relaxed, strict, once

Неактивен

gRPC
ПРИМЕЧАНИЕ

Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable gRPC.

Параметр Описание Значение по умолчанию

gRPC port

Порт для клиентских соединений через интерфейс gRPC

9100

Enable SSL

Включает SSL для защищенного взаимодействия с клиентами через gRPC

Неактивен

SSL certificate file

Путь к файлу SSL-сертификата (в формате PEM) для gRPC-подключений. Используется при включенном SSL

/etc/clickhouse-server/grpc_ssl_cert_file.crt

SSL private key file

Путь к файлу закрытого ключа SSL-сертификата для gRPC-подключений. Используется при включенном SSL

/etc/clickhouse-server/grpc_ssl_key_file.key

Client auth required

Указывает, будет ли сервер запрашивать у клиента сертификат. Если опция включена, необходимо указать Certificate authority file

Неактивен

Certificate authority file

Путь к файлу корневого сертификата центра сертификации (Certification Authority, CA) в формате PEM, который будет использоваться для проверки клиентских сертификатов. Указывается при включенной опции Client auth required

 — 

Compression algorithm

Алгоритм сжатия, необходимый для минимизации трафика. Возможные значения: none, gzip, stream_gzip

deflate

Compression level

Уровень сжатия трафика. Возможные значения: none, low, medium, high

medium

Send message size limits

Ограничение на размер отправляемых сообщений (в байтах). При -1 ограничение отсутствует

-1

Receive message size limits

Ограничение на размер принимаемых сообщений (в байтах). При -1 ограничение отсутствует

-1

Verbose logs

Указывает, записываются ли детализированные логи

Неактивен

LDAP
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable LDAP.

  • В статье Аутентификация с использованием LDAP описаны подходы использования удаленного сервера LDAP для аутентификации пользователей.

Параметр Описание Значение по умолчанию

LDAP hostname

Имя хоста или IP сервера LDAP. Этот параметр является обязательным и не может быть пустым

localhost

LDAP port

Порт сервера LDAP. По умолчанию используется порт 636, если настройка Enable TLS установлена в yes, иначе — 389

636

DN prefix

Префикс, используемый для построения DN-подключения. Результирующий DN будет построен как строка auth_dn_prefix + escape(user_name) + auth_dn_suffix

uid=

DN suffix

Суффикс, используемый для построения DN-подключения. Результирующий DN будет построен как строка auth_dn_prefix + escape(user_name) + auth_dn_suffix. Обратите внимание, подразумевается, что auth_dn_suffix должен содержать запятую в качестве первого непробельного символа

,ou=users,dc=example,dc=com

Enable TLS

Флаг для включения использования безопасного соединения с сервером LDAP.

Доступны следующие значения:

  • no — для использования текстового протокола (ldap://), не рекомендуется;

  • yes — для обращения к LDAP по протоколу SSL/TLS (ldaps://), рекомендуется;

  • starttls — для использования устаревшего протокола StartTLS (простой текстовый протокол, обновленный до TLS).

no

TLS min version

Минимальная версия протокола SSL/TLS. Принимаются следующие значения: ssl2, ssl3, tls1.0, tls1.1, tls1.2

tls1.2

TLS require cert

Поведение при проверке сертификата SSL/TLS. Принимаются следующие значения: never, allow, try, demand

demand

TLS cert file

Путь к файлу сертификата

/path/to/tls_cert_file

TLS key file

Путь к файлу ключа сертификата

/path/to/tls_key_file

CA cert file

Путь к файлу корневого сертификата (Certification Authority, CA)

/path/to/tls_ca_cert_file

path to CA certificates

Путь к каталогу, содержащему корневые сертификаты

/path/to/tls_ca_cert_dir

Cipher suite

Разрешенный набор шифров

 — 

Enable RBAC

Активирует управление доступом на основе ролей

Неактивен

Default role

Роль по умолчанию для всех аутентифицированных пользователей

default

Base DN

Базовый DN для поиска в дереве LDAP

ou=Groups,dc=ad,dc=ranger-test

Search filter

Фильтр поиска в дереве LDAP с шаблонами {user_name}, {bind_dn} и {user_dn}

(&(objectClass=groupOfNames)(member={bind_dn}))

Attribute

Атрибут для поиска в дереве LDAP

cn

Role prefix

Префикс значения атрибута для поиска в дереве LDAP

adqm_

Kafka engine
ПРИМЕЧАНИЕ

Чтобы получить доступ к параметрам конфигурации, необходимо активировать опцию Kafka engine.

Параметр Описание Значение по умолчанию

Kafka Properties

В этом поле необходимо указать параметры табличного движка Kafka. Например: <debug>all</debug> <auto_offset_reset>latest</auto_offset_reset> <compression_type>snappy</compression_type>. Поле обязательно

 — 

Engine
Параметр Описание Значение по умолчанию

System

Сервис координации для репликации данных и выполнения распределенных DDL-запросов. Возможные значения: Zookeeper, Clickhouse_keeper (integrated), Clickhouse_keeper (allocated)

Zookeeper

Clickhouse Keeper (integrated)
ПРИМЕЧАНИЕ

Чтобы получить доступ к параметрам конфигурации, необходимо активировать опцию Clickhouse Keeper (integrated).

Параметр Описание Значение по умолчанию

Number of nodes in cluster

Количество узлов в кластере, которые будут использоваться для ClickHouse Keeper

1

Enable IPv6

Позволяет отключить IPv6, если хосты не поддерживают этот протокол

Активен

TCP port

Порт для подключения клиента

2129

Log storage path

Путь к журналам координации

/var/lib/clickhouse-keeper/coordination/log

Snapshot storage path

Путь к снепшотам координации

/var/lib/clickhouse-keeper/coordination/snapshots

Operation timeout ms

Тайм-аут для одной операции клиента (в миллисекундах)

10000

Session timeout ms

Тайм-аут для сеанса клиента (в миллисекундах)

30000

Snapshot distance

Частота, с которой ClickHouse Keeper будет делать новые снепшоты (по количеству записей в журналах)

100000

Raft logs level

Уровень логирования процесса координации (trace, debug и т. д.)

error

Rotate log storage interval

Количество записей в журнале для хранения в одном файле

10000

Port

Порт, на котором сервер прослушивает соединения RAFT

9444

root_path

Узел znode, который используется в качестве корня для узлов znode, используемых сервером ClickHouse

/clickhouse

Distributed DDL path

По этому ZK-пути ClickHouse отправляет DDL-задачи. В противном случае убедитесь, что в конфигурации нет пересечений с другими кластерами

/clickhouse/task_queue/ddl

Zookeeper
Параметр Описание Значение по умолчанию

root_path

Узел znode, который используется в качестве корня для узлов znode, используемых сервером ClickHouse

/clickhouse

Distributed DDL zookeeper path

По этому ZK-пути ClickHouse размещает DDL-задачи. Если этот CH-кластер единственный использует ZooKeeper — настраивать это поле не нужно. В противном случае убедитесь, что в конфигурации нет пересечений с другими кластерами

/clickhouse/task_queue/ddl

External zookeeper
ПРИМЕЧАНИЕ

Для доступа к параметрам конфигурации необходимо активировать External zookeeper.

Параметр Описание Значение по умолчанию

zk_hosts

Расположение всех серверов в ансамбле через запятую с указанием портов, через которые они взаимодействуют. Например, host1.mydomain.com:2181,host2.mydomain.com:2181,host3.mydomain.com:2181. Поле является обязательным

 — 

Limits
Параметр Описание Значение по умолчанию

Max connections

Максимальное количество входящих соединений

4096

Max concurrent queries

Максимальное количество одновременно обрабатываемых запросов

100

Max concurrent threads

Максимальное количество потоков для выполнения всех запросов (исключая потоки для получения данных с удаленных серверов). Если установленный предел достигнут, для выполнения запроса все равно будет выделен хотя бы один поток. Если значение параметра 0, ограничений нет

0

Max server memory usage

Позволяет ограничить объем оперативной памяти (в байтах), используемой сервером ClickHouse. Если значение параметра 0, ограничений нет

0

Max thread pool size

Позволяет ограничить количество потоков в глобальном пуле потоков, которые ClickHouse использует для обработки запросов (если в пуле нет свободных потоков для обработки запроса, создается новый поток)

10000

Network
Параметр Описание Значение по умолчанию

Enable http

Включает порт для соединения с ADQM по протоколу HTTP

Активен

ClickHouse http port

HTTP-порт для клиентских или прокси-соединений

8123

Enable tcp

Включает порт для соединения с ADQM по протоколу Native (ClickHouse TCP)

Активен

ClickHouse tcp port

Порт для TCP-соединений

9000

Listen host

Ограничение по хостам, с которых могут приходить запросы. Учитывайте возможное отсутствие IPv6 на целевом хосте и используйте, например, 0.0.0.0 в этом случае

::

Directories
Параметр Описание Значение по умолчанию

Data path

Путь к каталогу, содержащему данные

/var/lib/clickhouse/

Log path

Путь к каталогу, содержащему лог-файлы

/var/log/clickhouse-server/

Temp path

Путь к временным данным для обработки больших запросов

/var/lib/clickhouse/tmp/

User files path

Каталог с файлами пользователя. Используется в табличной функции file()

/var/lib/clickhouse/user_files/

Access control path

Путь к папке, в которой сервер ClickHouse хранит конфигурации пользователей и ролей, созданные командами SQL

/var/lib/clickhouse/access/

Cluster configuration
ПРИМЕЧАНИЕ

Особенности использования параметров конфигурирования кластера описаны в статье Конфигурирование логических кластеров в интерфейсе ADCM.

Параметр Описание Значение по умолчанию

Replication factor

Число шардов, умноженное на значение параметра replication factor — это общее число узлов в физическом кластере ADQM. Топология кластера и макросы генерируются один раз и не изменяются при дальнейшей реконфигурации кластера. Подробнее в статье Distributed Table Engine

1

Cluster Configuration

Позволяет добавлять параметры конфигурации кластера

 — 

Default cluster topology

Этот кластер включен в раздел remote_servers в конфигурации CH-узла. Чтобы получить доступ к этому параметру, необходимо активировать опцию Show advanced наверху страницы настройки сервиса

{}

Intra-cluster communication security
ПРИМЕЧАНИЕ

Для доступа к параметрам конфигурации необходимо активировать Intra-cluster communication security.

Параметр Описание Значение по умолчанию

Enable secure intra-cluster communication

Позволяет использовать для обмена данными между серверами ClickHouse только безопасные протоколы (HTTPS, TCP). При включении этой опции необходимо также включить SSL и активировать Enable TCP Secure

Неактивен

Interserver protocol’s port

Порт для обмена данными между серверами ClickHouse по межсерверному протоколу

9009

Interserver http name

Имя пользователя для аутентификации между репликами

 — 

Interserver http password

Пароль для аутентификации между репликами

 — 

Shard secret

Ключ кластера для проверки распределенных запросов на шардах

 — 

Kerberos configuration
Параметр Описание Значение по умолчанию

security

Тип используемого модуля Kerberos

 — 

keytab

Путь к файлу keytab

 — 

reinit_frequency

Частота реинициализации Kerberos

3600

principal

Принципал (principal) — уникальное имя для клиента, которому разрешается аутентификация в Kerberos

 — 

Log settings
ПРИМЕЧАНИЕ

В статье Логирование приведена общая информация о логах, которые ведет и записывает в файлы или системные таблицы ADQM.

Параметр Описание Значение по умолчанию

Logging level

Уровень детализации сообщений, записываемых в лог-файл. Возможные значения: trace, debug, information, notice, warning, error, critical, fatal, none

trace

Log file size, MB

Размер лог-файла (в МБ). Как только файл достигает указанного размера, он архивируется и переименовывается, a на его месте создается новый лог-файл

1000

Log files count

Количество архивных лог-файлов, которые хранит ADQM

10

Database

Имя системной базы данных, в которую записываются логи

system

Flush interval, milliseconds

Интервал перемещения данных из буфера памяти в таблицу (в миллисекундах)

7500

TTL, days

Время жизни логов (в днях)

30

query_log

Информация о выполненных запросах (например, время начала выполнения запроса, продолжительность обработки запроса, сообщения об ошибках). Это часто используемый лог. Он ведется, если установлен флаг. Чтобы отключить его, установите настройку log_queries = 0 на уровне сеанса или запроса

Неактивен

trace_log

Трассировки стека, собранные cемплирующим профилировщиком запросов, которые могут быть полезны для глубокого анализа производительности. Лог ведется, если установлен флаг

Неактивен

query_views_log

Информация о зависимых представлениях, выполняемых при обработке запросов (например, тип представления, продолжительность выполнения представления). Лог отключен по умолчанию (даже если установлен флаг) и работает только в том случае, если установлена настройка log_query_views = 1 на уровне сеанса или запроса

Неактивен

query_thread_log

Информация о потоках выполнения запросов (например, имя потока, время начала выполнения запроса потоком, продолжительность обработки запроса). Лог отключен по умолчанию (даже если установлен флаг) и работает только в том случае, если установлена настройка log_query_threads = 1 на уровне сеанса или запроса

Неактивен

part_log

Информация о событиях, связанных с кусками данных таблиц семейства MergeTree (например, добавление или объединение данных). Лог ведется, если установлен флаг, и не контролируется на уровне сеанса

Неактивен

crash_log

Информация о трассировках стека для фатальных ошибок. Лог ведется, если установлен флаг, и не контролируется на уровне сеанса

Неактивен

metric_log

Указывает, записывается ли история значений метрик из таблиц system.metrics и system.events в таблицу system.metric_log

Неактивен

asynchronous_metric_log

Указывает, записывается ли история значений метрик из таблицы system.asynchronous_metrics в таблицу system.asynchronous_metric_log

Неактивен

Default user and policy settings
Параметр Описание Значение по умолчанию

default_profile_settings

Позволяет добавить настройки профиля по умолчанию

max_memory_usage : 10000000000
use_uncompressed_cache : 0

Access Management

Контроль доступа и управление учетными записями для пользователя по умолчанию на основе SQL

Aктивен

Default user password

Пароль пользователя по умолчанию

 — 

Default user IP

Пользователь может подключаться к серверу ClickHouse только с указанного IP-адреса или подсети. Примеры: 192.168.0.0/16, 2001:DB8::/32

 — 

Default user host

Хост пользователя может быть указан как FQDN. Например, mysite.com

 — 

Default user host_regexp

Вы можете использовать регулярные выражения pcre при указании пользовательских хостов. Например, .+*+\.mysite\.com

 — 

User password options
Параметр Описание Значение по умолчанию

Allow plaintext password

Разрешает или запрещает назначать пользователям пароли в открытом текстовом формате

Aктивен

Allow NO_password

Разрешает или запрещает создание пользователя без пароля

Aктивен

Allow Implicit_NO_password

В сочетании с Allow NO_password запрещает создание пользователя без пароля, если явно не указано IDENTIFIED WITH no_password

Aктивен

Length of password

Минимальная длина пароля. По умолчанию 0 — длина пароля не ограничена

0

Include Upper-case

Указывает, должен ли пароль содержать хотя бы один символ в верхнем регистре

Неактивен

Include Lower-case

Указывает, должен ли пароль содержать хотя бы один символ в нижнем регистре

Неактивен

Include Number

Указывает, должен ли пароль содержать хотя бы одну цифру

Неактивен

Include special symbols

Указывает, должен ли пароль содержать хотя бы один специальный символ

Неактивен

Advanced configuration parameters
Параметр Описание Значение по умолчанию

Advanced parameters (name/value)

Параметры конфигурации для файла ClickHouse advanced.xml

 — 

Additional local storage
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable additional local storage.

  • В статье Настройка хранилища данных приведен пример, как сконфигурировать многоуровневое хранилище данных с использованием дополнительных блочных устройств (SSD- и HDD-диска).

Параметр Описание Значение по умолчанию

Disks

Список дисков в локальной файловой системе, на которых можно хранить табличные данные

 — 

Recursively create directories

Указывает, должны ли автоматически создаваться директории для локальных дисков, если они не существуют

Aктивен

S3 storage
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable S3 storage.

  • В статье Настройка хранилища данных описаны детали работы с дисками разных типов для хранения данных таблиц ADQM, в том числе приводятся описания параметров конфигурирования дисков S3.

Параметр Описание Значение по умолчанию

S3 disks

Список внешних дисков S3, которые можно использовать для хранения табличных данных

 — 

Encrypted storage
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable encrypted storage.

  • В статье Настройка хранилища данных описаны детали работы с дисками разных типов для хранения данных таблиц ADQM, в том числе приводятся описания параметров конфигурирования зашифрованных дисков.

Параметр Описание Значение по умолчанию

Encrypted disks

Список зашифрованных дисков, создаваемых поверх дисков других типов (локальных, S3, кеширующих)

 — 

Recursively create directories

Указывает, должны ли автоматически создаваться директории для зашифрованных дисков, если они не существуют

Aктивен

Cache
ПРИМЕЧАНИЕ
  • Чтобы получить доступ к параметрам конфигурации, необходимо активировать Enable cache.

  • В статье Настройка хранилища данных описаны детали работы с дисками разных типов для хранения данных таблиц ADQM, в том числе приводятся описания параметров конфигурирования кеширующих дисков.

Параметр Описание Значение по умолчанию

Cache disks

Список кеширующих дисков, создаваемых поверх внешних дисков с данными

 — 

Recursively create directories

Указывает, должны ли автоматически создаваться директории для кеширующих дисков, если они не существуют

Aктивен

Storage policies
ПРИМЕЧАНИЕ

Назначение и параметры конфигурирования политик хранения для таблиц ADQM описаны в статье Настройка хранилища данных.

Параметр Описание Значение по умолчанию

Policies

Список политик хранения, которые могут быть назначены таблицам

 — 

Data compression
ПРИМЕЧАНИЕ

Для доступа к параметрам конфигурации необходимо активировать Data compression.

Параметр Описание Значение по умолчанию

Minimum part size

Минимальный размер куска данных (в байтах)

10000000000

Minimum part size ratio

Отношение минимального размера куска данных к размеру таблицы

0.01

Method

Метод сжатия. Возможные значения: LZ4, LZ4HC, ZSTD

LZ4

Level

Уровень сжатия. Возможные значения:

  • для метода LZ4HC — [1, 12];

  • для метода ZSTD — [1, 22];

  • метод LZ4 не имеет уровней сжатия — любое значение игнорируется.

9

JDBC Bridge configuration
ПРИМЕЧАНИЕ

Подробная информация об интеграции ADQM с внешними источниками данных через интерфейс JDBC приведена в статье JDBC Bridge.

Параметр Описание Значение по умолчанию

jdbc bridge log path

Путь к каталогу, содержащему лог-файлы

/var/log/clickhouse-jdbc-bridge/

datasource.json

Источник данных для JDBC Bridge

[
    {
        "$schema": "./datasource.jschema",
        "postgres13": {
            "converter": {
                "mappings": [
                    {
                        "nativeType": "bool",
                        "toType": "String"
                    }
                ]
            },
            "driverUrls": [
                "drivers/postgresql/postgresql-jdbc.jar"
            ],
            "driverClassName": "org.postgresql.Driver",
            "jdbcUrl": "jdbc:postgresql://localhost/test",
            "username": "",
            "password": "",
            "initializationFailTimeout": 0,
            "minimumIdle": 0,
            "maximumPoolSize": 10
        }
    },
    {
        "$schema": "./datasource.jschema",
        "ch-server": {
            "driverUrls": [
                "drivers/clickhouse/clickhouse-jdbc.jar"
            ],
            "driverClassName": "ru.yandex.clickhouse.ClickHouseDriver",
            "jdbcUrl": "jdbc:clickhouse://ch-server:8123/system",
            "username": "default",
            "password": "",
            "initializationFailTimeout": 0,
            "minimumIdle": 0,
            "maximumPoolSize": 10
        }
    }
]

server.json

Конфигурация сервера для JDBC Bridge

"{\n \"requestTimeout\": 5000,\n \"queryTimeout\": 60000,\n \"configScanPeriod\": 5000,\n \"repositories\": [\n {\n \"entity\": \"ru.yandex.clickhouse.jdbcbridge.core.NamedDataSource\",\n \"repository\": \"ru.yandex.clickhouse.jdbcbridge.impl.JsonFileRepository\"\n },\n {\n \"entity\": \"ru.yandex.clickhouse.jdbcbridge.core.NamedSchema\",\n \"repository\": \"ru.yandex.clickhouse.jdbcbridge.impl.JsonFileRepository\"\n },\n {\n \"entity\": \"ru.yandex.clickhouse.jdbcbridge.core.NamedQuery\",\n \"repository\": \"ru.yandex.clickhouse.jdbcbridge.impl.JsonFileRepository\"\n }\n ],\n \"extensions\": [\n {\n \"class\": \"ru.yandex.clickhouse.jdbcbridge.impl.JdbcDataSource\"\n },\n {\n \"class\": \"ru.yandex.clickhouse.jdbcbridge.impl.ConfigDataSource\"\n },\n {\n \"class\": \"ru.yandex.clickhouse.jdbcbridge.impl.ScriptDataSource\"\n }\n ]\n}\n"

Encryption codecs for tables
Параметр Описание Значение по умолчанию

AES-128 GCM-SIV key

Ключ для алгоритма шифрования AES-128 в виде 32-символьной шестнадцатеричной строки. Например, 00112233445566778899AABBCCDDEEFF

 — 

AES-128 GCM-SIV nonce

Cлучайный код для алгоритма шифрования AES-128 в виде 24-символьной шестнадцатеричной строки. Например, ABCDEFABCDEFABCDEFABCDEF

 — 

AES-256 GCM-SIV key

Ключ для алгоритма шифрования AES-256 в виде 64-символьной шестнадцатеричной строки. Например, 00112233445566778899AABBCCDDEEFF00112233445566778899AABBCCDDEEFF

 — 

AES-256 GCM-SIV nonce

Cлучайный код для алгоритма шифрования AES-256 в виде 24-символьной шестнадцатеричной строки. Например, ABCDEFABCDEFABCDEFABCDEF

 — 

Other
Параметр Описание Значение по умолчанию

Time zone

Часовой пояс, используемый для преобразований между типами данных String и DateTime (например, когда значения полей типа DateTime выводятся в текстовом формате или при получении значений типа DateTime из строк). Если значение параметра установлено в System, будет использоваться значение параметра timezone, установленное в конфигурации сервера ADQM или в настройках операционной системы на момент запуска сервера

System

Default database

База данных по умолчанию

default

Default profile

Профиль настроек по умолчанию. Профили настроек находятся в файле, указанном в параметре user_config

default

Auto Core Dump Service

Указывает, включен ли автоматический дамп памяти. Включение/выключение автоматического дампа памяти управляется выполнением соответствующих действий для сервиса ADQMDB

Неактивен

Chproxy

Network configuration

 

Параметр Описание Значение по умолчанию

Enable HTTP

Включает прослушивание HTTP-запросов

Активен

HTTP listen port

Порт, на котором прослушиваются HTTP-запросы

9090

HTTP allowed networks

Список сетей, из которых разрешен доступ по HTTP. Каждый элемент может содержать IP-адрес или маску подсети. Значение 127.0.0.1 добавлено в конфигурацию по умолчанию. Chproxy пытается обнаружить самые очевидные ошибки конфигурации, такие как allowed_networks: ["0.0.0.0/0"]

 — 

Enable HTTPS

Включает прослушивание HTTPS-запросов

Неактивен

HTTPS listen port

Порт, на котором прослушиваются HTTPS-запросы

8543

HTTPS allowed networks

Список сетей, из которых разрешен доступ по HTTPS. Каждый элемент может содержать IP-адрес или маску подсети. Значение 127.0.0.1 добавлено в конфигурацию по умолчанию. Chproxy пытается обнаружить самые очевидные ошибки конфигурации, такие как allowed_networks: ["0.0.0.0/0"]

 — 

Certificate file

Путь к файлу серверного SSL-сертификата в формате PEM

/etc/chproxy/server.crt

Private key file

Путь к файлу закрытого ключа серверного SSL-сертификата

/etc/chproxy/server.key

Proxy wildcarded users

 

Параметр Описание Значение по умолчанию

List of user names

Список значений, используемых как префиксы в именах wildcarded-пользователей, которые являются шаблонами вида prefix_*

 — 

ADQM cluster configuration

 

Параметр Описание Значение по умолчанию

Interval

Интервал проверки всех узлов кластера на доступность

5s

Timeout

Тайм-аут ожидания ответа от узлов кластера

5s

Zookeeper

Main

 

Параметр Описание Значение по умолчанию

connect

Строка подключения ZooKeeper, которая будет использоваться другими службами или кластерами. Генерируется автоматически

 — 

dataDir

Место, где ZooKeeper будет хранить снепшоты резидентной базы данных (in-memory database) и, если не указано иное, логи транзакций обновлений базы данных. Указывается как параметр dataDir в конфигурационном файле zoo.cfg

/var/lib/zookeeper

admin.serverPort

Порт AdminServer. Встроенный сервер Jetty, который предоставляет интерфейс HTTP для команд из четырехбуквенных слов

58080

zoo.cfg

 

Параметр Описание Значение по умолчанию

clientPort

Порт для прослушивания клиентских подключений, т.е. порт, к которому пытаются подключиться клиенты

2181

tickTime

Продолжительность одного тика (в миллисекундах), который является основной единицей времени, используемой ZooKeeper

2000

initLimit

Тайм-ауты (в тиках), которые ZooKeeper использует для ограничения времени, в течение которого серверы-последователи должны подключиться и синхронизироваться с лидером. Увеличивайте это значение по мере необходимости, если объем данных, которыми управляет ZooKeeper, большой

5

syncLimit

Количество времени (в тиках), в течение которого сервер должен синхронизироваться с ZooKeeper

2

maxClientCnxns

Максимальное количество активных подключений с одного хоста, указанного по IP-адресу, к одному узлу ансамбля ZooKeeper

0

autopurge.snapRetainCount

Когда функция автоматической очистки ZooKeeper включена, она сохраняет указанное количество последних снепшотов и соответствующие им логи транзакций в каталоги dataDir и dataLogDir соответственно, а остальные удаляет. Минимальное значение 3

3

autopurge.purgeInterval

Временной интервал (в часах), для которого должна быть запущена задача очистки. Установите целое положительное число, чтобы включить автоматическую очистку

24

Add key,value

Используйте это поле, чтобы задать дополнительные параметры, которые не отображаются в пользовательском интерфейсе ADCM, но разрешены в файле конфигурации zoo.cfg

 — 

zookeeper-env.sh

 

Параметр Описание Значение по умолчанию

ZOO_LOG_DIR

Каталог для хранения логов

/var/log/zookeeper

ZOOPIDFILE

Каталог для хранения ID процесса ZooKeeper

/var/run/zookeeper/zookeeper_server.pid

SERVER_JVMFLAGS

Используется для установки различных параметров JVM, связанных, например, со сборкой мусора

-Xmx1024m

JAVA

Путь к Java

$JAVA_HOME/bin/java

ZOO_LOG4J_PROP

Используется для установки уровня ведения журнала log4j и указания того, какие приложения журнала следует включить. Эффект от включения приложения журнала CONSOLE заключается в том, что журналы отправляются на стандартный вывод. Эффект от включения ROLLINGFILE заключается в том, что файл zookeeper.log создается, ротируется и истекает

INFO, CONSOLE, ROLLINGFILE

Clickhousekeeper

General settings

 

Параметр Описание Значение по умолчанию

Listen host

Ограничение по хостам, с которых могут приходить запросы. Учитывайте возможное отсутствие IPv6 на целевом хосте и используйте, например, 0.0.0.0 в этом случае

::

Enable IPv6

Позволяет отключить IPv6, если хосты не поддерживают этот протокол

Активен

TCP port

Порт для подключения клиента

2129

Log storage path

Путь к журналам координации

/var/lib/clickhouse-keeper/coordination/log

Snapshot storage path

Путь к снепшотам координации

/var/lib/clickhouse-keeper/coordination/snapshots

root_path

Узел znode, который используется в качестве корня для узлов znode, используемых сервером ClickHouse

/clickhouse

Distributed DDL path

ZK-путь, по которому ClickHouse отправляет DDL-задачи. В противном случае убедитесь, что в конфигурации нет пересечений с другими кластерами

/clickhouse/task_queue/ddl

Coordination settings

 

Параметр Описание Значение по умолчанию

Operation timeout ms

Тайм-аут для одной операции клиента (в миллисекундах)

10000

Session timeout ms

Тайм-аут для сеанса клиента (в миллисекундах)

30000

Snapshot distance

Частота, с которой ClickHouse Keeper будет делать новые снепшоты (по количеству записей в журналах)

100000

Raft logs level

Уровень логирования процесса координации (trace, debug и т. д.)

error

Rotate log storage interval

Количество записей в журнале для хранения в одном файле

10000

Raft settings

 

Параметр Описание Значение по умолчанию

Port

Порт, на котором сервер прослушивает соединения RAFT

9444

Logger options

 

Параметр Описание Значение по умолчанию

Log level

Уровень логирования (trace, debug, information, warning или error)

Trace

Log path

Путь к каталогу, содержащему лог-файлы

/var/log/clickhouse-keeper/

Log file size

Размер лог-файла (в МБ). Как только файл достигает указанного размера, он архивируется и переименовывается, a на его месте создается новый лог-файл

1000

Log file count

Количество архивных лог-файлов, которые хранит ClickHouse

5

Monitoring

ADQM’s services metric settings

 

Параметр Описание Значение по умолчанию

Clickhouse listen port

Порт доступа к метрикам сервера ClickHouse в формате Prometheus

9363

Clickhouse endpoint

Конечная точка, в которую экспортируются метрики сервера ClickHouse в формате Prometheus

/metrics

Zookeeper listen port

Порт доступа к метрикам сервиса Zookeeper в формате Prometheus

9020

Clickhouse Keeper listen port

Порт доступа к метрикам сервиса Clickhousekeeper в формате Prometheus

9010

Clickhouse Keeper endpoint

Конечная точка, в которую экспортируются метрики сервиса Clickhousekeeper в формате Prometheus

/metrics

Prometheus settings

 

Параметр Описание Значение по умолчанию

listen_address

Адрес для доступа к веб-интерфейсу Prometheus

0.0.0.0:9092

scrape_interval

Интервал сбора метрик

1m

scrape_timeout

Время ожидания данных

10s

grafana_password

Пароль пользователя Grafana (admprom_grafana) для подключения к Prometheus

 — 

Prometheus users to login/logout to Prometheus

Учетные данные пользователей для входа в веб-интерфейс Prometheus

 — 

Grafana settings

 

Параметр Описание Значение по умолчанию

Grafana administrator’s password

Пароль администратора Grafana

 — 

Grafana listen port

Порт доступа к web-интерфейсу Grafana

3000

Pushgateway settings

 

Параметр Описание Значение по умолчанию

listen_address

Адрес для доступа к Pushgateway Web API

0.0.0.0:9091

Node exporter settings

 

Параметр Описание Значение по умолчанию

Listen port

Порт доступа к системным метрикам хоста ADQM в формате Prometheus

9100

Metrics endpoint

Конечная точка, в которую node exporter экспортирует системные метрики в формате Prometheus

/metrics

Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней