错误报告和日志

PostgreSQL 9.4.4 中文手册
上一页 | 上一级 | 章 18. 服务器配置 | 下一页

# 18.8. 错误报告和日志

## 18.8.1. 在哪里记录日志

`log_destination` (`string`)

  PostgreSQL支持多种记录服务器日志的方法，包括stderr, csvlog和 syslog。 在Windows里，还支持eventlog。把这个选项设置为一个逗号分隔的日志目标的列表。 缺省是只记录到stderr。这个选项只能在`postgresql.conf`文件 或者服务器命令行设置。

  如果csvlog包含在`log_destination`中， 日志项是用"逗号分隔"(CSV)格式的输出，这便于加载日志到程序。参见第 18.8.4 节获取更多详情。 logging_collector必须能够产生CSV格式的日志输出。

  > 注意: 在大多数Unix系统上，你将需要改变您的系统syslog守护进程的配置， 以便充分利用`log_destination`的syslog选项。 PostgreSQL可以通过`LOCAL7`(参见syslog_facility)记录syslog设施`LOCAL0`， 但缺省大多数平台上syslog配置将忽略所有这样的消息。 你将需要添加类似于下面的信息：

  >     local0.*    /var/log/postgresql

  > 到syslog守护程序的配置文件中，使其工作。

  > 在Windows上，当您使用`log_destination`的`eventlog`选项， 你应该注册一个事件源及其操作系统作业库， 使Windows事件查看器可以有规则的显示事件日志消息。 参见第 17.11 节获取更多详细信息。

