Описание #

pgpro_tune — это утилита командной строки для автоматической настройки. Оптимальные значения различных параметров конфигурации Postgres Pro зависят от оборудования. Утилита pgpro_tune собирает информацию о системе и преобразует её в набор параметров, записываемых в файл конфигурации.

Использование #

Использование pgpro_tune включено в initdb по умолчанию. Утилита запускается автоматически во время инициализации нового кластера баз данных. Это гарантирует, что для кластера будут заданы базовые параметры, наиболее точно подходящие для оборудования. Это поведение контролируется двумя параметрами initdb:

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

pgpro_tune -P имя_пресета

Это полезно после обновления оборудования, например добавления оперативной памяти или ядер процессора, или изменения характера нагрузки на СУБД. После ручного запуска утилиты примените обновлённые параметры конфигурации. В зависимости от того, какие параметры были изменены, вызовите функцию pg_reload_conf или перезапустите сервер.

По умолчанию pgpro_tune применяет пресет default.tune первым. Дополнительные пресеты можно задать с помощью параметра -P или --preset или указав имя пресета в качестве последнего аргумента командной строки. Можно использовать несколько пресетов одновременно. Они применяются последовательно в порядке, указанном в параметре -P или --preset. Пресет default.tune всегда применяется первым, кроме случаев, когда установлен параметр --no-default. Если один и тот же пресет указан несколько раз, он применяется повторно. Параметры конфигурации из пресетов изменяются инкрементально. В целях прозрачности промежуточные изменения записываются в файл конфигурации postgresql.conf.

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

В данный момент доступны следующие пресеты по умолчанию:

Дополнительные параметры можно указать с помощью -O или --options для любого пресета, но для пресета по умолчанию следует использовать --default-options.

Дополнительные переменные окружения для пресета можно установить в параметре --set. Эти значения будут одинаковыми как для пресета по умолчанию, так и для всех пользовательских.

По умолчанию пресеты размещаются в каталоге share, но можно указать их расположение вручную в параметре --preset-dir.

По умолчанию pgpro_tune работает с файлом конфигурации postgresql.conf, расположенным в каталоге данных. Каталог данных можно указать с помощью -D или --pgdata, либо задать с помощью переменной окружения PGDATA. При запуске pgpro_tune в initdb утилита будет использовать каталог данных initdb.

Файл конфигурации также можно указать с помощью --config-file.

Утилита pgpro_tune записывает свои изменения в отдельный блок в конце файла конфигурации с комментарием, что он был добавлен pgpro_tune. За подробностями обратитесь к примеру пресета.

Параметры #

Переменные окружения #

pgpro_tune устанавливает следующие переменные окружения перед запуском пресетов.

Создание пресетов #

Пресет — это исполняемый файл, обычно скрипт оболочки, который преобразует информацию, передаваемую через переменные окружения, в набор параметров конфигурации.

Ожидаемый вывод пресета — набор специально отформатированных строк. Первый непробельный символ — индикатор интерпретации содержимого строки для pgpro_tune. Индикатор должен быть одним из следующих символов:

work_mem = 4MB # Default value
shared_preload_libraries = 'plantuner'
search_path = '"$user",wrong_schema,public'

echo "# Adding new configuration parameters."
#Replace configuration parameter value by a new one
echo "work_mem = 8MB"
#Append to the start of existing value
echo "shared_preload_libraries += pg_stat_statements"
#Append to the end of existing value
echo "shared_preload_libraries =+ pg_prewarm"
#Withdraw from existing value
echo "search_path -= 'wrong_schema'"

pgpro_tune --config-file=/path/to/test.conf -P/path/to/test.tune --no-default

#------------------------------------------------------------------------------
# The following settings were added by pgpro_tune.
# pgpro_tune was run with the following options:
# --config-file=/path/to/test/conf -P/path/to/test/tune --no-default
# The following presets were used:
#	"/path/to/test/tune"
# At DD.MM.YYYY HH:MM:SS
#------------------------------------------------------------------------------
# Adding new configuration parameters.
work_mem = 8MB
shared_preload_libraries = 'pg_stat_statements, plantuner'
shared_preload_libraries = 'pg_stat_statements, plantuner, pg_prewarm'
search_path = '"$user", public'
#------------------------------------------------------------------------------
# End of settings added by pgpro_tune at DD.MM.YYYY HH:MM:SS
#------------------------------------------------------------------------------