Параметры инициализации

pgbench принимает следующие аргументы командной строки для инициализации:

Параметры тестирования производительности

pgbench принимает следующие аргументы командной строки для тестирования производительности:

Общие параметры

pgbench принимает следующие общие аргументы командной строки:

Каково содержание «транзакции», которую выполняет pgbench?

Программа pgbench выполняет тестовые скрипты, выбирая их случайным образом из заданного списка. Это могут быть как встроенные скрипты, задаваемые аргументами -b, так и пользовательские, задаваемые аргументами -f. Для каждого скрипта можно задать относительный вес после @, чтобы скорректировать вероятность его выбора. По умолчанию вес считается равным 1. Скрипты с весом 0 игнорируются.

Стандартный встроенный скрипт (также вызываемый с ключом -b tpcb-like) выдаёт семь команд в транзакции со случайно выбранными aid, tid, bid и delta. Его сценарий написан по мотивам теста производительности TPC-B, но это не собственно TPC-B, потому он называется так.

При выборе встроенного скрипта simple-update (или указании -N) шаги 4 и 5 исключаются из транзакции. Это позволяет избежать конкуренции при обращении к этим таблицам, но тест становится ещё менее похожим на TPC-B.

При выборе встроенного теста select-only (или указании -S) выполняется только SELECT.

Пользовательские скрипты

Программа pgbench поддерживает запуск пользовательских сценариев оценки производительности, позволяя заменять стандартный скрипт транзакции (описанный выше) скриптом, считываемым из файла (с параметром -f). В этом случае «транзакцией» считается одно выполнение данного скрипта.

Файл скрипта содержит одну или несколько команд SQL, разделённых точкой с запятой. Пустые строки и строки, начинающиеся с --, игнорируются. В файлах скриптов также могут содержаться «метакоманды», которые обрабатывает сама программа pgbench, как описано ниже.

Для файлов скриптов реализован простой механизм подстановки переменных. Имя переменных должно состоять из букв (буквы могут быть не латинскими), подчёркиваний и цифр (но цифра не может быть первым символом). Переменные можно задать в командной строке параметрами -D, описанными выше, или метакомандами, рассматриваемыми ниже. Помимо переменных, которые можно установить параметрами командной строки -D, есть несколько автоматически устанавливаемых переменных; они перечислены в Таблице 263. Если значение этих переменных задаётся в параметре -D, оно переопределяет автоматическое значение. Когда значение переменной определено, его можно вставить в команду SQL, написав :имя_переменной. Каждый клиентский сеанс, если их несколько, получает собственный набор переменных. В одном операторе pgbench поддерживает до 255 ссылок на переменные.

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

Встроенные операторы

Арифметические, битовые и логические операторы, а также операторы сравнения, перечисленные в Таблице 264, встроены в pgbench и могут применяться в выражениях в \set.

Встроенные функции

Функции, перечисленные в Таблице 265, встроены в pgbench и могут применяться в выражениях в метакоманде \set.

Функция random выдаёт значения с равномерным распределением, то есть вероятности получения всех чисел в интервале равны. Функции random_exponential, random_gaussian и random_zipfian требуют указания дополнительного параметра типа double, определяющего точную форму распределения.

Функции хеширования hash, hash_murmur2 и hash_fnv1a принимают на вход аргумент и необязательный параметр с затравкой. Если значение затравки не задаётся, используется значение переменной :default_seed, которая инициализируется случайным числом (если не задаётся явно ключом командной строки -D). Функции хеширования могут использоваться для разброса распределения случайных функций, таких как random_zipfian или random_exponential. Например, следующий скрипт pgbench эмулирует возможную реальную нагрузку, типичную для социальных медиа- и блог-платформ, где несколько пользователей генерируют львиную долю нагрузки:

\set r random_zipfian(0, 100000000, 1.07)
\set k abs(hash(:r)) % 1000000

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

\set k1 abs(hash(:r, :default_seed + 123)) % 1000000
\set k2 abs(hash(:r, :default_seed + 321)) % 1000000

В качестве примера взгляните на встроенное определение транзакции типа TPC-B:

\set aid random(1, 100000 * :scale)
\set bid random(1, 1 * :scale)
\set tid random(1, 10 * :scale)
\set delta random(-5000, 5000)
BEGIN;
UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
END;

