18.8. エラー報告とログ取得

PostgreSQLは、stderr、csvlogおよびsyslogを含めて、サーバメッセージのログ取得に対し数種類の方法を提供します。 Windowsでは、eventlogも同時に提供します。 このパラメータを設定するには、コンマ区切りでお好みのログ出力先を記載します。 デフォルトでは、ログはstderrのみに出力されます。 このパラメータはpostgresql.confファイル、または、サーバのコマンドラインでのみ設定されます。

csvlogがlog_destinationに含まれる場合、ログ項目はプログラムへの読み込みが簡便な"カンマ区切り値"書式（CSV）で出力されます。 詳細は項18.8.4を参照してください。 CSV書式のログ出力を生成するためにはlogging_collectorを有効にする必要があります。

このパラメータは、ログメッセージを集積しstderrに送信、ログファイルにリダイレクトするバックエンドプロセスであるログコレクタを有効にします。 この方法はsyslogへのログよりもしばしば有用です。 メッセージの一部の種類がsyslogでは出力されない可能性があるためです。 （一般的な例として、ダイナミックリンカのエラーメッセージがあります。 他にもarchive_commandなどのスクリプトにより生成されるエラーメッセージがあります。） このパラメータはサーバ起動時のみ設定可能です。

logging_collectorを有効と設定した場合、このパラメータはログファイルが作成されるディレクトリを確定します。 ディレクトリは、絶対パス、もしくはデータベースクラスタのディレクトリに対する相対パスで指定することができます。 このパラメータはpostgresql.confファイル、またはサーバコマンドラインからのみ設定可能です。

logging_collectorが有効な場合、このパラメータは作成されたログファイルのファイル名を設定します。 値はstrftimeパターンとして扱われるため、%エスケープを使用して、時刻によって変動するファイル名を指定することができます。 （時間帯に依存した%エスケープが存在する場合、log_timezoneで指定された時間帯で計算が行われます。） 　　　　サポートされている %-エスケープはstrftime 仕様によく似ています。 システムのstrftimeは直接使用されないので、プラットフォーム固有の（非標準）の拡張は動作しません。

エスケープすることなくファイル名を指定する場合、ディスク全体を使い切ってしまうことを防止するためにログローテーションを行うユーティリティを使用することを計画しなければなりません。 8.4より前のリリースのPostgreSQLでは、%エスケープがなければ、新しいログファイルの生成時のエポック時刻を付与しますが、これはもはや当てはまりません。

CSV書式の出力がlog_destinationで有効な場合、タイムスタンプ付きのログファイル名にに.csvを付与し、最終的なCSV書式出力用のファイル名が作成されます。 （log_filenameが.logで終わる場合は後置詞が置き換えられます。） 上の例の場合、ファイル名はserver_log.1093827753.csvとなります。

このパラメータはpostgresql.confか、サーバコマンドラインのみ設定可能です。

Unixシステムにおいては、logging_collectorが有効になっている場合、このパラメータはログファイルのパーミッションを設定します。 （Microsoft Windowsではこのパラメータは無視されます。） パラメータの値はchmod および umaskシステムコールで許容されるフォーマットで指定される数値モードであると期待されます。 （慣例的な8進数フォーマットを使用する場合、番号は0（ゼロ）で始まらなければなりません。

デフォルトのパーミッションは0600で、意味するところはサーバの所有者のみログファイルの読み書きが可能です。 そのほか一般的に実用的な設定は0640で、所有者のグループはファイルを読み込めます。 しかし、これらの設定を活用するにはlog_directoryがクラスタデータディレクトリの外部のどこかにあるファイルを格納できるように変更する必要があります。

このパラメータはpostgresql.confファイル、またはサーバコマンドラインからのみ設定可能です。

logging_collectorが有効な場合、このパラメータは個々のログファイルの最大寿命をを決定します。 ここで指定した時間（分単位）経過すると、新しいログファイルが生成されます。 ゼロに設定することで、時間に基づいた新しいログファイルの生成は無効になります。 このパラメータは、postgresql.confファイル、または、サーバのコマンドラインでのみで設定されます。

logging_collectorが有効な場合、このパラメータは個々のログファイルの最大要領を決定します。 ここで指定したキロバイト分ログファイルに出力された後、新しいログファイルが生成されます。 ゼロに設定することで、サイズに基づいた新しいログファイルの生成は無効になります。 このパラメータはpostgresql.confファイル、または、サーバのコマンドラインでのみで設定されます。

logging_collectorが有効な場合、このパラメータにより、PostgreSQLは既存の同名のファイルに追加するのではなく、そのファイルを切り詰める（上書きする）ようになります。 しかし、切り詰めは時間を基にしたローテーションのために新規にファイルが開かれた時にのみ発生し、サーバ起動時やサイズを基にしたローテーションでは発生しません。 偽の場合、全ての場合において既存のファイルは追記されます。 例えば、この設定をpostgresql-%H.logのようなlog_filenameと組み合わせて使用すると、24個の時別のログファイルが生成され、それらは周期的に上書きされることになります。 このパラメータはpostgresql.confファイル、または、サーバのコマンドラインで設定されます。