`logging_collector` (`boolean`)

  这个参数启动日志收集， 这是一个后台进程，抓取发送到stderr的日志消息，并会将他们重定向到日志文件。 这个方法通常比记录到syslog更有用， 因为有些消息类型可能不会出现在syslog输出中 (一个常见的例子是动态连接失败的消息；另外一个是通过脚本比如`archive_command` 产生的错误消息。） 这个值只能在服务器启动的时候设置。

  > 注意: 不使用日志收集器可以登录到stderr; 无论服务器的stderr被定向到哪，则日志消息就定位到那里。然而， 该方法是只适用于低日志卷，因为它没有提供方便的方式来旋转日志文件。 另外，在某些平台上不使用日志收集器可能会导致丢失或乱码日志输出， 因为多个进程同时写入同一个日志文件可能覆盖彼此的输出。

  > 注意: 日志收集器设计永远不会丢失消息。 这意味着在非常高的负载情况下， 当收集器已经落后而试图发送额外的日志消息的时候，封锁服务器进程。 与此相反，syslog更喜欢忽略消息， 如果它无法写入，这意味着它可能无法记录这些消息，这种情况下， 但它不会阻止该系统的其余部分。

`log_directory` (`string`)

  在打开了`logging_collector`的时候，这个选项判断日志文件在哪个目录里创建。 它可以声明成绝对路径，或者是与集群的数据目录相对的路径。 这个选项只能在`postgresql.conf`文件里或者服务器命令行设置。 缺省是`pg_log`。

`log_filename` (`string`)

  在打开了`logging_collector`的时候，这个选项设置所创建的日志文件的文件名。 这个数值将被当作`strftime`模式看待。因此可以用`%`转义声明随时间而变的文件名。 （注意，如果有任何时区相关`%`转义，由log_timezone声明的时区进行计算。） 支持的`%`转义类似于Open Group上的strftime规范列表中的。 注意，不直接使用这个系统的strftime，所以特定平台的（非标准）扩展不起作用。 缺省是`postgresql-%Y-%m-%d_%H%M%S.log`。

  如果您没有转义指定文件名，你应该计划使用日志旋转程序以避免最终填充 整个磁盘。在8.4之前的版本中，如果没有`%`的转义符出现， PostgreSQL将追加新日志文件创建时间的时间戳， 但是不再是这种情况了。

  如果启用`log_destination`中的CSV格式输出， `.csv`将追加时间戳日志文件名来创建CSV格式输出的文件名。 （如果`log_filename`以`.log`为结束，后缀代替）。 在上面的例子情况下，CSV文件名是`server_log.1093827753.csv`。

  这个参数只能在`postgresql.conf`文件里或者服务器命令行上设置。

`log_file_mode` (`integer`)

  在Unix系统上，当`logging_collector`已启用时（在Microsoft Windows上将忽略此参数）， 此参数用于设置日志文件的权限。 该参数值预期为通过`chmod`和`umask` 系统调用接受的格式指定的数字模式。 （为了使用习惯八进制格式的数字必须以`0`(zero)开始）。

  默认的权限`0600`，只意味着 服务器拥有者可以读取或写入日志文件。其他较普遍 有用的设置是`0640`，让拥有者组成员来读取文件。 但是请注意，为了充分使用这种设置，你需要改变log_directory到集群数据目录之外的 某处存储这些文件。无论如何，使日志文件全局可读是不明智的，因为它们可能包含敏感数据。

  这个参数可以在`postgresql.conf`文件或者服务器命令行上设置。

`log_rotation_age` (`integer`)

  在打开了`logging_collector`的时候，这个选项设置一个独立日志文件的最大生存期。 在数值指定的分钟过去之后，将创建一个新的日志文件。设置为零可以关闭以时间为基础的新日志文件的创建。 这个选项只能在`postgresql.conf`文件里或者服务器命令行设置。

`log_rotation_size` (`integer`)

  在打开了`logging_collector`的时候，这个选项设置一个独立的日志文件的最大尺寸。 在数值指定的千字节写入日志文件之后，将会创建一个新的日志文件。 设置为零可以关闭以尺寸为基础的新日志文件的创建。 这个选项只能在`postgresql.conf`文件里或者服务器命令行上设置。

`log_truncate_on_rotation` (`boolean`)

  在打开了`logging_collector`的时候，这个选项将导致PostgreSQL 覆盖而不是附加到任何同名的现有日志文件上。 不过，覆盖只是发生在基于时间滚动而创建的新文件上，而不是在服务器启动的时候或者以尺寸为基础的滚动上。 如果为 off ，将始终向已存在的文件结尾追加。比如， 使用这个选项和类似`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 小时的日志，每小时一个日志，但是如果日志文件尺寸大于 1GB 也旋转日志。 把`log_filename`设置为`server_log.%H%M`, `log_truncate_on_rotation`设置为`on`, `log_rotation_age`设置为`60`并且把 `log_rotation_size`设置为`1000000`。 在`log_filename`里包含`%M` 允许任何尺寸驱动的旋转选取一个和开始的文件名同小时数但是名字不同的文件。

`syslog_facility` (`enum`)

  如果向syslog进行记录，那么这个选项判断要使用的syslog"设施"。 你可以从`LOCAL0`, `LOCAL1`, `LOCAL2`, `LOCAL3`, `LOCAL4`, `LOCAL5`, `LOCAL6`, `LOCAL7`中选择。缺省是`LOCAL0`。 又见你的系统的syslog守护进程文档。 这个选项只能在`postgresql.conf`文件里或者服务器启动的时候设置。

`syslog_ident` (`string`)

  如果向syslog进行记录，这个选项决定用于在syslog日志中标识PostgreSQL的程序名。 缺省是`postgres`。这个选项只能在`postgresql.conf`文件里或者服务器启动的时候设置。

`event_source` (`string`)

  当启用记录event log时，此参数 确定用于识别PostgreSQL消息日志的程序名称。 缺省是`PostgreSQL`。 该参数只能在`postgresql.conf`文件或者服务器命令行上设置。

## 18.8.2. 什么时候记录日志

`client_min_messages` (`enum`)

  这个选项控制哪些级别的消息发送到客户端。 有效的数值是`DEBUG5`, `DEBUG4`, `DEBUG3`, `DEBUG2`, `DEBUG1`, `LOG`, `NOTICE`, `WARNING`, `ERROR`, `FATAL`, 和`PANIC`。 每个级别包含所有它后面的级别，级别越靠后，发送的消息越少。缺省是`NOTICE`。 需要注意的是这里的`LOG`和`log_min_messages`里的级别不同。

`log_min_messages` (`enum`)

  控制写到服务器日志里的消息的详细程度。 有效值是`DEBUG5`, `DEBUG4`, `DEBUG3`, `DEBUG2`, `DEBUG1`, `INFO`, `NOTICE`, `WARNING`, `ERROR`, `LOG`, `FATAL`和 `PANIC`。 每个级别都包含它后面的级别。越靠后的数值发往服务器日志的消息越少。缺省是`WARNING`。 需要注意的是这里的`LOG`和`client_min_messages`里的级别不同。只有超级用户可以修改这个设置。

`log_min_error_statement` (`enum`)

  控制在服务器日志里输出哪一条导致错误条件的SQL语句。 所有导致一个特定级别(或者更高级别)错误的 SQL 语句都要被记录。 有效的值有`DEBUG5`, `DEBUG4`, `DEBUG3`, `DEBUG2`, `DEBUG1`, `INFO`, `NOTICE`, `WARNING`, `ERROR`, `LOG`, `FATAL`和`PANIC`。 缺省是`ERROR`， 表示所有导致错误、日志信息，致命错误、恐慌的SQL语句都将被记录。 设置为`PANIC`表示把这个特性关闭。只有超级用户可以改变这个设置。

`log_min_duration_statement` (`integer`)

  如果某个语句的持续时间大于或者等于这个毫秒数，那么在日志行上记录该语句及其持续时间。 设置为零将打印所有查询和他们的持续时间。设置为-1(缺省值)关闭这个功能。比如， 如果你把它设置为`250ms`，那么所有运行时间等于或者超过 250ms 的 SQL 语句都会被记录。 打开这个选项可以很方便地跟踪需要优化的查询。只有超级用户可以改变这个设置。

  对于使用扩展查询协议的客户端，语法分析、邦定、执行每一步所花时间都分别记录。

  > 注意: 当此选项与log_statement同时使用时， 已经被`log_statement`记录的语句文本不会被重复记录。 如果没有使用syslog的话，推荐使用log_line_prefix记录 PID 或会话ID， 这样就可以使用它们将语句消息连接耗时消息。

表 18-1解释了PostgreSQL使用的 消息严重程度。如果日志输出发送到syslog或者Windows的 eventlog，则严重程度如下表所示。

表 18-1. 消息严重级别

严重级别 | 用法 | syslog | eventlog
--- | --- | --- | ---
`DEBUG1..DEBUG5` | 提供开发人员使用的连续更多详细信息 | `DEBUG` | `INFORMATION`
`INFO` | 提供用户隐含要求的信息，比如在`VACUUM VERBOSE`过程输出的信息。 | `INFO` | `INFORMATION`
`NOTICE` | 提供可能对用户有帮助的信息，比如，长标识符的截断 | `NOTICE` | `INFORMATION`
`WARNING` | 提供可能问题的警告，比如在事务块范围之外的`COMMIT` | `NOTICE` | `WARNING`
`ERROR` | 报告导致当前命令退出的错误。 | `WARNING` | `ERROR`
`LOG` | 报告一些管理员感兴趣的信息，比如，检查点活跃性。 | `INFO` | `INFORMATION`
`FATAL` | 报告导致当前会话终止的错误。 | `ERR` | `ERROR`
`PANIC` | 报告导致所有数据库会话退出的错误。 | `CRIT` | `ERROR`

## 18.8.3. 记录什么

`application_name` (`string`)

  该`application_name`可以是小于`NAMEDATALEN`字符 （标准构建64个字符）的任何字符串。它通常是由应用程序连接到服务器设置。 该名称将显示在`pg_stat_activity`视图中 并包含在CSV格式的日志项中。它也可以被包括在 通过log_line_prefix参数的常规日志项中。 只有可打印的ASCII字符可能用在`application_name`值中。其它字符会 用问号(`?`)代替。

`debug_print_parse` (`boolean`)
`debug_print_rewritten` (`boolean`)
`debug_print_plan` (`boolean`)

  这些选项打开各种调试输出。当设置，它们打印生成的解析树，查询重写输出， 或每个执行查询的执行计划。 这些消息在`LOG`消息级别发出的， 所以默认情况下它们会出现在服务器日志中，但不会被发送到客户端。 您可以通过调整client_min_messages和/或 log_min_messages改变。这些参数缺省都是关闭的。

`debug_pretty_print` (`boolean`)

  当设置时，`debug_pretty_print`缩进`debug_print_parse`, `debug_print_rewritten`或者`debug_print_plan`产生的消息， 这样更加可读，但是，当关闭它时，比"紧凑型"格式更长的输出，缺省是打开的。

`log_checkpoints` (`boolean`)

  导致检查点和重启点被记录在服务器日志中。 一些统计都包含在日志消息中，包括缓冲区写入数量和编写它们的花费的时间。 这些参数只能在`postgresql.conf`文件或者服务器命令行上设置，缺省是off。

`log_connections` (`boolean`)

  导致记录到服务器的每个尝试连接，以及成功完成客户端认证。 该参数在会话开始之后不能改变，缺省是off。

  > 注意: 某些客户端程序，如psql当确定是否需要密码的时候， 企图连接两次。所以复制"连接收到"的消息不一定表示有问题。

`log_disconnections` (`boolean`)

  这个选项类似`log_connections`，但是在会话结束的时候在服务器日志里输出一行。 并且包含会话持续时间。 缺省是关闭的。这个参数在会话开始之后不能被改变。

`log_duration` (`boolean`)

  记录每个已完成语句的持续时间。默认值是`off`。只有超级用户可以改变这个设置。

  对于使用扩展查询协议的客户端，语法分析、邦定、执行每一步所花时间都分别记录。

  > 注意: 设置为0时该选项与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`错误代码 (参见附录 A)以及源代码文件名称，函数名称，以及产生错误的行数。 只有超级用户可以改变这个设置。

`log_hostname` (`boolean`)

  缺省时，连接日志只记录所连接主机的IP地址。打开这个选项导致同时记录主机名。 请注意，这样有可能带来一些不可忽略的性能损失(取决于你的名字解析的设置)。 这个选项只能在`postgresql.conf`文件里或者服务器命令行设置。

`log_line_prefix` (`string`)

  这是一个`printf`风格的字符串，在日志的每行开头输出。 `%`字符开始"转义序列"被如下所述状态信息替换。 无法识别的转义被忽略。其它字符都直接拷贝到日志行中。 有些转义只被会话进程识别，被后端进程看做空，比如主服务器进程。 通过在%之后该选项之前声明有一个数字文字，状态信息可以左对齐或者右对齐。 负值将会使得该状态信息在右侧补齐空白到最小宽度， 正直将在左侧补齐空白。补齐可以有助于帮助人们读取日志文件。 这个选项只能在`postgresql.conf`文件里或者服务器命令行设置。 缺省是空字符串。

  转义 | 影响 | 仅用于会话
  --- | --- | ---
  `%a` | 应用名 | 是
  `%u` | 用户名 | 是
  `%d` | 数据库名 | 是
  `%r` | 远程主机名或IP地址和远程端口 | 是
  `%h` | 远程主机名或IP地址 | 是
  `%p` | 进程 ID | 否
  `%t` | 没有毫秒的时间戳 | 否
  `%m` | 有毫秒的时间戳 | 否
  `%i` | 命令标签：会话的当前命令的类型 | 是
  `%e` | SQLSTATE 错误代码 | 否
  `%c` | 会话 ID：见下文 | 否
  `%l` | 每个会话或进程的日志行数，从1开始 | 否
  `%s` | 进程开始的时间戳 | 否
  `%v` | 虚拟事务 ID (backendID/localXID) | 否
  `%x` | 事务 ID (如果没有分配则为0) | 否
  `%q` | 不产生输出，但是告诉非会话的进程在字符串的这个点停止； 被会话进程忽略 | 否
  `%%` | 文字 `%` | 否

  `%c`转义打印唯一会话标识符， 由两个点号分隔的4字节的十六进制数字（没有前导零）组成。 数字是该过程的开始时间和进程ID， 所以`%c`也可以用做一种打印这些项目的节约空间的方法。 例如，为了从`pg_stat_activity`中生成会话标识符，使用这个查询：

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

  > 提示: 如果你设置`log_line_prefix`的非空值，你应该经常使其最后一个字符是一个空格， 提供来自日志行的其余部分的视觉分离。一个标点符号也可以使用。

  > 提示: Syslog产生自身时间戳和进程ID信息，如果你记录到syslog， 所以你可能不想包括那些逃脱。

`log_lock_waits` (`boolean`)

  当会话等待比deadlock_timeout获得锁更长的时间时，控制是否产生一个日志消息。 决定如果锁等待造成很差的性能，这是很有用处的。默认是`off`。

`log_statement` (`enum`)

  控制记录哪些SQL语句。有效的值是`none` (off), `ddl`, `mod`和 `all` (所有语句)。`ddl`记录所有数据定义命令，比如`CREATE`, `ALTER`和`DROP`语句。 `mod`记录所有`ddl`语句， 加上数据修改语句`INSERT`,`UPDATE`, `DELETE`, `TRUNCATE`, 和`COPY FROM`。如果所包含的命令类型吻合，那么`PREPARE`, `EXECUTE`和 `EXPLAIN ANALYZE`语句也同样被记录。 对于使用扩展查询协议的客户端，记录发生在接受到扩展信息并包含邦定参数(内置单引号要双写)的时候。

  缺省是`none`。只有超级用户可以改变这个设置。

  > 注意: 即使设置了`log_statement` = `all`，包含简单语法错误的语句也不会被记录。 因为仅在完成基本的语法分析并确定了语句类型之后才记录日志。在使用扩展查询协议的情况下， 在执行阶段之前(语法分析或规划阶段)同样不会记录。 将`log_min_error_statement`设为`ERROR`或更低才能记录这些语句。

`log_temp_files` (`integer`)

  控件的临时文件名称和大小。临时文件可以创建的分类，哈希，和临时的查询结果。 当它被删除时，一个日志项有利于每个临时文件。 零值记录所有临时文件的信息， 同时正值记录文件大小大于或等于千字节指定数量。 默认设置是-1，禁用这样的日志。只有超级用户可以更改此设置。

`log_timezone` (`string`)

  设置用于写入服务器日志的时间戳的时区。不像TimeZone，这个值是簇范围， 因此，所有会话将持续报告时间戳。默认值`GMT`，但这通常被 `postgresql.conf`覆盖；initdb 将安装与其系统环境一致的设置。参见第 8.5.3 节获取更多信息。 这个参数只能在`postgresql.conf`文件或者服务器命令行上进行。

## 18.8.4. 使用CSV-格式日志输出

在`log_destination`列表中包含`csvlog` 提供了一种便捷的方式导入日志文件到一个数据库表。 此选项在逗号分隔值(CSV)中发出日志行，这些列为： time stamp with milliseconds, user name, database name, process ID, client host:port number, session ID, per-session line number, command tag, session start time, virtual transaction ID, regular transaction ID, error severity, SQLSTATE code, error message, error message detail, hint, 导致错误的内部查询（如果有），字符计算错误位置， 包含错误文本，导致错误的用户查询（如果有并且通过`log_min_error_statement`启动）， 字符计算错误位置。其中有PostgreSQL源代码错误的位置（如果`log_error_verbosity`设置为`verbose`）， 以及应用程序的名称。这是一个用于存储CSV格式的日志输出样本表定义：

    CREATE TABLE postgres_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,
      PRIMARY KEY (session_id, session_line_num)
    );

使用`COPY FROM`命令，将日志文件导入到这个表中：

    COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;

你需要做几件事情简化导入CSV日志文件：

1. 设置`log_filename`和 `log_rotation_age`为你的日志文件 提供一个一致的，可预见的命名方式。 这让你预测哪些文件的名称以及独立日志文件是完整的，因此可以准备导入。

2. 设置`log_rotation_size`为0以禁用基于大小的日志旋转， 因为它很难预测日志文件名。

3. 设置`log_truncate_on_rotation`到`on`，以致于 旧的日志数据不与同一文件的新数据混合。

4. 上面表定义包括主密钥规范。这是为了防止意外导入相同的有用信息两次。 `COPY`命令要求所有的数据一次导入，所以任何错误都将导致整个导入过程失败。 如果你导入部分日志文件，当它完成时，然后再导入该文件，主键冲突会导致导入过程失败。 等待直到日志是完整的，并且导入之前关闭。 该程序也将防止意外导入尚未完全写入的局部行， 这也将导致`COPY`失败。

上一页 | 起始页 | 下一页
查询规划 | 上一级 | 运行时统计