С таким скриптом транзакция на каждой итерации будет обращаться к разным, случайно выбираемым строкам. (Этот пример показывает, почему важно, чтобы в каждом клиентском сеансе были собственные переменные — в противном случае они не будут независимо обращаться к разным строкам.)

Протоколирование транзакций

С параметром -l (но без --aggregate-interval), pgbench записывает информацию о каждой транзакции в протокол. Этот файл протокола будет называться префикс.nnn, где префикс по умолчанию — pgbench_log, а nnn — PID процесса pgbench. Префикс можно сменить, воспользовавшись ключом --log-prefix. Если параметр -j равен 2 или выше, будет создано несколько рабочих потоков, и каждый будет записывать отдельный протокол. Первый рабочий процесс будет использовать файл с тем же именем, что и в стандартном случае с одним потоком, а файлы остальных потоков будут называться префикс.nnn.mmm, где mmm — порядковый номер рабочего процесса, начиная с 1.

Протокол имеет следующий формат:

код_клиента число_транзакций длительность номер_скрипта время_эпохи время_мкс [ отставание_от_графика ] [ повторы_сериализации повторы_взаимоблокировки ]

Здесь код_клиента показывает, в каком клиентском сеансе выполнялась транзакция, число_транзакций отражает, сколько транзакций было выполнено в этом сеансе, длительность — общее время транзакций (в микросекундах), номер_скрипта показывает, какой файл скрипта использовался (это полезно при указании нескольких скриптов ключами -f и -b), время_эпохи/время_мкс — отметка времени Unix и смещение в микросекундах (из этих чисел можно получить время стандарта ISO 8601 с дробными секундами), показывающие, когда транзакция была завершена. Поле отставание_от_графика представляет разницу между запланированным временем запуска транзакции и фактическим временем запуска (в микросекундах). Оно выводится только когда применяется параметр --rate. Когда одновременно применяются параметры --rate и --latency-limit, в поле длительность для пропущенных транзакций будет выводиться skipped. Поля повторы_сериализации и повторы_взаимоблокировки отражают общее количество попыток выполнения транзакции после соответствующих ошибок при выполнении текущего скрипта. Они присутствуют, только если максимально возможное число попыток не равно 1 (--max-tries). Для транзакций, оказавшихся неуспешными из-за ошибок сериализации или взаимоблокировки, в столбце длительность будет выводиться failed (за дополнительными сведениями обратитесь к Подразделу «Повторы и отказы из-за ошибок сериализации/взаимоблокировки»).

Фрагмент протокола, полученного при выполнении с одним клиентом:

0 199 2241 0 1175850568 995598
0 200 2465 0 1175850568 998079
0 201 2513 0 1175850569 608
0 202 2038 0 1175850569 2663

Ещё один пример с --rate=100 и --latency-limit=5 (обратите внимание на дополнительный столбец отставание_от_графика):

0 81 4621 0 1412881037 912698 3005
0 82 6173 0 1412881037 914578 4304
0 83 skipped 0 1412881037 914578 5217
0 83 skipped 0 1412881037 914578 5099
0 83 4722 0 1412881037 916203 3108
0 84 4142 0 1412881037 918023 2333
0 85 2465 0 1412881037 919759 740

В этом примере транзакция 82 опоздала, так как её длительность (6.173 мс) превысила ограничение в 5 мс. Следующие две транзакции были пропущены, так как было слишком поздно их начинать.

Ниже показан фрагмент файла журнала с отказами и повторными попытками при максимальном числе попыток, равном 10:

3 0 47423 0 1499414498 34501 3 0
3 1 8333 0 1499414498 42848 0 0
3 2 8358 0 1499414498 51219 0 0
4 0 72345 0 1499414498 59433 6 0
1 3 41718 0 1499414498 67879 4 0
1 4 8416 0 1499414498 76311 0 0
3 3 33235 0 1499414498 84469 3 0
0 0 failed 0 1499414498 84905 9 0
2 0 failed 0 1499414498 86248 9 0
3 4 8307 0 1499414498 92788 0 0

Когда проводится длительное тестирование с большим количеством транзакций, файлы протоколов могут быть очень объёмными. Чтобы в них записывалась только случайная выборка транзакций, можно запустить команду с параметром --sampling-rate.

Протоколирование с агрегированием

С ключом --aggregate-interval файлы протоколов имеют другой формат:

