Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edits to Ext 525 edb pgtuner updates #6366 #6399

Merged
merged 1 commit into from
Jan 24, 2025
+8 −8
Merged

Edits to Ext 525 edb pgtuner updates #6366 #6399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions advocacy_docs/pg_extensions/pg_tuner/configuring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To run EDB Postgres Tuner, you need to add it to the `shared_preload_libraries`

1. Restart Postgres.

1. Create the EDB Postgres Tuner extension in your database with the following command:
1. Create the EDB Postgres Tuner extension in your database:

```sql
CREATE EXTENSION edb_pg_tuner;
Expand All @@ -27,19 +27,19 @@ To run EDB Postgres Tuner, you need to add it to the `shared_preload_libraries`

The following custom GUCs control the EDB Postgres Tuner extension behavior. If you modify these parameters, then reload Postgres to apply the changes.

- `edb_pg_tuner.autotune` — Applies tuning recommendations automatically. The default is `false`.
- `edb_pg_tuner.autotune` — Applies tuning recommendations. The default is `false`.

- `edb_pg_tuner.naptime` — Sets the interval between each check in seconds. The default is 600 seconds (10 minutes).

- `edb_pg_tuner.max_wal_size_limit` — Sets the maximum value for the `max_wal_size` recommendation. The default is `0`, which sets no limit.

The following custom GUCs control the EDB Postgres Tuner `work_mem` tuning behavior for Postgres 14 and higher.
The following custom GUCs control the EDB Postgres Tuner `work_mem` tuning behavior for Postgres 14 and later.

- `edb_pg_tuner.tune_work_mem` — Dynamically increase the work mem for queries with disk spill to improve performance. The default is true.
- `edb_pg_tuner.tune_work_mem` — Dynamically increases the work mem for queries with disk spill to improve performance. The default is `true`.

- `edb_pg_tuner.work_mem_pool` — Maximum additional work_mem reserve that is allocated to queries with disk spill. The default is 2GB.
- `edb_pg_tuner.work_mem_pool` — Maximum additional work_mem reserve that's allocated to queries with disk spill. The default is 2GB.

- `edb_pg_tuner.log_min_duration` — Execution time threshold in ms for statistics logging. The default is 0, which logs everything. The value -1 will turn off logging.
- `edb_pg_tuner.log_min_duration` — Execution time threshold in ms for statistics logging. The default is 0, which logs everything. The value -1 turns off logging.

- `edb_pg_tuner.buffer_size` — Maximum query count for tracking statistics. The default is 5000.

Expand Down Expand Up @@ -88,5 +88,5 @@ EDB Postgres Tuner can recommend the following GUCs. The `static` category provi
!!! Note
For EDB Postgres Advanced Server, if `edb_pg_tuner.autotune` is enabled, a service restart may be required:

- Version 15 or higher: Any GUC that requires a restart is set when the service starts, therefore, you don't need to restart the service to apply the recommendations.
- Version 14 and lower: You do need to restart the service.
- Version 15 or later: Any GUC that requires a restart is set when the service starts, therefore you don't need to restart the service to apply the recommendations.
- Version 14 and earlier: You need to restart the service.
Loading