Регистрация ошибок и протоколирование
Куда протоколировать
log_destination (string)
QHB поддерживает несколько методов протоколирования сообщений сервера, включая stderr, csvlog, jsonlog и syslog. Значение этого параметра указывается в виде списка желаемых расположений журнала, разделенных запятыми. По умолчанию сообщения сервера протоколируются только в stderr. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
Если в log_destination входит метод csvlog, то записи журнала выводятся в формате «значения, разделенные запятыми» (comma separated value, CSV), что удобно для загрузки журналов в программы. Подробную информацию см. в подразделе Использование вывода журнала в формате CSV. Для генерации вывода журнала в формате CSV должен быть включен logging_collector.
Если в log_destination входит метод jsonlog, то записи журнала выводятся в формате JSON, что удобно для загрузки журналов в программы. Подробную информацию см. в подразделе Использование вывода журнала в формате JSON. Для генерации вывода журнала в формате JSON должен быть включен logging_collector.
Если в список включены методы stderr, csvlog или jsonlog, то создается файл current_logfiles для записи местоположения файла (или файлов) журнала, который в данный момент используется сборщиком сообщений, и соответствующего места назначения. Это обеспечивает удобный способ поиска журналов, используемых в данный момент экземпляром сервера. Пример содержимого такого файла:
stderr log/qhb.log
csvlog log/qhb.csv
jsonlog log/qhb.json
current_logfiles воссоздается, когда при ротации создается новый файл журнала и когда повторно загружается log_destination. Он удаляется, когда в log_destination не входят ни stderr, ни csvlog и когда сборщик сообщений выключен.
Примечание
В большинстве систем Unix потребуется изменить конфигурацию демона syslog, чтобы использовать вариант syslog для log_destination. QHB может протоколировать с помощью syslog-программ с LOCAL0 по LOCAL7 (см. syslog_facility), но на большинстве платформ конфигурация syslog по умолчанию не учитывает сообщения такого типа. Чтобы это работало, понадобится добавить в конфигурацию демона syslog что-то вроде этого:local0.* /var/log/qhb
logging_collector (boolean)
Этот параметр включает сборщик сообщений, который является фоновым процессом, собирающим сообщения, отправленные в stderr, и перенаправляющим их в файлы журнала. Такой подход зачастую более полезен, чем запись в syslog, поскольку некоторые типы сообщений могут не отображаться в выводе syslog. (Один из типичных примеров — сообщения об ошибках динамического компоновщика; другой — сообщения об ошибках в скриптах типа archive_command). Этот параметр можно задать только при запуске сервера.
Примечание
Можно обойтись без сборщика сообщений и просто протоколировать в stderr; сообщения журнала будут отправляться туда, куда направлен поток серверного stderr. Однако этот метод подходит только для небольших объемов протоколирования, поскольку не предоставляет удобного способа ротации файлов журналов. Кроме того, на некоторых платформах выключение сборщика сообщений может привести к потере или искажению выходных данных журнала, так как несколько процессов, одновременно пишущих в один файл журнала, могут перезаписывать сообщения друг друга.
Примечание
Сборщик сообщений спроектирован так, чтобы никогда не терять сообщения. Это означает, что при крайне высокой нагрузке серверные процессы могут быть заблокированы при попытке отправить дополнительные сообщения, если сборщик отстал. С другой стороны, syslog предпочитает удалять сообщения, если не может их записать, то есть в таких случаях часть сообщений может потеряться, но остальная часть системы не будет блокироваться.
log_directory (string)
При включенном logging_collector этот параметр определяет каталог, в котором будут создаваться файлы журнала. Его можно задавать как абсолютный путь или относительный от каталога данных кластера. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера. Значение по умолчанию — log.
log_filename (string)
При включенном logging_collector этот параметр задает имена создаваемых файлов журнала. Значение рассматривается как шаблон функции strftime, поэтому в нем можно использовать спецификаторы % для включения в имена файлов даты и времени. (Обратите внимание, что при наличии зависящих от часового пояса спецификаторов % вычисления будут выполняться в поясе, заданном в параметре log_timezone). Поддерживаемые спецификаторы % аналогичны тем, что перечислены в описании strftime спецификации Open Group. Обратите внимание, что системная функция strftime напрямую не используется, поэтому нестандартные, специфичные для платформы расширения не работают. Значение по умолчанию — qhb-%Y-%m-%d_%H%M%S.log.
Если вы указываете имя файла без спецификаторов, то во избежание заполнения всего диска следует запланировать использование утилиты ротации файлов журналов.
Если в log_destination включен вывод в формате CSV, то к имени файла журнала с меткой времени будет добавлено расширение .csv. (Если log_filename оканчивается на .log, то это расширение заменяется на .csv.)
Если в log_destination включен вывод в формате JSON, то к имени файла журнала с меткой времени будет добавлено расширение .json. (Если log_filename оканчивается на .log, то это расширение заменяется на .json.)
Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
log_file_mode (integer)
В системах Unix при включенном logging_collector этот параметр задает
права доступа к файлам журнала. Значение параметра должно быть числовым,
введенным в формате, принимаемом системными командами chmod и umask. (Для
обычного восьмеричного формата число должно начинаться с 0 (нуля).)
Право доступа по умолчанию — 0600, т. е. читать или писать в файлы журнала может только владелец сервера. Другое часто используемое полезное значение — 0640, позволяющее читать файлы членам группы владельца. Однако обратите внимание, что для установки такого значения нужно перенести каталог для хранения файлов журнала (log_directory) за пределы каталога данных кластера. В любом случае неразумно открывать для всех доступ на чтение файлов журналов, поскольку они могут содержать конфиденциальные данные.
Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
log_rotation_age (integer)
При включенном logging_collector этот параметр определяет максимальное время использования отдельного файла журнала, после которого будет создан новый файл. Если это значение указано без единиц измерения, оно считается заданным в минутах. Значение по умолчанию — 24 часа. При нулевом значении повременное создание новых файлов журнала выключается. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
log_rotation_size (integer)
При включенном logging_collector этот параметр определяет максимальный размер отдельного файла журнала. По достижении этого размера будет создан новый файл. Если это значение указано без единиц измерения, оно считается заданным в килобайтах. Значение по умолчанию — 10 мегабайт. При нулевом значении поразмерное создание новых файлов журнала выключается. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
log_truncate_on_rotation (boolean)
При включенном logging_collector этот параметр заставит QHB опустошать (перезаписывать) существующие файлы журнала с одинаковым именем, а не дописывать в них. Однако опустошение будет происходить только при открытии нового файла вследствие ротации по времени, а не при запуске сервера или ротации по размеру. При выключенном параметре в любом случае будет происходить добавление записей в уже существующий файл. Например, использование этого параметра в сочетании с log_filename равным qhb-%H.log приведет к генерации 24-часовых файлов журнала, которые будут циклически перезаписываться. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
Пример: для хранения файлов журнала в течение 7 дней, по одному файлу на каждый день с именами вида server_log.Mon, server_log.Tue и т. д., и автоматической перезаписью файлов журнала прошлой недели на эту неделю, нужно установить в log_filename значение server_log.%a, в log_truncate_on_rotation — on и в log_rotation_age — 1440.
Пример: для хранения файлов журнала в течение 24 часов, по одному файлу на каждый час, но также с возможностью переключения файла раньше этого срока при превышении размера 1 ГБ, нужно установить в log_filename значение server_log.%H%M, в log_truncate_on_rotation — on, в log_rotation_age — 60 и в log_rotation_size — 1000000. Добавление %M в log_filename позволит при ротации по размеру указать имя файла, отличное от исходного имени файла данного часа.
syslog_facility (enum)
При включенном протоколировании в syslog этот параметр определяет значение «facility» (syslog-программы), которая будет использоваться. Допустимые значения: LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7; значение по умолчанию — LOCAL0. Подробную информацию см. в документации на системный демон syslog. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
syslog_ident (string)
При включенном протоколировании в syslog этот параметр определяет имя программы, которое будет использоваться в журналах syslog для идентификации сообщений QHB. Имя по умолчанию — qhb. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
syslog_sequence_numbers (boolean)
При включенном протоколировании в syslog и включении этого параметра (по умолчанию), все сообщения будут предваряться последовательно возрастающими номерами (например, [2]). Это позволяет обойти подавление повторов «--- last message repeated N times ---» (последнее сообщение повторилось N раз), которое по умолчанию осуществляется во многих реализациях syslog. В более современных реализациях syslog подавление повторных сообщений можно настроить (например, в rsyslog есть директива $RepeatedMsgReduction), так что это может оказаться необязательно. Кроме того, если вам действительно нужно, чтобы повторы подавлялись, этот параметр можно выключить.
Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
syslog_split_messages (boolean)
При включенном протоколировании в syslog этот параметр определяет способ передачи сообщений. Если этот параметр включен (по умолчанию), сообщения разделяются на строки, а длинные строки разбиваются так, чтобы уложиться в 1024 байта, что является типичным ограничением размера для традиционных реализаций syslog. Когда он выключен, сообщения сервера QHB передаются в службу syslog как есть, и она должна сама корректно справляться с потенциально громоздкими сообщениями.
Если в итоге syslog протоколирует в текстовый файл, результат в любом случае будет одинаковым, и лучше оставить этот параметр включенным, поскольку большинство реализаций syslog либо не могут обрабатывать большие сообщения, либо требуют для этого специальной настройки. Но если в итоге syslog записывает данные в какую-то другую среду, возможно, будет необходимо или более полезно сохранять логическую целостность сообщений.
Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
event_source (string)
При включенном протоколировании в журнал событий этот параметр определяет имя программы, которое будет использоваться в нем для идентификации сообщений QHB. Имя по умолчанию — QHB. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
Когда протоколировать
log_min_messages (enum)
Определяет уровень важности сообщений, записываемых в журнал сервера. Допустимые значения: DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, INFO, NOTICE, WARNING, ERROR, LOG, FATAL и PANIC. Каждый из перечисленных уровней включает в себя все уровни, идущие после него. Чем дальше в этом списке уровень сообщения, тем меньше сообщений отправляется в журнал. Значение по умолчанию — WARNING. Обратите внимание, что здесь у LOG другая позиция, нежели в параметре client_min_messages. Только суперпользователи Enables updating of the process title every time a new SQL command is received by the server. This setting defaults to on on most platforms, but it defaults to off on Windows due to that platform's larger overhead for updating the process title. Only superusers and users with the appropriate SET privilege can change this setting. могут изменять этот параметр.
log_min_error_statement (enum)
Определяет, какие команды SQL, вызвавшие ошибку, записываются в журнал сервера. Текущая команда SQL вносится в запись журнала, если сообщение имеет указанный уровень важности или выше. Допустимые значения: DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, INFO, NOTICE, WARNING, ERROR, LOG, FATAL и PANIC. По умолчанию установлено ERROR, то есть в журнал будут записываться команды, завершившиеся сообщением с уровнем важности ERROR, LOG, FATAL и PANIC. Чтобы действительно выключить запись команд с ошибками, установите для этого параметра значение PANIC. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_min_duration_statement (integer)
Инициирует запись в журнал продолжительности выполнения каждой завершенной команды, если та работала в течение указанного времени или дольше. Например, если установить значение 250ms, в журнал будут записаны все команды SQL, выполняющиеся 250 миллисекунд и дольше. С помощью этого параметра можно отслеживать неоптимизированные запросы в приложениях. Если это значение указано без единиц измерения, оно считается заданным в миллисекундах. При нулевом значении записывается продолжительность выполнения всех команд. Значение -1 (по умолчанию) выключает запись продолжительности выполнения команд. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
Этот параметр переопределяет log_min_duration_sample, то есть запросы с продолжительностью выше значения этого параметра не подвергаются выборке и всегда протоколируются.
Для клиентов, использующих расширенный протокол запросов, будет записываться продолжительность каждой фазы (разбор, связывание и выполнение).
Примечание
При использовании этого параметра совместно с log_statement текст команд, которые записываются вследствие использования log_statement, не будет дублироваться в сообщении о продолжительности выполнения. Если вы не пользуетесь syslog, рекомендуется включить в log_line_prefix идентификатор процесса или сеанса, чтобы с их помощью можно было связать текст команды с сообщением о продолжительности выполнения, которое появится позже.
log_min_duration_sample (integer)
Позволяет сделать выборку по продолжительности завершенных команд, выполнявшихся в течение как минимум указанного промежутка времени. При этом в журнал вносятся такие же записи, как и при включенном log_min_duration_statement, но только для подмножества выполнившихся команд, определенного параметром log_statement_sample_rate. Например, если задать значение 100ms, то для выборки будут отобраны все команды SQL, выполняющиеся 100 мс и дольше. Включение этого параметра может быть полезно, когда трафик слишком высок, чтобы протоколировать все запросы. Если это значение указано без единиц измерения, оно считается заданным в миллисекундах. При нулевом значении производится выборка команд с любой продолжительностью. Значение -1 (по умолчанию) выключает выборку по продолжительности. Только суперпользователи и пользователи с подходящим правом SET могут изменить этот параметр.
Приоритет этого параметра ниже, чем у log_min_duration_statement, то есть команды с продолжительностью выше значения log_min_duration_statement не подвергаются выборке и всегда протоколируются.
Другие примечания, касающиеся log_min_duration_statement, применимы и к этому параметру.
log_statement_sample_rate (floating point)
Определяет долю команд с продолжительностью, превысившей log_min_duration_sample, которая будет протоколироваться в журнал. Выборка носит стохастический характер, например, значение 0.5 означает, что статистически шанс попадания любой отдельно взятой команды в журнал равен один к двум. Значение по умолчанию — 1.0, то есть протоколируются все выбранные команды. При нулевом значении выключается протоколирование команд из выборки по длительности, так же как при установке в log_min_duration_sample значения -1. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_transaction_sample_rate (real)
Задает долю транзакций, команды из которых будут записываться в журнал помимо команд, записываемых по другим причинам. Этот параметр действует на все новые транзакции, независимо от продолжительности выполнения их команд. Выборка носит стохастический характер, например, значение 0.1 означает, что статистически шанс попадания любой отдельно взятой транзакции в журнал равен один к десяти. Этот параметр полезен для создания выборки транзакций. Значение по умолчанию — 0, то есть команды из транзакций дополнительно не записываются. При значении 1 записываются все команды из всех транзакций. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
Примечание
Как и все параметры, управляющие протоколированием команд, этот параметр может значительно увеличить издержки.
log_startup_progress_interval (integer)
Задает интервал времени, по истечении которого процесс запуска будет протоколировать сообщение о все еще выполняющейся длительной операции, а также интервал между последующими сообщениями о ходе выполнения этой операции. Значение по умолчанию — 10 секунд. Значение 0 отключает эту функциональность. Если это значение указано без единиц измерения, оно считается заданным в миллисекундах. Заданный интервал применяется к каждой операции в отдельности. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
Например, если синхронизация каталога данных занимает 25 секунд, а последующий сброс нежурналируемых отношений — 8 секунд, и если для этого параметра установлено значение по умолчанию в 10 секунд, то будут протоколироваться сообщения о синхронизации каталога данных сначала через 10, а потом через 20 секунд после ее начала, но о сбросе нежурналируемых отношений никакие сообщения протоколироваться не будут.
В Таблице 2 расшифровываются уровни важности сообщений, используемые в QHB. Также здесь показано, как эти уровни переводятся в системные при отправке выходных данных журнала в syslog.
Таблица 2. Уровни важности сообщений
| Важность | Использование | syslog |
|---|---|---|
| DEBUG1..DEBUG5 | Предоставляет более подробную информацию для разработчиков. Чем больше номер, тем подробнее. | DEBUG |
| INFO | Предоставляет неявно запрошенную пользователем информацию, например вывод команды VACUUM VERBOSE. | INFO |
| NOTICE | Предоставляет информацию, которая может быть полезна пользователям, например замечание об усечении длинных идентификаторов. | NOTICE |
| WARNING | Предоставляет предупреждения о возможных проблемах, например COMMIT вне блока транзакции. | NOTICE |
| ERROR | Сообщает об ошибке, из-за которой прервана текущая команда. | WARNING |
| LOG | Сообщает информацию, интересующую администраторов, например выполнение контрольных точек. | INFO |
| FATAL | Сообщает об ошибке, из-за которой прерван текущий сеанс. | ERR |
| PANIC | Сообщает об ошибке, из-за которой прерваны все сеансы базы данных. | CRIT |
Что протоколировать
Примечание
Данные, которые вы выбираете для протоколирования, могут привести к нарушениям безопасности; см. раздел Обслуживание файлов журнала.
application_name (string)
Параметр application_name может быть любой строкой длиной не более NAMEDATALEN символов (64 символа при стандартной сборке). Обычно устанавливается приложением при подключении к серверу. Значение (имя) будет отображено в представлении pg_stat_activity и включено в записи журнала при использовании формата CSV. Также его можно добавить в записи журнала в обычных форматах с помощью параметра log_line_prefix. Значение application_name может содержать только печатные символы ASCII. Прочие символы будут заменены на вопросительные знаки (?).
debug_print_parse (boolean)
debug_print_rewritten (boolean)
debug_print_plan (boolean)
Эти параметры включают вывод различных данных по отладке. При этом выводится результирующее дерево разбора, данные механизма переписывания запросов или план выполнения для каждого выполненного запроса соответственно. Эти сообщения имеют уровень LOG, поэтому по умолчанию они появляются в журнале сервера, но не отправляются клиенту. Это можно изменить, настроив client_min_messages и/или log_min_messages. По умолчанию эти параметры выключены.
debug_pretty_print (boolean)
Этот параметр включает выравнивание сообщений, созданных debug_print_parse, debug_print_rewritten или debug_print_plan. В результате сообщения становятся более удобочитаемыми, но гораздо более длинными, чем при формате «compact», используемом, когда debug_pretty_print выключен. По умолчанию этот параметр включен.
log_autovacuum_min_duration (integer)
Включает протоколирование в журнал каждого действия, выполняемого автоочисткой, если оно продолжается не менее указанного в параметре времени. При нулевом значении протоколируются все действия автоочистки. Значение -1 (по умолчанию) выключает протоколирование действий автоочистки. Если это значение указано без единиц измерения, оно считается заданным в миллисекундах. Например, если задать значение 250ms, то в журнал будут протоколироваться все операции автоматической очистки и анализа, выполняемые 250 мс и дольше. Кроме того, когда в этом параметре установлено любое значение, отличное от -1, будет протоколироваться сообщение в случае пропуска действия автоочистки вследствие конфликтующей блокировки или параллельного удаления отношения. Значение по умолчанию — 10min (10 минут). Включение этого параметра может быть полезно для отслеживания активности автоочистки. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера; при этом его можно переопределить для отдельных таблиц, изменив их параметры хранения.
log_checkpoints (boolean)
Включает протоколирование выполнения контрольных точек и точек перезапуска сервера. Помимо этого в сообщения включается некоторая статистическая информация, в том числе количество записанных буферов и время, потраченное на их запись. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера. По умолчанию этот параметр включен.
log_connections (boolean)
Включает протоколирование всех попыток подключения к серверу, а также успешного завершения аутентификации (при необходимости) и авторизации клиента. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр, причем только в начале сеанса. Значение по умолчанию — off (выключен).
Примечание
Некоторые программы-клиенты, например psql, осуществляют две попытки подключения, при первой попытке определяя, требуется ли пароль, поэтому дублирование сообщения «connection received» не обязательно указывает на наличие проблемы.
log_disconnections (boolean)
Включает протоколирование всех завершений сеанса. В журнал выводится примерно та же информация, что и с log_connections, плюс продолжительность сеанса. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр, причем только в начале сеанса. Значение по умолчанию — off (выключен).
log_duration (boolean)
Включает протоколирование продолжительности всех выполненных команд. Значение по умолчанию — off (выключен). Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
Для клиентов, использующих расширенный протокол запросов, будет записываться продолжительность каждой фазы (разбор, связывание и выполнение).
Примечание
Разница между включением log_duration и установкой нулевого значения для log_min_duration_statement заключается в том, что при превышении значения log_min_duration_statement протоколируется текст запроса, а при включении этого параметра — нет. Таким образом, если log_duration равен on (включен) и у log_min_duration_statement положительное значение, продолжительность протоколируется для всех команд, но текст запроса добавляется только для команд с продолжительностью, превышающей пороговое значение. Такое поведение может быть полезным при сборе статистики в инсталляциях с высокой нагрузкой.
log_error_verbosity (enum)
Управляет объемом подробной информации, записываемой в журнал сервера для каждого протоколируемого сообщения. Допустимые значения: TERSE, DEFAULT и VERBOSE, каждое из которых добавляет дополнительные поля к отображаемым сообщениям. С уровнем TERSE из сообщений об ошибке исключаются поля DETAIL, HINT, QUERY и CONTEXT. С VERBOSE в сообщение включается код ошибки SQLSTATE (см. раздел Коды ошибок QHB), а также имя файла с исходным кодом, имя функции и номер строки, которая вызвала ошибку. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_hostname (boolean)
По умолчанию в сообщениях журнала подключений отображается только IP-адрес подключившегося хоста. При включении этого параметра дополнительно будет протоколироваться и имя хоста. Обратите внимание, что, в зависимости от настройки разрешения имен вашего хоста, это может привести к значительному снижению производительности. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
log_line_prefix (string)
Это строка в стиле функции printf, которая выводится в начале каждой строки журнала. С символов % начинаются «управляющие последовательности», которые заменяются информацией о состоянии, как описано ниже. Нераспознанные последовательности игнорируются. Остальные символы напрямую копируются в строку журнала. Некоторые управляющие последовательности распознаются только сеансовыми процессами и будут игнорироваться фоновыми процессами, например основным процессом сервера. Информацию о состоянии можно выровнять влево или вправо, указав число после % и перед этой строкой. При отрицательном значении информация о состоянии будет дополнена до минимально допустимой ширины пробелами справа, а при положительном — слева. Заполнение может быть полезно для облегчения восприятия человеком файлов журнала.
Этот параметр можно установить только в файле qhb.conf или в командной строке сервера. По умолчанию установлено значение '%m [%p] ', при котором протоколируется метка времени и идентификатор процесса.
| Последовательность | Действие | Только для сеанса |
|---|---|---|
| %a | Имя приложения | да |
| %u | Имя пользователя | да |
| %d | Имя базы данных | да |
| %r | Имя удаленного хоста или IP-адрес, а также номер удаленного порта | да |
| %h | Имя удаленного хоста или IP-адрес | да |
| %b | Тип обслуживающего процесса | нет |
| %p | Идентификатор процесса | нет |
| %P | Идентификатор ведущего процесса параллельной группы, если этот процесс является рабочим процессом параллельного запроса | нет |
| %t | Метка времени без миллисекунд | нет |
| %m | Метка времени с миллисекундами | нет |
| %n | Метка времени с миллисекундами (в виде времени Unix) | нет |
| %i | Тег команды: тип текущей команды сеанса | да |
| %e | Код ошибки SQLSTATE | нет |
| %c | Идентификатор сеанса: см. ниже | нет |
| %l | Номер строки журнала для каждого сеанса или процесса, начиная с 1 | нет |
| %s | Метка времени начала процесса | нет |
| %v | Виртуальный идентификатор транзакции (backendID/localXID) | нет |
| %x | Идентификатор транзакции (0, если не присвоен) | нет |
| %q | Не выводит никаких данных, но указывает несеансовым процессам остановиться в этой точке строки; игнорируется сеансовыми процессами | нет |
| %Q | Идентификатор текущего запроса. Идентификаторы запросов не вычисляются по умолчанию, поэтому в данном поле будет выводиться ноль, если не включен параметр compute_query_id или не настроен сторонний модуль, вычисляющий идентификаторы запросов. | да |
| %% | Выводит символ % | нет |
Тип обслуживающего процесса соответствует столбцу backend_type в представлении pg_stat_activity, но в журнале могут присутствовать и другие типы, которые не показываются в этом представлении.
Последовательность %c выводит квазиуникальный идентификатор сеанса, состоящий из двух 4-байтных шестнадцатеричных чисел (без начальных нулей), разделенных точкой. Числа — это время начала процесса и его идентификатор, поэтому %c также можно использовать как способ экономить место при выводе этих значений. Например, чтобы сгенерировать идентификатор сеанса из pg_stat_activity, используйте этот запрос:
SELECT to_hex(trunc(EXTRACT(EPOCH FROM backend_start))::integer) || '.' ||
to_hex(pid)
FROM pg_stat_activity;
Совет
При установке непустого значение для log_line_prefix лучше сделать его последним символом пробел, чтобы визуально отделить от остальной части строки журнала. Также можно использовать знаки пунктуации.
Совет
Syslog создает собственную метку времени и информацию об идентификаторе процесса, так что, вероятно, при протоколировании в syslog нет смысла использовать эти управляющие последовательности.
Совет
Последовательность %q полезна при включении информации, доступной только в контексте сеанса (обслуживающего процесса), например имени пользователя или базы данных. Например:`log_line_prefix = '%m [%p] %q%u@%d/%a '`
Примечание
Последовательность %Q всегда выдает нулевой идентификатор для строк, выводимых посредством log_statement, поскольку этот параметр генерирует вывод до вычисления этого идентификатора, в том числе и для недопустимых операторов, для которых идентификатор вычислить нельзя.
log_lock_waits (boolean)
Определяет, должно ли создаваться сообщение журнала, когда сеанс ожидает получения блокировки дольше, чем задано в deadlock_timeout. Это помогает определить, не является ли ожидание блокировок причиной низкой производительности. Значение по умолчанию — off (выключен). Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_recovery_conflict_waits (boolean)
Определяет, должно ли создаваться сообщение журнала, когда процесс запуска ожидает дольше, чем задано в deadlock_timeout для конфликтов восстановления. Это полезно при выяснении, препятствуют ли конфликты восстановления применению WAL.
Значение по умолчанию — off (выключен). Этот параметр можно установить только в файле qhb.conf или в командной строке сервера.
log_parameter_max_length (integer)
При положительном значении значения всех привязанных параметров, выводимые в сообщениях об операторах (кроме регистрации ошибок), усекаются на заданное количество байтов. Ноль выключает протоколирование привязанных параметров в таких сообщениях. Значение -1 (по умолчанию) позволяет выводить привязанные параметры в полном объеме. Если это значение указано без единиц измерения, оно считается заданным в байтах. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
Этот параметр влияет только на сообщения, выводимые в журнал по результатам установки log_statement, log_duration и других связанных с ними параметров. При ненулевых значениях этого параметра возникают некоторые дополнительные издержки, особенно если параметры передаются в двоичной форме, поскольку их нужно преобразовать в текст.
log_parameter_max_length_on_error (integer)
При положительном значении значения всех привязанных параметров, выводимые в сообщениях об ошибках, усекаются на заданное количество байтов. Ноль (по умолчанию) выключает протоколирование привязанных параметров в таких сообщениях. Значение -1 позволяет выводить привязанные параметры в полном объеме. Если это значение указано без единиц измерения, оно считается заданным в байтах.
При ненулевых значениях этого параметра возникают некоторые дополнительные издержки, поскольку QHB придется сохранять в памяти текстовые представления значений параметров при запуске всех операторов, независимо от того, произойдет ли в итоге ошибка. Издержки возрастают, когда привязанные параметры передаются не в текстовой, а в двоичной форме, поскольку в последнем случае требуется преобразование данных, тогда как в первом достаточно только скопировать строку.
log_statement (enum)
Управляет тем, какие операторы SQL протоколируются в журнал. Допустимые значения:
none (выключен), ddl, mod и all (все операторы). В режиме ddl
протоколируются все операторы определения данных, такие как CREATE, ALTER и
DROP. В режиме mod протоколируются все операторы ddl, а также операторы,
изменяющие данные, такие как INSERT, UPDATE, DELETE, TRUNCATE и
COPY FROM. Операторы PREPARE, EXECUTE и EXPLAIN ANALYZE тоже
протоколируются, если содержащие их команды имеют соответствующий тип. Для
клиентов, использующих расширенный протокол запросов, запись в журнал происходит
на фазе выполнения и содержит значения привязанных параметров (с дублированием
всех имеющихся апострофов).
Значение по умолчанию — none. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
Примечание
Операторы, содержащие простые синтаксические ошибки, не протоколируются даже при log_statement = all, поскольку сообщение журнала создается только после выполнения стандартного разбора для определения типа оператора. В случае расширенного протокола запросов этот параметр также не записывает операторы, завершившиеся ошибкой до фазы выполнения (т. е. во время разбора или планирования запроса). Для записи таких операторов установите параметр log_min_error_statement в значение ERROR (или ниже).Протоколируемые операторы могут раскрывать конфиденциальные данные и даже содержать пароли в незашифрованном виде.
log_replication_commands (boolean)
Включает протоколирование всех команд репликации в журнал сервера. Дополнительную информацию о командах репликации см. в разделе Протокол потоковой репликации. Значение по умолчанию — off (выключен). Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_temp_files (integer)
Управляет протоколированием имен и размеров временных файлов. Временные файлы могут создаваться для сортировки, хеширования и временного хранения результатов запросов. Если этот параметр включен, запись журнала создается для каждого временного файла при его удалении. При нулевом значении записывается информация обо всех временных файлах, а при положительных — только о тех, размер которых не меньше заданной величины. Если это значение указано без единиц измерения, оно считается заданным в килобайтах. Значение по умолчанию — -1, то есть такое протоколирование выключено. Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.
log_timezone (string)
Задает часовой пояс, используемый для меток времени при записи в журнал сервера. В отличие от TimeZone, это значение одинаково для всех баз данных кластера, поэтому в сообщениях от всех сеансов метки времени будут согласованы. Встроенное значение по умолчанию — GMT, но обычно оно переопределяется в qhb.conf; qhb_bootstrap установит там значение, соответствующее системной среде. Дополнительную информацию см. в подразделе Часовые пояса. Этот параметр можно задать только в файле qhb.conf или в командной строке сервера.
Использование вывода журнала в формате CSV
Добавление csvlog в список log_destination обеспечивает удобный способ импорта файлов журнала в таблицу базы данных. Этот параметр генерирует строки журнала в формате значений, разделенных запятыми (comma-separated-value, CSV), со следующими столбцами: метка времени с миллисекундами; имя пользователя; имя базы данных; идентификатор процесса; хост клиента:номер порта; идентификатор сеанса; номер строки внутри сеанса; тег команды; время начала сеанса; виртуальный идентификатор транзакции; обычный идентификатор транзакции; уровень важности ошибки; код ошибки SQLSTATE; сообщение об ошибке; подробности к сообщению об ошибке; подсказка; внутренний запрос, который привел к ошибке (если есть); номер символа во внутреннем запросе, где произошла ошибка; контекст ошибки; пользовательский запрос, который привел к ошибке (если есть и включен log_min_error_statement); номер символа в пользовательском запросе, где произошла ошибка; расположение ошибки в исходном коде QHB (если в log_error_verbosity установлено verbose); имя приложения; тип обслуживающего процесса; идентификатор ведущего процесса параллельной группы и идентификатор запроса. Пример определения таблицы для хранения вывода журнала в формате CSV:
CREATE TABLE qhb_log
(
log_time timestamp(3) with time zone,
user_name text,
database_name text,
process_id integer,
connection_from text,
session_id text,
session_line_num bigint,
command_tag text,
session_start_time timestamp with time zone,
virtual_transaction_id text,
transaction_id bigint,
error_severity text,
sql_state_code text,
message text,
detail text,
hint text,
internal_query text,
internal_query_pos integer,
context text,
query text,
query_pos integer,
location text,
application_name text,
backend_type text,
leader_pid integer,
query_id bigint,
PRIMARY KEY (session_id, session_line_num)
);
Для импорта файл журнала в такую таблицу используйте команду COPY FROM:
COPY qhb_log FROM '/full/path/to/logfile.csv' WITH csv;
Кроме того, к этому файлу можно обратиться как к сторонней таблице, воспользовавшись поставляемым модулем file_fdw.
Для упрощения импорта файлов журналов в формате CSV необходимо сделать следующее:
-
Установите для log_filename и log_rotation_age значения, обеспечивающие согласованную и предсказуемую схему именования файлов журнала. Это позволит вам предугадать, каким будет имя файла, и узнать, когда конкретный файл журнала будет завершен и, следовательно, готов к импорту.
-
Установите для log_rotation_size значение 0, чтобы выключить поразмерную ротацию файлов, поскольку это затрудняет прогнозирование имени файла журнала.
-
Установите для log_truncate_on_rotation значение on, чтобы старые данные журнала не смешивались с новыми в одном файле.
-
Приведенное выше определение таблицы содержит спецификацию первичного ключа. Это способствует предотвращению случайного повторного импорта информации. Команда
COPYфиксирует все импортируемые данные за один раз, поэтому любая ошибка приведет к сбою всего импорта. Если сначала импортировать неполный файл журнала, а затем снова импортировать его после заполнения, нарушение первичного ключа приведет к сбою импорта. Поэтому, прежде чем импортировать, дождитесь завершения записи и закрытия журнала. Эта процедура также защитит от случайного импорта неполной (частично написанной) строки, что тоже приведет к сбою командыCOPY.
Использование вывода журнала в формате JSON
Добавление jsonlog в список log_destination обеспечивает удобный способ импорта файлов журнала во множество различных программ. Этот параметр генерирует строки журнала в формате JSON.
Строковые поля со значениями NULL из вывода исключаются. В будущем могут быть добавлены новые поля. Пользовательские приложения, обрабатывающие вывод jsonlog, должны игнорировать неизвестные для них поля.
Каждая строка журнала сериализуется в виде объекта JSON с набором ключей и связанных с ними значений, перечисленных в Таблице 3.
Таблица 3. Ключи и значения записей журнала JSON
| Имя ключа | Тип | Описание |
|---|---|---|
| timestamp | строка | Метка времени с миллисекундами |
| user | строка | Имя пользователя |
| dbname | строка | Имя базы данных |
| pid | число | Идентификатор процесса |
| remote_host | строка | Хост клиента |
| remote_port | число | Порт клиента |
| session_id | строка | Идентификатор сеанса |
| line_num | число | Номер строки внутри сеанса |
| ps | строка | Текущая строка в ps |
| session_start | строка | Время начала сеанса |
| vxid | строка | Виртуальный идентификатор транзакции |
| txid | строка | Обычный идентификатор транзакции |
| error_severity | строка | Важность ошибки |
| state_code | строка | Код SQLSTATE |
| message | строка | Сообщение об ошибке |
| detail | строка | Подробности к сообщению об ошибке |
| hint | строка | Подсказка к сообщению об ошибке |
| internal_query | строка | Внутренний запрос, который привел к ошибке |
| internal_position | число | Позиция курсора во внутреннем запросе |
| context | строка | Контекст ошибки |
| statement | строка | Строка запроса, предоставленная клиентом |
| cursor_position | число | Позиция курсора в строке запроса |
| func_name | строка | Имя функции, в которой произошла ошибка |
| file_name | строка | Имя файла, в котором произошла ошибка |
| file_line_num | число | Номер строки в файле, в которой произошла ошибка |
| application_name | строка | Имя клиентского приложения |
| backend_type | строка | Тип обслуживающего процесса |
| leader_pid | число | Идентификатор ведущего процесса параллельных активных рабочих процессов |
| query_id | число | Идентификатор запроса |
Заголовок процесса
Эти параметры определяют, как изменяются заголовки процессов сервера. Заголовки процессов обычно просматриваются с помощью таких программ, как ps. Дополнительную информацию см. в разделе Стандартные инструменты Unix.
cluster_name (string)
Задает имя, которое идентифицирует этот кластер баз данных (экземпляр сервера) для различных целей. Имя кластера появляется в заголовке у всех серверных процессов в этом кластере. Более того, это имя является именем приложения по умолчанию при подключении резервного сервера (см. synchronous_standby_names).
Это имя может быть любой строкой длиной не более NAMEDATALEN символов (64 символа в стандартной сборке). В значении cluster_name можно использовать только печатные символы ASCII. Все остальные символы будут заменены на вопросительные знаки (?). Если для этого параметра задана пустая строка '' (по умолчанию), то никакое имя не отображается. Этот параметр можно задать только при запуске сервера.
update_process_title (boolean)
Позволяет изменять заголовок процесса каждый раз, когда сервер получает новую команду SQL. На большинстве платформ этот параметр по умолчанию имеет значение on (включен). Только суперпользователи и пользователи с подходящим правом SET могут изменять этот параметр.