начало_интервала число_транзакций сумма_длительности сумма_длительности_2 мин_длительность макс_длительность отказы [ сумма_задержки сумма_задержки_2 мин_задержка макс_задержка [ пропущено_транзакций ] ] [ повторенные_транзакции повторы_сериализации повторы_взаимоблокировки ]

Здесь начало_интервала — начальное время интервала (в виде времени эпохи Unix), число_транзакций — количество транзакций в данном интервале, сумма_длительности — суммарная длительность транзакций, сумма_длительности_2 — сумма квадратов длительностей транзакций, мин_длительность — минимальная длительность и макс_длительность — максимальная длительность в интервале, отказы — содержит число транзакций, оказавшихся неуспешными из-за ошибок сериализации/взаимоблокировки в данном интервале (за подробностями обратитесь к Подразделу «Повторы и отказы из-за ошибок сериализации/взаимоблокировки»). Следующие поля, сумма_задержки, сумма_задержки_2, мин_задержка и макс_задержка, присутствуют, только если применяется параметр --rate. Они дают статистику по времени, на которое задерживалась каждая транзакция, ожидая завершения предыдущей, то есть разницу между временем фактического запуска и запланированным временем. Следующее поле, пропущено_транзакций, тоже присутствует, только если применяется параметр --latency-limit. В нём отражается число транзакций, пропущенных из-за того, что было слишком поздно их начинать. Поля повторенные_транзакции, повторы_сериализации и повторы_взаимоблокировки присутствуют, только если максимальное число повторений транзакции не равно 1 (--max-tries). Они отражают количество повторно выполненных транзакций и общее число повторений после соответствующих ошибок в интервале. Каждая транзакция учитывается в том интервале, в котором она была зафиксирована.

Пример вывода:

1345828501 5601 1542744 483552416 61 2573 0
1345828503 7884 1979812 565806736 60 1479 0
1345828505 7208 1979422 567277552 59 1391 0
1345828507 7685 1980268 569784714 60 1398 0
1345828509 7073 1979779 573489941 236 1411 0

Заметьте, что простой протокол (без агрегирования) показывает, какой скрипт использовался для каждой транзакции, в отличие от протокола с агрегированием. Таким образом, если вам нужны подобные сведения, но в разрезе скриптов, вам придётся агрегировать данные самостоятельно.

Отчёт по операторам

С параметром -r программа pgbench собирает следующую статистику по каждому оператору:

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

Все эти значения вычисляются для каждого оператора, выполняемого каждым клиентом, и выдаются после завершения теста.

Со скриптом по умолчанию вывод будет примерно таким:

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
default transaction isolation level: read committed
transaction maximum tries number: 1
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
number of transactions per client: 1000
number of transactions actually processed: 10000/10000
latency average = 15.844 ms
latency stddev = 2.715 ms
tps = 618.764555 (including connections establishing)
tps = 622.977698 (excluding connections establishing)
statement latencies in milliseconds:
        0.002  \set aid random(1, 100000 * :scale)
        0.005  \set bid random(1, 1 * :scale)
        0.002  \set tid random(1, 10 * :scale)
        0.001  \set delta random(-5000, 5000)
        0.326  BEGIN;
        0.603  UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
        0.454  SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
        5.528  UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
        7.335  UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
        0.371  INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
        1.212  END;

Ещё один пример вывода для скрипта по умолчанию с выбором сериализуемого уровня изоляции (--default-isolation-level S):

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
default transaction isolation level: serializable
transaction maximum tries number: 100
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
number of transactions per client: 1000
number of transactions actually processed: 9676/10000
number of transactions failed: 324 (3.240 %)
number of transactions retried: 5629 (56.290 %)
number of retries: 103299 (serialization: 103299, deadlocks: 0)
number of transactions above the 100.0 ms latency limit: 21/9676 (0.217 %)
latency average = 16.138 ms
latency stddev = 21.017 ms
tps = 413.650224 (including connections establishing)
tps = 413.686560 (excluding connections establishing)
statement latencies in milliseconds, serialization failures and retries,
deadlock failures and retries:
  0.002    0      0  0  0  \set aid random(1, 100000 * :scale)
  0.000    0      0  0  0  \set bid random(1, 1 * :scale)
  0.000    0      0  0  0  \set tid random(1, 10 * :scale)
  0.000    0      0  0  0  \set delta random(-5000, 5000)
  0.121    0      0  0  0  BEGIN;
  0.290    0      2  0  0  UPDATE pgbench_accounts
                           SET abalance = abalance + :delta WHERE aid = :aid;
  0.221    0      0  0  0  SELECT abalance FROM pgbench_accounts
                           WHERE aid = :aid;
  0.266  212  72127  0  0  UPDATE pgbench_tellers
                           SET tbalance = tbalance + :delta WHERE tid = :tid;
  0.222  112  31170  0  0  UPDATE pgbench_branches
                           SET bbalance = bbalance + :delta WHERE bid = :bid;
  0.178    0      0  0  0  INSERT INTO pgbench_history
                                  (tid, bid, aid, delta, mtime)
                           VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
  1.210    0      0  0  0  END;

