# log_parameter_max_length_on_error

> log_parameter_max_length_on_error 定义发生错误时绑定参数值可写入日志的最大字节数。
---

> [!NOTE]
> **Fact — 官方简述译文**：设置发生错误时绑定参数值可写入日志的最大字节数。

## 身份 {#identity}

| 字段 | 值 | 含义 |
| --- | --- | --- |
| 类型 | `integer` | 上游 pg_settings 类型 |
| Context | `user` | 普通用户可在运行时修改 |
| 单位 | `B` | 原始单位 |
| 范围 | `-1` – `1073741823` | 最后在档版本的原始上下限 |
| 枚举值 | — | 非枚举类型记为 — |
| 分类 | Reporting and Logging / What to Log | 上游分类 |
| 最后 boot 值 | `0` | 0 B |
{.fields meta="-"}

## 生命周期 {#lifecycle}

| Fact | 值 |
| --- | --- |
| 首次观测 | PG13 |
| 在档版本 | PG13–19 Beta 3 |
| 移除版本 | 否 |
| 引入提交 | [`0b34e7d307e6`](https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=0b34e7d307e6a142ee94800e6d5f3e73449eeffd) — Improve user control over truncation of logged bind-parameter values. |
| 提交日期 | 2020-04-02 |
| Discussion | [讨论 1](https://postgr.es/m/b10493cc-a399-a03a-67c7-068f2791ee50@imap.cc) |

## 默认值变迁 {#default-history}

| 版本 | 原始 `boot_val` | 单位 | 人类可读值 |
| --- | --- | --- | --- |
| PG13–19 Beta 3 | `0` | `B` | 0 B |
{.full-width caption="PG9.0–19 Beta 3 实测 boot 默认值"}

## 机制详解 {#mechanism}

log_parameter_max_length_on_error 控制错误报告中包含的 Bind 值。默认零不记录，-1 允许完整值，正字节数把每个文本值截断到该上限。

只要值非零，PostgreSQL 就必须在每条语句开始时保留参数的文本表示，以备发生错误。即使语句成功也要支付该开销，二进制参数还需要转换而不只是复制文本。

它属于 USER 上下文的会话参数，并与 log_parameter_max_length 相互独立。因此即使普通语句日志不记录值，应用也可能在错误路径意外暴露。应联合评审错误详情、访问、脱敏与保留。

## 调优建议 {#tuning-advice}

> [!TIP]
> **Advice。** 以下建议是工作负载起点，必须用真实测量验证。

| 场景 | 建议 |
| --- | --- |
| OLTP | 除非错误诊断明确需要绑定值，否则保持 0。任何非零值都会让每条语句承担转换与保留内存开销，因此优先使用有界正值，并按角色、数据库或会话缩小范围。 |
| OLAP | 只在受控诊断参数化分析作业时使用有界正值；成功语句同样会保留参数文本，应同时预算转换成本与内存。 |
| 小规格 | 优先保持 0。若错误路径必须记录绑定值，应选短上限、缩小作用域，并在启用前验证内存开销与秘密脱敏策略。 |
{.full-width}

## Pigsty 取值 {#pigsty}

以下值来自固定 8 核、32 GiB、100 GiB SSD 夹具，并按 PG19 Beta 3 渲染当前 Pigsty 模板；这不表示 Pigsty 当前支持该历史或测试版本。

| 模板 | 有效值 | 与上游 boot 比较 | 源表达式 |
| --- | --- | --- | --- |
| OLTP | 未修改 | — | — |
| OLAP | 未修改 | — | — |
| CRIT | 未修改 | — | — |
| TINY | 未修改 | — | — |
{.full-width}

> [!CAUTION]
> **Advice — 待人工复核。** 当前 Pigsty 模板投影事实：OLTP: PG13–19 Beta 3 未修改；OLAP: PG13–19 Beta 3 未修改；CRIT: PG13–19 Beta 3 未修改；TINY: PG13–19 Beta 3 未修改。 未发现覆盖值，因此不推断 Pigsty 专属理由。

## 常见坑 {#common-pitfalls}

- 误以为只有语句失败时才支付转换与内存成本；值非零时每条语句都会支付。
- 使用 -1，把完整秘密或大载荷暴露在错误报告中。
- 忽略二进制 Bind 值的文本转换成本，以及成功语句也会保留参数表示。
- 误以为 log_parameter_max_length 会保护错误路径；两个上限彼此独立。

## 关联参数 {#related-parameters}

[`log_statement`](/zh/parameters/log-statement/) · [`log_duration`](/zh/parameters/log-duration/) · [`log_connections`](/zh/parameters/log-connections/) · [`log_disconnections`](/zh/parameters/log-disconnections/) · [`log_parameter_max_length`](/zh/parameters/log-parameter-max-length/)

## 参考资料 {#references}

- [PostgreSQL 19 Beta 3 — log_parameter_max_length_on_error](https://www.postgresql.org/docs/19/runtime-config-logging.html#GUC-LOG-PARAMETER-MAX-LENGTH-ON-ERROR)
- [PostgreSQL 19 发行说明](https://www.postgresql.org/docs/19/release-19.html)
- [机器可读 GUC 全量导出](/data/guc.jsonl)