Skip to content

Doc: add missing parameters to the GUC list - #407

Open
kaya-abdullah wants to merge 2 commits into
apache:mainfrom
kaya-abdullah:docs/guc-list-missing-params
Open

kaya-abdullah wants to merge 2 commits into
apache:mainfrom
kaya-abdullah:docs/guc-list-missing-params

Conversation

@kaya-abdullah

@kaya-abdullah kaya-abdullah commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

closes: #369


Change logs

Adds 46 parameters to the configuration parameter list (config-params-guc-list.md). Both copies of the page are updated, docs/ and versioned_docs/version-2.x/ (45 there, see below). The new entries are in alphabetical order and use the same format as the existing ones.

What the issue asked for

The issue names 10 parameters and the log_* group.

Added (6): these exist in Cloudberry and were missing from the list.

  • gp_cached_segworkers_threshold
  • gp_max_plan_size
  • gp_max_slices
  • lock_timeout
  • max_locks_per_transaction
  • max_slot_wal_keep_size

Not added (4): these do not exist in Cloudberry. None of them is defined as a parameter on main or on REL_2_STABLE.

  • gp_add_column_inherits_table_setting
  • gp_resource_group_memory_limit
  • master_shared_buffers
  • segment_shared_buffers

The log_* group (36 added): Cloudberry has 37 log_* parameters on main and 36 on REL_2_STABLE. log_checkpoints was already in the list, so this adds the other 36 (35 on 2.x):

  • log_autostats, log_autovacuum_min_duration, log_btree_build_stats, log_connections, log_destination, log_directory
  • log_disconnections, log_dispatch_stats, log_duration, log_error_verbosity, log_executor_stats, log_file_mode
  • log_filename, log_hostname, log_line_prefix, log_lock_waits, log_min_duration_sample, log_min_duration_statement
  • log_min_error_statement, log_min_messages, log_parameter_max_length, log_parameter_max_length_on_error, log_parser_stats, log_planner_stats
  • log_recovery_conflict_waits, log_replication_commands, log_rotation_age, log_rotation_size, log_startup_progress_interval, log_statement
  • log_statement_sample_rate, log_statement_stats, log_temp_files, log_timezone, log_transaction_sample_rate, log_truncate_on_rotation

Not in the issue (4 added)

These four are not in the issue, but several pages refer to them and they were missing from the list:

  • gp_autostats_mode
  • gp_vmem_protect_limit
  • max_statement_mem
  • statement_mem

Where the values come from

The type, default value, range, unit and setting category of each parameter come from its definition in the source code: guc_tables.c and guc_gp.c on main for docs/, and guc.c and guc_gp.c on REL_2_STABLE for versioned_docs/version-2.x/.

The two branches differ for six of the new parameters, so the two copies of the page differ in the same places:

  • log_autovacuum_min_duration: the default is 600000 ms (10 minutes) on main and -1 (off) on 2.x.
  • log_statement_stats: on 2.x it also cannot be turned on together with log_dispatch_stats.
  • gp_autostats_mode: on 2.x, MERGE does not trigger automatic statistics collection, so the 2.x copy does not mention it.
  • log_destination: jsonlog is a valid destination on main only, so the 2.x copy does not list it.
  • log_error_verbosity: for the same reason, the 2.x copy mentions csvlog output only.
  • log_startup_progress_interval: it does not exist on 2.x, so only the docs/ copy has it.

Add 28 parameters to config-params-guc-list.md in docs/ and
versioned_docs/version-2.x/: the six from issue apache#369 that exist in
Cloudberry, the log_* parameters other pages already mention, and
gp_autostats_mode, gp_vmem_protect_limit, max_statement_mem and
statement_mem.

Values come from the GUC definitions on main and REL_2_STABLE. The
2.x copy differs where the branches differ: the
log_autovacuum_min_duration default, log_statement_stats also
conflicting with log_dispatch_stats, and no MERGE in autostats.

See: Issue#369 <apache#369>
@kaya-abdullah
kaya-abdullah marked this pull request as draft October 11, 2026 21:02
…ptions

Add the 18 log_* parameters that were still missing, so the list now
has all 37 on main and all 36 on REL_2_STABLE.
log_startup_progress_interval exists on main only, so only docs/ has
it, and the 2.x copy does not list jsonlog for log_destination.

Correct descriptions from the previous commit against elog.c: with
stderr in log_destination, logging_collector on and gp_log_format csv,
messages are written in Cloudberry's CSV format and the other
destinations get nothing. Reword log_error_verbosity and
log_line_prefix to match, and clarify that the writer worker takes a
place in the gp_cached_segworkers_threshold free list.

See: Issue#369 <apache#369>
@kaya-abdullah
kaya-abdullah marked this pull request as ready for review October 11, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/config-params-guc-list is incomplete

1 participant