例：7日間のログを保存し、毎日のログを server_log.Mon、server_log.Tue、等とし、そして自動的に前週のログを今週のログで上書きするには以下のように設定します。 log_filename を server_log.%aとし、 log_truncate_on_rotation を onにし、そして log_rotation_age を 1440に設定します。

例：24時間のログを保持、1時間おきに1つのログファイルを作成、ただし、ログファイルのサイズが1ギガバイトを超えそうな場合即座に切り替えさせるには、 log_filename を server_log.%H%Mにし、 log_truncate_on_rotation を onにし、 log_rotation_age を 60にし、そして log_rotation_size を 1000000に設定します。 log_filenameに%Mを含めると、元の時間毎のファイル名と異なる名前を選択する可能性がある、サイズを元にしたローテーションを行うことができます。

syslogへのログ取得が有効な場合、このパラメータはsyslogの"facility"が使われるように確定します。 LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7の中から選んでください。 デフォルトはLOCAL0です。 使用しているシステムのsyslogデーモンの文書を同時に参照してください。 このパラメータはpostgresql.confファイル、または、サーバのコマンドラインでのみで設定されます。

syslogにログ取得が有効な場合、このパラメータはsyslogログ内のPostgreSQLメッセージを特定するのに使用するプログラム名を確定します。デフォルトはpostgresです。 このパラメータは、postgresql.confファイル、または、サーバのコマンドラインでのみで設定されます。

サーバをメッセージ出力なしで実行します。 このパラメータを設定すると、サーバは自動的にバックグラウンドで起動し、制御端末を切り離します。 このパラメータはサーバ起動時にのみ設定可能です。

どのメッセージ階層をクライアントに送るかを管理します。有効な値は、DEBUG5、 DEBUG4、DEBUG3、DEBUG2、 DEBUG1、LOG、NOTICE、 WARNING、ERROR、FATAL、およびPANICです。それぞれの階層はそれに続く全ての階層を包含します。階層が後の方になるにつれ、より少ないメッセージが送られます。デフォルトはNOTICEです。ここでのLOGの優先順位がlog_min_messagesの場合と異なることに注意してください。

どのメッセージ階層をサーバログに書き込むかを管理します。有効な値は DEBUG5、DEBUG4、 DEBUG3、DEBUG2、DEBUG1、 INFO、NOTICE、WARNING、 ERROR、LOG、FATAL、および PANICです。それぞれの階層はその下の全ての階層を含みます。階層を低くする程、より少ないメッセージがログに送られます。デフォルトはWARNINGです。ここでのLOGの優先順位がclient_min_messagesの場合と異なることに注意してください。スーパユーザのみこの設定を変更できます。

エラー条件の原因となったどのSQL文をサーバログに記録するかを制御します。 設定したレベル以上のメッセージについては現在のSQL文がログに記録されます。 有効な値は、DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING、ERROR、LOG、FATAL、PANICです。 デフォルトはERRORです。 エラー、ログメッセージ、致命的エラー、パニックを引き起こした文がログに記録されることを意味します。 失敗した文の記録を実質的に無効にするには、このパラメータをPANICに設定してください。 スーパーユーザのみがこのオプションを変更することができます。

文の実行に少なくとも指定したミリ秒数かかった場合、それぞれの文の実行に要した時間をログに記録します。 0に設定すれば、すべての文の実行時間が出力されます。 -1（デフォルト）は、文実行時間の記録を無効にします。 例えば、250msと設定した場合、250msもしくはそれ以上長くかかった全てのSQL文がログとして残ります。 このパラメータを有効にすることにより、アプリケーションで最適化されていない問い合わせを追跡するのが便利になります。 スーパーユーザのみこの設定を変更できます。

拡張問い合わせプロトコルを使用するクライアントでは、Parse、Bind、Executeそれぞれの段階で要した時間が独立して記録されます。

application_nameはNAMEDATALEN文字以下（標準構築では64文字）のいかなる文字列が可能です。 サーバに接続するときに、典型的にアプリケーションで設定されます。 名前はpg_stat_activityビューに表示され、CVSログ項目に含まれます。 log_line_prefixパラメータで通常のログ項目にも含まれます。 印字可能なASCII文字のみapplication_name値に使用されます。 その他の文字は疑問符（?）に置換されます。

これらのパラメータは生成される各種デバッグ出力を有効にします。 設定すると実行された問い合わせそれぞれに対し、最終的な解析ツリー、問い合わせリライタの出力、実行計画を出力します。 これらのメッセージはLOGメッセージレベルで出力されますので、デフォルトではサーバログに出力され、クライアントには渡されません。 client_min_messages、log_min_messagesまたはその両方を調整することで変更することができます。 デフォルトではこれらのパラメータは無効です。

