Документация pgBadger 13.2 on PIG.CENTER

Загрузка и установка

Mon, 01 Jan 0001 00:00:00 +0000

Выбор канала распространения

Канал	Для чего использовать	Где находится
Официальный выпуск	Архивы исходного кода и примечания к выпуску	Выпуски GitHub
Пакет RPM	Дистрибутивы Linux на базе RPM	Репозиторий PostgreSQL Yum
Пакет Debian/Ubuntu	Дистрибутивы Linux на базе APT	Репозиторий PostgreSQL Apt
Разрабатываемый исходный код	Текущий код, ещё не вошедший в выпуск	darold/pgbadger

Снимок документации на этом сайте основан на дереве исходного кода версии 13.2. Перед загрузкой всегда проверяйте страницу выпусков: локальный снимок намеренно зафиксирован, тогда как исходный проект продолжает выпускать новые версии.

Справочник командной строки

Mon, 01 Jan 0001 00:00:00 +0000

На этой странице сохранён справочник команд, сгенерированный из зафиксированной версии исходного кода. Имена параметров и текст справки приведены дословно, чтобы их можно было непосредственно сопоставить с выводом pgbadger --help.

Использование и параметры

Использование: pgbadger [options] logfile […]

PostgreSQL log analyzer with fully detailed reports and graphs.

Аргументы:

logfile can be a single log file, a list of files, or a shell command
returning a list of files. If you want to pass log content from stdin
use - as filename. Note that input from stdin will not work with csvlog.

Параметры:

Настройка журналирования PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

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

Минимальное журналирование запросов

Чтобы включить текст и длительность запросов, включите журналирование операторов по длительности:

log_min_duration_statement = 0

Значение 0 записывает каждый завершённый оператор. На загруженном сервере выберите более высокий порог в миллисекундах, чтобы контролировать объём журнала. Прежде чем включать низкий порог в производственной среде, измерьте накладные расходы и рост хранилища.

Параллельная обработка

Mon, 01 Jan 0001 00:00:00 +0000

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

Параметр	Единица параллельной обработки	Лучше всего подходит для	Основное ограничение
`-j N` / `--jobs N`	части одного файла журнала	один большой журнал с произвольным доступом	на границах частей небольшое число запросов может быть продублировано или пропущено
`-J N` / `--Jobs N`	целые файлы журналов	множество независимых журналов	полезно только при достаточном числе файлов для постоянной загрузки рабочих процессов

Разделение одного большого файла с `-j`

$ pgbadger -j 8 /var/log/postgresql/postgresql.log

Алгоритм исходного проекта делит каждый файл на N диапазонов байтов, создаёт по одному процессу синтаксического анализа на диапазон, записывает временную двоичную статистику, а затем объединяет её в итоговый отчёт.

Инкрементальные отчёты

Mon, 01 Jan 0001 00:00:00 +0000

Инкрементальный режим сохраняет разобранную статистику в двоичном виде, а затем строит по одному HTML-отчёту на день, накопительный отчёт на неделю и связывающий их календарный индекс. Он предназначен для регулярной обработки ротируемых журналов без повторного учёта одних и тех же записей.

Создание ежедневных и еженедельных отчётов

Запускайте pgBadger после ежедневной ротации журнала и укажите постоянный каталог вывода:

0 4 * * * /usr/bin/pgbadger -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/

Параметр -I включает инкрементальный режим, а -O выбирает каталог для двоичного состояния, календарного индекса и сгенерированных отчётов. pgBadger самостоятельно ведёт инкрементальное состояние в этом каталоге, поэтому --last-parsed не нужен, если только вы намеренно не хотите хранить файл состояния в другом месте.

Форматы вывода

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger выбирает формат вывода по расширению имени файла либо по параметру -x / --extension. Укажите -o / --outfile несколько раз, чтобы создать несколько форматов из одного результата разбора.

Формат	Обычное расширение	Оптимальное применение
HTML	`.html`	интерактивный, удобный для чтения отчёт с диаграммами
Текст	`.txt`	просмотр в терминале и простое архивирование
Двоичный	`.bin`	объединяемая промежуточная статистика и пересборка отчётов
JSON	`.json`	интеграция с другим ПО; требует `JSON::XS`
Необработанный CSV	выбранный файл вывода	построчное извлечение с `--dump-raw-csv`

HTML и текст

По умолчанию результат записывается в out.html:

Примеры отчётов

Mon, 01 Jan 0001 00:00:00 +0000

Примеры были созданы pgBadger 11.8 в мае 2022 года. Исходные примеры хранятся на этом сайте, поэтому навигация, диаграммы, стили и сценарии отчётов доступны без обращения к серверу исходного проекта.

Пример	Что он демонстрирует	Локальная копия
Полный отчёт	Активность PostgreSQL вместе со статистикой PgBouncer	Открыть полный отчёт
Инкрементальный отчёт	Календарный индекс, еженедельное агрегирование и ежедневные страницы	Открыть индекс инкрементальных отчётов
Ошибки и события	Отчёт, ограниченный ошибками и эксплуатационными событиями	Открыть отчёт об ошибках

Полный отчёт

Полный отчёт — автономный HTML-документ. С помощью верхней панели навигации можно изучить общую статистику, запросы, сеансы, соединения, временные файлы, контрольные точки, активность autovacuum, блокировки и диаграммы, относящиеся к PgBouncer.

Поддержка и участие в разработке

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger развивается как открытый проект. Сообщения об ошибках, предложения функций, исправления документации и патчи принимаются через репозиторий исходного проекта на GitHub.

Ошибки и запросы функций

Обновитесь до самой новой выпущенной версии и убедитесь, что проблема сохраняется.
Поищите готовый ответ среди открытых задач и закрытых задач .
Сведите проблему к минимальному безопасному фрагменту журнала и командной строке, на которых она всё ещё воспроизводится.
Удалите учётные данные, конфиденциальный SQL, значения параметров, имена узлов, адреса и деловые данные.
Создайте новую задачу , указав версию pgBadger, операционную систему, формат ввода, точные параметры, наблюдаемый и ожидаемый результаты.

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

Лицензия и благодарности

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger — свободное программное обеспечение с открытым исходным кодом, распространяемое по лицензии PostgreSQL. Его можно бесплатно использовать, копировать, изменять и распространять при условии сохранения уведомлений об авторских правах и лицензии.

Лицензия PostgreSQL

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

Документация pgBadger 13.2 on PIG.CENTER

Загрузка и установка

Выбор канала распространения

Справочник командной строки

Использование и параметры

Настройка журналирования PostgreSQL

Минимальное журналирование запросов

Параллельная обработка

Разделение одного большого файла с -j

Инкрементальные отчёты

Создание ежедневных и еженедельных отчётов

Форматы вывода

HTML и текст

Примеры отчётов

Полный отчёт

Поддержка и участие в разработке

Ошибки и запросы функций

Лицензия и благодарности

Лицензия PostgreSQL

Разделение одного большого файла с `-j`