diff --git a/docs/reference/config.md b/docs/reference/config.md index 0862004b6daf579c9188ee92ef0fb73d773d976d..3442afa9ec488c32d6126c853785ccd1fe39d271 100644 --- a/docs/reference/config.md +++ b/docs/reference/config.md @@ -115,15 +115,6 @@ instance: ## Параметры файла конфигурации {: #config_file_parameters } -### cluster.tier.<tier_name\>.replication_factor {: #cluster_tier_tier_replication_factor } - -[Фактор репликации](../overview/glossary.md#replication_factor) тира *<tier_name\>*. - -Данные: - -* Тип: *int* -* Значение по умолчанию: `1` - ### cluster.tier.<tier_name\>.can_vote {: #cluster_tier_tier_can_vote } Признак тира *<tier_name\>*, определÑющий возможноÑÑ‚ÑŒ инÑтанÑов учаÑтвовать @@ -138,37 +129,61 @@ instance: * [ДинамичеÑкое переключение голоÑующих узлов в Raft](../architecture/raft_failover.md#raft_voter_failover) -### instance.log.format {: #instance_log_format } -<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-logging-log-format --> - -Формат отладочного журнала. +### cluster.tier.<tier_name\>.replication_factor {: #cluster_tier_tier_replication_factor } -Возможные значениÑ: `plain`, `json` +[Фактор репликации](../overview/glossary.md#replication_factor) тира *<tier_name\>*. Данные: -* Тип: *str* -* Значение по умолчанию: `plain` +* Тип: *int* +* Значение по умолчанию: `1` -### instance.memtx.memory {: #instance_memtx_memory } -<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-memtx-memory --> +### instance.iproto.max_concurrent_messages {: #instance_iproto_max_concurrent_messages } +<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-networking-net-msg-max --> -Объем памÑти *в байтах*, выделÑемый Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ ÐºÐ¾Ñ€Ñ‚ÐµÐ¶ÐµÐ¹. Когда -доÑтигаетÑÑ Ð»Ð¸Ð¼Ð¸Ñ‚ иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Ð¿Ð°Ð¼Ñти, запроÑÑ‹ команд [INSERT](./sql/insert.md) -и [UPDATE](./sql/update.md) начинают отклонÑÑ‚ÑŒÑÑ Ñ Ð¾ÑˆÐ¸Ð±ÐºÐ¾Ð¹ *ER_MEMORY_ISSUE*. -Сервер хранит в выделÑемом объеме памÑти только кортежи — Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð¸Ð½Ð´ÐµÐºÑов -и информации о ÑоединениÑÑ… иÑпользуетÑÑ Ð´Ð¾Ð¿Ð¾Ð»Ð½Ð¸Ñ‚ÐµÐ»ÑŒÐ½Ð°Ñ Ð¿Ð°Ð¼ÑÑ‚ÑŒ. +МакÑимальное количеÑтво Ñообщений, которое Picodata обрабатывает параллельно. -Минимальное значение — 33,554,432 байтов (32 МБ) +Ð”Ð»Ñ Ð¾Ð±Ñ€Ð°Ð±Ð¾Ñ‚ÐºÐ¸ Ñообщений Picodata иÑпользует файберы. Чтобы загруженноÑÑ‚ÑŒ +файберов не влиÑла на производительноÑÑ‚ÑŒ вÑей ÑиÑтемы, Picodata ограничивает +количеÑтво Ñообщений, обрабатываемых файберами, Ð±Ð»Ð¾ÐºÐ¸Ñ€ÑƒÑ Ð½ÐµÐºÐ¾Ñ‚Ð¾Ñ€Ñ‹Ðµ ожидающие +запроÑÑ‹. + +Ðа мощных ÑиÑтемах можно *увеличить* значение `max_concurrent_messages`, +тогда планировщик немедленно начнет обрабатывать ожидающие запроÑÑ‹. + +Ðа Ñлабых ÑиÑтемах можно *уменьшить* значение `max_concurrent_messages`, +тогда загруженноÑÑ‚ÑŒ файберов может ÑнизитьÑÑ, Ñ…Ð¾Ñ‚Ñ Ð¼Ð¾Ð¶ÐµÑ‚ потребоватьÑÑ +некоторое времÑ, пока планировщик дождетÑÑ Ð·Ð°Ð²ÐµÑ€ÑˆÐµÐ½Ð¸Ñ ÑƒÐ¶Ðµ обрабатываемых +запроÑов. + +Когда количеÑтво Ñообщений доÑтигает `max_concurrent_messages`, Picodata +приоÑтанавливает обработку входÑщих пакетов, пока не обработает предыдущие +ÑообщениÑ. Ðто не прÑмое ограничение количеÑтва файберов, обрабатывающих +Ñетевые ÑÐ¾Ð¾Ð±Ñ‰ÐµÐ½Ð¸Ñ â€” Ñкорее, Ñто общеÑиÑтемное ограничение пропуÑкной +ÑпоÑобноÑти канала. Ð’ Ñвою очередь, Ñто приводит к ограничению количеÑтва +входÑщих Ñетевых Ñообщений, которые обрабатывает поток процеÑÑора транзакций, +и, как ÑледÑтвие, коÑвенно влиÑет на файберы, обрабатывающие Ñетевые ÑообщениÑ. + +<!-- The number of fibers is smaller than the number of messages because messages +can be released as soon as they are delivered, while incoming requests might +not be processed until some time after delivery. --> Данные: * Тип: *int* -* Значение по умолчанию: `67108864` (64 МБ) +* Значение по умолчанию: `768` -См. также: +### instance.log.format {: #instance_log_format } +<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-logging-log-format --> -* [picodata run --memtx-memory](cli.md#run_memtx_memory) +Формат отладочного журнала. + +Возможные значениÑ: `plain`, `json` + +Данные: + +* Тип: *str* +* Значение по умолчанию: `plain` ### instance.memtx.checkpoint_count {: #instance_memtx_checkpoint_count } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-checkpoint-daemon-checkpoint-count --> @@ -197,61 +212,25 @@ instance: * Тип: *float* * Значение по умолчанию: `3600.0` (1 чаÑ) -### instance.vinyl.memory {: #instance_vinyl_memory } -<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-memory --> - -МакÑимальное количеÑтво оперативной памÑти *в байтах*, которое иÑпользует -движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ `vinyl`. - -Данные: - -* Тип: *int* -* Значение по умолчанию: `134217728` (128 МБ) +### instance.memtx.memory {: #instance_memtx_memory } +<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-memtx-memory --> -### instance.vinyl.cache {: #instance_vinyl_cache } -<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-cache --> +Объем памÑти *в байтах*, выделÑемый Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ ÐºÐ¾Ñ€Ñ‚ÐµÐ¶ÐµÐ¹. Когда +доÑтигаетÑÑ Ð»Ð¸Ð¼Ð¸Ñ‚ иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Ð¿Ð°Ð¼Ñти, запроÑÑ‹ команд [INSERT](./sql/insert.md) +и [UPDATE](./sql/update.md) начинают отклонÑÑ‚ÑŒÑÑ Ñ Ð¾ÑˆÐ¸Ð±ÐºÐ¾Ð¹ *ER_MEMORY_ISSUE*. +Сервер хранит в выделÑемом объеме памÑти только кортежи — Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð¸Ð½Ð´ÐµÐºÑов +и информации о ÑоединениÑÑ… иÑпользуетÑÑ Ð´Ð¾Ð¿Ð¾Ð»Ð½Ð¸Ñ‚ÐµÐ»ÑŒÐ½Ð°Ñ Ð¿Ð°Ð¼ÑÑ‚ÑŒ. -Размер кÑша *в байтах* Ð´Ð»Ñ Ð´Ð²Ð¸Ð¶ÐºÐ° Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ `vinyl`. +Минимальное значение — 33,554,432 байтов (32 МБ) Данные: * Тип: *int* -* Значение по умолчанию: `134217728` (128 МБ) - -### instance.iproto.max_concurrent_messages {: #instance_iproto_max_concurrent_messages } -<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-networking-net-msg-max --> - -МакÑимальное количеÑтво Ñообщений, которое Picodata обрабатывает параллельно. - -Ð”Ð»Ñ Ð¾Ð±Ñ€Ð°Ð±Ð¾Ñ‚ÐºÐ¸ Ñообщений Picodata иÑпользует файберы. Чтобы загруженноÑÑ‚ÑŒ -файберов не влиÑла на производительноÑÑ‚ÑŒ вÑей ÑиÑтемы, Picodata ограничивает -количеÑтво Ñообщений, обрабатываемых файберами, Ð±Ð»Ð¾ÐºÐ¸Ñ€ÑƒÑ Ð½ÐµÐºÐ¾Ñ‚Ð¾Ñ€Ñ‹Ðµ ожидающие -запроÑÑ‹. - -Ðа мощных ÑиÑтемах можно *увеличить* значение `max_concurrent_messages`, -тогда планировщик немедленно начнет обрабатывать ожидающие запроÑÑ‹. - -Ðа Ñлабых ÑиÑтемах можно *уменьшить* значение `max_concurrent_messages`, -тогда загруженноÑÑ‚ÑŒ файберов может ÑнизитьÑÑ, Ñ…Ð¾Ñ‚Ñ Ð¼Ð¾Ð¶ÐµÑ‚ потребоватьÑÑ -некоторое времÑ, пока планировщик дождетÑÑ Ð·Ð°Ð²ÐµÑ€ÑˆÐµÐ½Ð¸Ñ ÑƒÐ¶Ðµ обрабатываемых -запроÑов. - -Когда количеÑтво Ñообщений доÑтигает `max_concurrent_messages`, Picodata -приоÑтанавливает обработку входÑщих пакетов, пока не обработает предыдущие -ÑообщениÑ. Ðто не прÑмое ограничение количеÑтва файберов, обрабатывающих -Ñетевые ÑÐ¾Ð¾Ð±Ñ‰ÐµÐ½Ð¸Ñ â€” Ñкорее, Ñто общеÑиÑтемное ограничение пропуÑкной -ÑпоÑобноÑти канала. Ð’ Ñвою очередь, Ñто приводит к ограничению количеÑтва -входÑщих Ñетевых Ñообщений, которые обрабатывает поток процеÑÑора транзакций, -и, как ÑледÑтвие, коÑвенно влиÑет на файберы, обрабатывающие Ñетевые ÑообщениÑ. - -<!-- The number of fibers is smaller than the number of messages because messages -can be released as soon as they are delivered, while incoming requests might -not be processed until some time after delivery. --> +* Значение по умолчанию: `67108864` (64 МБ) -Данные: +См. также: -* Тип: *int* -* Значение по умолчанию: `768` +* [picodata run --memtx-memory](cli.md#run_memtx_memory) ### instance.pg.ssl {: #instance_pg_ssl } @@ -268,3 +247,24 @@ SSL-Ñертификаты: * Тип: *bool* * Значение по умолчанию: `false` + +### instance.vinyl.cache {: #instance_vinyl_cache } +<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-cache --> + +Размер кÑша *в байтах* Ð´Ð»Ñ Ð´Ð²Ð¸Ð¶ÐºÐ° Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ `vinyl`. + +Данные: + +* Тип: *int* +* Значение по умолчанию: `134217728` (128 МБ) + +### instance.vinyl.memory {: #instance_vinyl_memory } +<!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-memory --> + +МакÑимальное количеÑтво оперативной памÑти *в байтах*, которое иÑпользует +движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ `vinyl`. + +Данные: + +* Тип: *int* +* Значение по умолчанию: `134217728` (128 МБ) diff --git a/hooks/check_sorting.py b/hooks/check_sorting.py index e85fb12347e26efb59b45140e242343493d56707..906ea992ee44ba537a5023bf08d29f4b2ed9bcd7 100644 --- a/hooks/check_sorting.py +++ b/hooks/check_sorting.py @@ -9,12 +9,17 @@ from mkdocs.structure.pages import Page log = get_plugin_logger(os.path.basename(__file__)) +h3_pages = [ + "reference/audit_events.md", + "reference/config.md", +] + def on_page_markdown(markdown: str, page: Page, config: MkDocsConfig, files: Files): if page.file.src_uri == "reference/cli.md": return reference_cli(markdown, page) - elif page.file.src_uri == "reference/audit_events.md": - return reference_audit_events(markdown, page) + elif page.file.src_uri in h3_pages: + return check_h3_sorting(markdown, page) elif page.file.src_uri == "architecture/rpc_api.md": return architecture_rpc_api(markdown, page) @@ -42,7 +47,7 @@ def reference_cli(markdown: str, page: Page): log.info("\n" + "\n".join(diff)) -def reference_audit_events(markdown: str, page: Page): +def check_h3_sorting(markdown: str, page: Page): lines: list[str] = re.sub("<!--.*?-->", "", markdown, flags=re.DOTALL).split("\n") h3: list[str] = list(filter(lambda line: line.startswith("### "), lines))