設定された場合、debug_print_parse、 debug_print_rewritten、または debug_print_planで生成されたメッセージを字下げします。設定されない場合の"コンパクト"形式よりもより見やすく、しかしより長いものとなります。デフォルトは有効です。

チェックポイントおよびリスタートポイントをサーバログに記録するようにします。 書き出されたバッファ数や書き出しに要した時間など、いくつかの統計情報がこのログメッセージに含まれます。 このパラメータはpostgresql.confファイルまたはサーバのコマンドラインでのみ設定可能です。 デフォルトはoffです。

これにより、クライアント認証の成功終了などのサーバへの接続試行がログに残ります。 このパラメータはセッションが開始された後は変更できません。 デフォルトはoffです。

これはlog_connectionsと同様の内容をサーバログに行として出力します。 しかし、セッションが完了した時点であって、かつセッションが持続していたことが条件です。 デフォルトではoffです このパラメータはセッションが開始された後は変更できません。

すべての完了した文について、その経過時間をログするようにします。 デフォルトはoffです。 スーパーユーザのみがこの設定を変更することができます。

拡張問い合わせプロトコルを使用するクライアントでは、Parse、Bind、Executeそれぞれの段階で要した時間が独立して記録されます。

ログ取得されるそれぞれのメッセージに対し、サーバログに書き込まれる詳細の量を制御します。 有効な値は、TERSE、DEFAULT、およびVERBOSEで、それぞれは表示されるメッセージにより多くのフィールドを追加します。 TERSEはDETAIL、HINT、QUERY、およびCONTEXTエラー情報を除外します。 VERBOSE出力は、SQLSTATEエラーコード（付録Aも参照）、および、ソースコードファイル名、関数名、そしてエラーを生成した行番号を含みます。 スーパユーザのみこの設定を変更できます。

デフォルトでは、接続ログメッセージは接続元ホストのIPアドレスのみを表示します。 このパラメータを有効にすると、ホスト名もログに残るようになります。 ホスト名解決方法の設定に依存しますが、これが無視できないほどの性能劣化を起こす可能性があることに注意してください。 このパラメータはpostgresql.confファイル内またはサーバのコマンドラインでのみ設定可能です。

これは、各ログ行の先頭に出力するprintfの書式文字列です。 %から始まる"エスケープシーケンス"は、後述の通りのステータス情報で置き換えられます。 この他のエスケープは無視されます。 他の文字はそのままログ行に出力されます。 エスケープの中には、セッションプロセスによってのみ認識可能なものがあり、これらはメインサーバプロセスなどのバックグラウンドプロセスでは無視されます。 このパラメータは、postgresql.confファイル、または、サーバのコマンドラインでのみで設定することができます。 デフォルトは空文字列です。

SELECT to_hex(EXTRACT(EPOCH FROM backend_start)::integer) || '.' ||
       to_hex(procpid)
FROM pg_stat_activity;

セッションがロックの獲得までの間にdeadlock_timeoutより長く待機する場合にログメッセージを生成するかどうかを制御します。 これは、ロックが待たされ性能がでていないのかどうか決める時に有用です。 デフォルトはoffです。

どのSQL文をログに記録するかを制御します。 有効な値は、none（off）、ddl、mod、およびall（全てのメッセージ）です。 ddlは、CREATE、ALTER、およびDROP文といった、データ定義文を全てログに記録します。 modは、全てのddl文に加え、INSERT、UPDATE、DELETE、TRUNCATE、およびCOPY FROMといった、データ変更文をログに記録します。 PREPAREとEXPLAIN ANALYZEコマンドも、そこに含まれるコマンドが適切な種類であればログが録られます。 拡張問い合わせプロトコルを使用するクライアントでは、Executeメッセージを受け取った時にBindパラメータの値が（すべての単一引用符が二重にされた常態で）含まれていた場合、ログに記録されます。

デフォルトはnoneです。スーパユーザのみこの設定を変更できます。

一時ファイル名と容量を制御します。 一時ファイルはソート処理やハッシュ処理、一時的な問い合わせの結果のために作成されます。 ログの項目はすべての一時ファイルそれぞれについて削除されたときに生成されます。 ゼロという値ではすべての一時ファイル情報のログが残ります。 正数ではキロバイト単位の指定値以上の容量のファイルのみがログに残ります。 デフォルトの設定は-1で、このログ処理を無効にします。 スーパーユーザのみがこの設定を変更できます。

サーバログに書き出す際に使用される時間帯を設定します。 timezoneと異なり、すべてのセッションで一貫性を持ってタイムスタンプが報告されるようにこの値はクラスタ全体に適用されます。 明示的に設定された場合、サーバはシステム環境で指定された時間帯をこの値で初期化します。 詳細は項8.5.3を参照してください。 このパラメータはpostgresql.conf内またはサーバのコマンドラインでのみ設定することができます。