Если задействуется несколько файлов скриптов, все статистические данные выводятся отдельно для каждого файла.

Учтите, что сбор дополнительных временных показателей влечёт некоторые издержки и приводит к снижению средней скорости и, как результат, падению TPS. На сколько именно снизится скорость, во многом зависит от платформы и оборудования. Хороший способ оценить, каковы эти издержки — сравнить средние значения TPS, получаемые с подсчётом времени операторов и без такого подсчёта.

Повторы и отказы из-за ошибок сериализации/взаимоблокировки

Транзакции с ошибками сериализации или взаимоблокировки откатываются и повторяются до успешного выполнения или до достижения максимального числа попыток, задаваемого параметром --max-tries. Вы также можете ограничить время попыток с помощью параметра --latency-limit и/или --time; в таком случае можно разрешить неограниченное число попыток в течение заданного отрезка времени, установив значение 0 для параметра --max-tries. Если последняя попытка выполнить транзакцию не удаётся, транзакция считается неуспешной. (Предполагается, что один скрипт содержит только одну транзакцию; за дополнительными сведениями обратитесь к Подразделу «Каково содержание «транзакции», которую выполняет pgbench?».)

Длительность успешной транзакции включает общее время выполнения транзакции с учётом откатов и повторных попыток выполнения. Длительность неуспешных транзакций и команд отдельно не подсчитывается.

Основной отчёт содержит количество неуспешных транзакций, если оно ненулевое. Если общее число повторно выполненных транзакций больше нуля, основной отчёт содержит также это число, общее число повторений и число попыток по каждому типу ошибок. Отчёт по операторам наследует набор столбцов от основного отчёта.

Полезные советы

Используя pgbench, можно без особого труда получить абсолютно бессмысленные числа. Последуйте приведённым советам, чтобы получить полезные результаты.

Во-первых, никогда не доверяйте тестам, которые выполняются всего несколько секунд. Воспользуйтесь параметром -t и -T и установите время выполнения не меньше нескольких минут, чтобы избавиться от шума в средних значениях. В некоторых случаях для получения воспроизводимых результатов тестирование должно продолжаться несколько часов. Чтобы понять, были ли получены воспроизводимые значения, имеет смысл запустить тестирование несколько раз.

Для стандартного сценария по типу TPC-B начальный коэффициент масштаба (-s) должен быть не меньше числа клиентов, с каким вы намерены проводить тестирование (-c); в противном случае вы, по большому счёту, будете замерять время конкурентных изменений. Таблица pgbench_branches содержит всего -s строк, а каждая транзакция хочет изменить одну из них, так что если значение -c превышает -s, это несомненно приведёт к тому, что многие транзакции будут блокироваться другими.

Стандартный сценарий тестирования также довольно сильно зависит от того, сколько времени прошло с момента инициализации таблиц: накопление неактуальных строк и «мёртвого» пространства в таблицах влияет на результаты. Чтобы правильно оценить результаты, необходимо учитывать, сколько всего изменений было произведено и когда выполнялась очистка. Если же включена автоочистка, это может быть чревато непредсказуемыми изменениями оценок производительности.

Полезность результатов pgbench также может ограничиваться тем, что тестирование с большим числом клиентских сеансов само по себе нагружает систему. Этого можно избежать, запуская pgbench на другом компьютере, не на сервере баз данных, хотя при этом большое значение имеет скорость сети. Иногда, оценивая производительность одного сервера, полезно запускать даже несколько экземпляров pgbench параллельно, на отдельных клиентских компьютерах.

Безопасность

Если к базе данных, которая не приведена в соответствие шаблону безопасного использования схем, имеют доступ недоверенные пользователи, не запускайте pgbench в этой базе. Программа pgbench использует неполные имена и не настраивает для себя путь поиска.