Настройки Yandex StoreDoc
При создании или изменении кластера Yandex StoreDoc можно задать настройки, которые относятся к Yandex StoreDoc.
Метки рядом с названием настройки позволяют определить, с помощью какого интерфейса задается значение этой настройки: консоль управления, CLI или API.
В зависимости от выбранного интерфейса одна и та же настройка будет представлена по-разному. Например, Max incoming connections в консоли управления соответствует:
max_incoming_connectionsв gRPC или CLI;maxIncomingConnectionsв REST API.
В шардированном кластере некоторые настройки доступны только для определенных ролей хостов.
Зависимость настроек от класса хостов
Значения некоторых настроек Yandex StoreDoc могут быть автоматически скорректированы при изменении класса хостов:
- Если значения не были заданы или не подходят новому классу, будут применены настройки по умолчанию для этого класса.
- Если заданные вручную настройки подходят для нового класса, они не будут изменены.
Список настроек, зависящих от класса хостов:
Настройки СУБД уровня кластера
-
Storage
Все интерфейсы-
Journal → Commit interval
Интервал в миллисекундах между сохранениями данных журнала Yandex StoreDoc на диск.
Минимальное значение —
1, максимальное значение —500, значение по умолчанию —300.Настройка недоступна для хостов с ролями
MONGOSиMONGOCFGшардированного кластера. -
Wired tiger
Настройки движка хранения данных:
-
Collection config → Block compressor
Настройка сжатия данных. Установленное здесь значение будет работать только для новых коллекций. Также вы можете переопределить его для отдельных коллекций и индексов.
none— сжатие отключено.snappy— использование библиотеки snappy для сжатия данных. При выборе этой настройки в большинстве случаев сжатие и распаковка будут быстрее, чем при использовании библиотекиzlib, но итоговый размер файлов будет на 20—100% больше.zlib— использование библиотеки zlib для сжатия данных. Этот способ работает медленнееsnappy, но в большинстве случаев лучше сжимает данные.
Настройка недоступна для хостов с ролями
MONGOSиMONGOCFGшардированного кластера. -
Engine config → Cache size gb
Максимальный размер внутреннего кеша, используемого для хранения данных (в гигабайтах). Эта настройка не влияет на объем RAM, используемый для построения индекса.
Значение по умолчанию зависит от RAM у выбранного класса хостов:
<объем_RAM_на_хосте> ≤ 2 ГБ—0.5;2 ГБ < <объем_RAM_на_хосте> ≤ 4 ГБ—1;<объем_RAM_на_хосте> > 4 ГБ— рассчитывается по формуле:(RAM − 1) ÷ 2.
Настройка Cache size имеет приоритет перед настройкой Cache size gb: если заданы обе настройки, берется значение Cache size.
Настройка Cache size gb недоступна для хостов с ролью
MONGOSшардированного кластера. -
Engine config → Cache size
Максимальный размер внутреннего кеша, используемого для хранения данных (в процентах).
Минимальное значение зависит от RAM у выбранного класса хостов. При этом размер внутреннего кеша должен быть не менее 0,25 ГБ в эквиваленте.
Максимальное значение —
90.Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. -
Index config → Prefix compression
Определяет, будет ли выполняться сжатие префиксов для индексов. Изменение параметра влияет на новые индексы, но не влияет на уже созданные.
Значение по умолчанию —
true(сжатие префиксов включено).Настройка недоступна для хостов с ролями
MONGOSиMONGOCFGшардированного кластера.
-
-
-
Operation profiling
Все интерфейсыНастройки профилировщика СУБД. Профилировщик собирает данные о запросах. Затем на основе этих данных формируется стратегия оптимизации запросов.
-
Mode
Режим работы профилировщика СУБД:
off— профилирование выключено;slowOp(по умолчанию) — собирается информация только о медленных операциях (выполняющихся дольше порога, заданного настройкой Slow op threshold);all— собирается информация обо всех выполняющихся запросах.
Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. -
Slow op sample rate
Доля медленных операций, которые следует профилировать или логировать. Параметр влияет на журнал диагностики и на профилировщик, если он включен.
Минимальное значение —
0, максимальное значение —1, значение по умолчанию —1.Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. -
Slow op threshold
Время выполнения операции (в миллисекундах), при превышении которого она будет считаться медленной.
Минимальное значение —
0, максимальное значение —36000000(10 часов), значение по умолчанию —300.Настройка недоступна для хостов с ролью
MONGOSшардированного кластера.
-
-
Net
Все интерфейсыНастройки сетевого взаимодействия.
-
Max incoming connections
Максимальное количество входящих соединений.
Минимальное значение —
10, максимальное значение зависит от выбранного класса хостов и равно объему RAM на хосте в МБ, но не более16384. Значение по умолчанию:1024.Подробнее в разделе Ограничения на количество подключений.
-
Compression → Compressors
Список методов сжатия, которые может использовать хост с ролью
MONGODилиMONGOSдля сжатия сетевых сообщений. Порядок перечисления методов важен.Значение
disabledотключает сжатие. Значение по умолчанию —snappy,zstd,zlib.
-
-
Audit Log
Все интерфейсыНастройки логов системы аудита.
-
Filter
Настройка определяет, какие события аудита будут записаны в лог. Входным параметром служит любое поле из сообщения аудита в формате JSON-строки.
Например, чтобы логировать только события аудита, связанные с пользователями
example-userиnew-user, укажите:{ "user": { $in: [ "example-user", "new-user" ] } }
Примечание
Вы также можете настроить выгрузку аудитных логов кластера в трейл с помощью сервиса Yandex Audit Trails.
-
-
Set parameter
-
Audit authorization success
Все интерфейсыОпределяет, будет ли система аудита записывать в журнал успешные операции авторизации (authCheck). При значении
trueсистема будет регистрировать как авторизованные, так и неавторизованные операции.Значение по умолчанию —
false(регистрируются только неудачные попытки авторизации). -
Enable flow control
Все интерфейсыОпределяет, будет ли контролироваться скорость, с которой основной хост выполняет операции записи. Включение параметра гарантирует, что у хостов-реплик метрика «большинство записало изменение» будет не больше установленного значения Flow control target lag seconds.
Значение по умолчанию —
false(контроль скорости отключен).Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. -
Flow control target lag seconds
Все интерфейсыПри включенной настройке Enable flow control большинство операций записи будут выполняться в пределах заданного в настройке Flow control target lag seconds лимита времени (в секундах).
Значение по умолчанию —
10.Настройка доступна только для хостов с ролью
MONGOD. -
Flow control warn threshold seconds
Все интерфейсыПри включенной настройке Enable flow control механизм управления потоком следит за точкой фиксации большинства (majority commit point). Если эта точка не изменяется в течение заданного в настройке Flow control warn threshold seconds времени (в секундах), то в лог записывается предупреждение.
Значение по умолчанию —
10. Значение0отключает предупреждения.Настройка доступна только для хостов с ролью
MONGOD. -
Migrate clone insertion batch delay ms
Все интерфейсыВремя ожидания (в миллисекундах) между пакетами вставок на этапе клонирования при миграции чанков между шардами.
Значение по умолчанию —
0(нет задержек между пакетами вставок).Настройка доступна только для хостов с ролью
MONGOD. -
Migrate clone insertion batch size
Все интерфейсыМаксимальное количество документов, которые можно вставить за один пакет на этапе клонирования при миграции чанков между шардами.
Значение по умолчанию —
0(ограничений на количество документов нет).Настройка доступна только для хостов с ролью
MONGOD. -
Min snapshot history window in seconds
Все интерфейсыВремя в секундах, в течение которого хранится история снапшотов.
Возможные значения — от нуля и выше, значение по умолчанию —
60. Увеличение значения настройки увеличивает использование диска.Настройка доступна только для хостов с ролью
MONGOD. -
Orphan cleanup delay secs
Все интерфейсыМинимальная задержка (в секундах) перед удалением перенесенного фрагмента из шарда-источника.
Значение по умолчанию —
900(15 минут).Настройка доступна только для хостов с ролью
MONGOD. -
Persisted chunk cache update max batch size
Все интерфейсыМаксимальное количество документов в пакете при обновлении данных в кеше сохраненных фрагментов.
Значение по умолчанию —
1000.Настройка доступна только для хостов с ролью
MONGOD. -
Range deleter batch delay ms
Все интерфейсыВремя задержки (в миллисекундах) перед следующим пакетом удалений на этапе очистки при миграции чанков между шардами (или при выполнении команды
cleanupOrphaned).Значение по умолчанию —
20.Настройка доступна только для хостов с ролью
MONGOD. -
Range deleter batch size
Все интерфейсыМаксимальное количество документов в каждом пакете, которые будут удалены на этапе очистки при миграции чанков между шардами (или при выполнении команды
cleanupOrphaned).Значение по умолчанию —
2147483647.Настройка доступна только для хостов с ролью
MONGOD. -
Mirror reads
Все интерфейсыНастройки зеркального чтения данных.
-
Sampling rate
Частота дискретизации, с которой хост-мастер зеркалирует операции чтения на доступные для выбора хосты-реплики.
Значение должно быть в диапазоне от
0.0(зеркалирование отключено) до1.0(хост-мастер дублирует все операции, поддерживающие зеркалирование, на каждый доступный хост-реплику).Значение по умолчанию —
0.01.Настройка доступна только для хостов с ролью
MONGOD. -
Max time ms
Максимальное время (в миллисекундах) для зеркального чтения.
Значение по умолчанию —
1000.Настройка доступна только для хостов с ролью
MONGOD.
-
-
Read hedging mode
Все интерфейсыУказывает, поддерживают ли хосты
MONGOSхеджирование для операций чтения, у которых включена опция хеджированного чтения.Значение по умолчанию —
on.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool max size
Все интерфейсыМаксимальное количество исходящих соединений, которые каждый пул соединений TaskExecutor может установить с любым хостом
MONGOD.Значение по умолчанию —
32767.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool max connecting
Все интерфейсыМаксимальное количество одновременно инициируемых соединений (включая ожидающие соединения в состоянии установки или обновления) к хосту
MONGOD, которое может поддерживать каждый пул соединений TaskExecutor.Значение по умолчанию —
2.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool min size
Все интерфейсыМинимальное количество исходящих соединений, которые каждый пул соединений TaskExecutor должен установить с любым хостом
MONGOD.Значение по умолчанию —
1.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool replica set matching
Все интерфейсыПолитика, которая определяет минимальный размер пулов соединений хоста
MONGOSс каждым набором реплик.Возможные значения:
automatic(по умолчанию) — соответствует значениюmatchPrimaryNode.matchPrimaryNode— минимальный размер пула соединений хостаMONGOSс каждым хостом-репликой равен размеру его пула соединений с хостом-мастером.matchBusiestNode— минимальный размер пула соединений хостаMONGOSс каждым хостом из набора реплик равен наибольшему из значений количества активных соединений с хостом-мастером и каждым хостом-репликой.disabled— минимальный размер пула соединений хостаMONGOSс каждым хостом-репликой равен значению настройки ShardingTaskExecutorPoolMinSize.
Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool host timeout ms
Все интерфейсыМаксимальное время (в миллисекундах), в течение которого хост
MONGOSожидает связи с хостом, прежде чем разорвет все соединения с ним.Значение по умолчанию —
300000(5 минут).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool refresh requirement ms
Все интерфейсыМаксимальное время (в миллисекундах), в течение которого хост
MONGOSожидает, прежде чем проверить состояние неактивного соединения в пуле.Значение по умолчанию —
60000(1 минута).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool refresh timeout ms
Все интерфейсыМаксимальное время (в миллисекундах), в течение которого хост
MONGOSожидает подтверждения соединения.Значение по умолчанию —
20000(20 секунд).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Warm min connections in sharding task executor pool on startup
Все интерфейсыЕсли этот параметр включен,
MONGOSпытается установить минимальное количество сетевых соединений с каждым хостом, прежде чем начнет принимать клиентские соединения.Значение по умолчанию —
true.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Warm min connections in sharding task executor pool on startup wait ms
Все интерфейсыОпределяет время (в миллисекундах), в течение которого хост
MONGOSожидает установки соединений с каждым хостом. Настройка учитывается, только если включена настройка Warm min connections in sharding task executor pool on startup.Значение по умолчанию —
2000(2 секунды).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool max size for config servers
Все интерфейсыМаксимальное количество исходящих соединений, которые каждый пул соединений TaskExecutor может установить с любым хостом
MONGOCFG. Эта настройка переопределяет значение настройки Sharding task executor pool max size применительно к хостамMONGOCFG.Значение по умолчанию —
-1(используется значение настройки Sharding task executor pool max size).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера. -
Sharding task executor pool min size for config servers
Все интерфейсыМинимальное количество исходящих соединений, которые каждый пул соединений TaskExecutor может установить с любым хостом
MONGOCFG. Эта настройка переопределяет значение настройки Sharding task executor pool min size применительно к хостамMONGOCFG.Значение по умолчанию —
-1(используется значение настройки Sharding task executor pool min size).Настройка доступна только для хостов с ролью
MONGOSшардированного кластера.
-
-
Oplog
Все интерфейсыНастройки oplog (журнал всех операций, изменяющих данные в базе данных).
-
Max size percent
Максимальный размер oplog в процентах от размера диска.
Значение по умолчанию:
- для хостов с ролью
MONGOD—5; - для хостов с ролью
MONGOCFG—0.
Минимально допустимый размер oplog в мегабайтах —
990. Если процент от размера диска составляет менее 990 МБ, то размер oplog устанавливается равным 990 МБ. Фактически для хостовMONGOCFGзначение по умолчанию всегда равно 990 МБ.Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. - для хостов с ролью
-
Min retention hours
Минимальное количество часов, чтобы хранить записи oplog. Эта настройка позволяет хранить старые записи oplog в течение указанного времени, даже если новые записи увеличивают размер коллекции сверх установленного предела.
Значение настройки может быть дробным. Например, значение
1.5означает один час тридцать минут.Значение по умолчанию:
- для хостов с ролью
MONGOD—0(отключено хранение записей oplog); - для хостов с ролью
MONGOCFG—24.
Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. - для хостов с ролью
-
-
Chaining allowed
Все интерфейсыОпределяет, разрешена ли цепная репликация, при которой хосты-реплики могут реплицировать данные с других хостов-реплик.
Значение по умолчанию —
true.Настройка недоступна для хостов с ролью
MONGOSшардированного кластера. -
Chunk Size
Все интерфейсыРазмер каждого чанка (в мегабайтах).
Максимальное значение —
1024, значение по умолчанию —128.Настройка доступна только для хостов с ролью
MONGOSшардированного кластера.