From dbddb04d30038b97f58657962f278c342526339f Mon Sep 17 00:00:00 2001 From: Bvsk Patnaik Date: Fri, 13 Sep 2024 14:28:45 -0700 Subject: [PATCH] [#23814] docs: Add log_dist option to auto_explain page. (#23921) Mention log_dist option that allows users to disable DIST stats when using auto_explain with log_analyze. --------- Co-authored-by: Dwight Hodge --- .../pg-extensions/extension-auto-explain.md | 1 + .../pg-extensions/extension-auto-explain.md | 1 + .../pg-extensions/extension-auto-explain.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/content/preview/explore/ysql-language-features/pg-extensions/extension-auto-explain.md b/docs/content/preview/explore/ysql-language-features/pg-extensions/extension-auto-explain.md index e819224426e9..56c9099a07e9 100644 --- a/docs/content/preview/explore/ysql-language-features/pg-extensions/extension-auto-explain.md +++ b/docs/content/preview/explore/ysql-language-features/pg-extensions/extension-auto-explain.md @@ -38,6 +38,7 @@ You can customize the following auto_explain parameters: | `log_format` | The format of the EXPLAIN output. Allowed values are `text`, `xml`, `json`, and `yaml`. Only superusers can change this setting. | text | | `log_nested_statements` | Consider nested statements (statements executed inside a function) for logging. When off, only top-level query plans are logged. Only superusers can change this setting. | false | | `sample_rate` | Explain only a set fraction of the statements in each session. The default 1 means explain all the queries. In case of nested statements, either all will be explained or none. Only superusers can change this setting. | 1 | +| `log_dist` | Set to false to disable the [DIST option](../../../../api/ysql/the-sql-language/statements/perf_explain/#dist) of `EXPLAIN ANALYZE`. True by default, equivalent to `EXPLAIN (ANALYZE, DIST)`. This setting only applies when `log_analyze` is true. | true | Note that the default behavior is to do nothing, so you must set at least `auto_explain.log_min_duration` if you want any results. diff --git a/docs/content/stable/explore/ysql-language-features/pg-extensions/extension-auto-explain.md b/docs/content/stable/explore/ysql-language-features/pg-extensions/extension-auto-explain.md index a0888e61a69e..ffa8b3488a9d 100644 --- a/docs/content/stable/explore/ysql-language-features/pg-extensions/extension-auto-explain.md +++ b/docs/content/stable/explore/ysql-language-features/pg-extensions/extension-auto-explain.md @@ -38,6 +38,7 @@ You can customize the following auto_explain parameters: | `log_format` | The format of the EXPLAIN output. Allowed values are `text`, `xml`, `json`, and `yaml`. Only superusers can change this setting. | text | | `log_nested_statements` | Consider nested statements (statements executed inside a function) for logging. When off, only top-level query plans are logged. Only superusers can change this setting. | false | | `sample_rate` | Explain only a set fraction of the statements in each session. The default 1 means explain all the queries. In case of nested statements, either all will be explained or none. Only superusers can change this setting. | 1 | +| `log_dist` | Set to false to disable the [DIST option](../../../../api/ysql/the-sql-language/statements/perf_explain/#dist) of `EXPLAIN ANALYZE`. True by default, equivalent to `EXPLAIN (ANALYZE, DIST)`. This setting only applies when `log_analyze` is true. | true | Note that the default behavior is to do nothing, so you must set at least `auto_explain.log_min_duration` if you want any results. diff --git a/docs/content/v2.20/explore/ysql-language-features/pg-extensions/extension-auto-explain.md b/docs/content/v2.20/explore/ysql-language-features/pg-extensions/extension-auto-explain.md index 1e68ac111cc1..1ac8d62d1445 100644 --- a/docs/content/v2.20/explore/ysql-language-features/pg-extensions/extension-auto-explain.md +++ b/docs/content/v2.20/explore/ysql-language-features/pg-extensions/extension-auto-explain.md @@ -38,6 +38,7 @@ You can customize the following auto_explain parameters: | `log_format` | The format of the EXPLAIN output. Allowed values are `text`, `xml`, `json`, and `yaml`. Only superusers can change this setting. | text | | `log_nested_statements` | Consider nested statements (statements executed inside a function) for logging. When off, only top-level query plans are logged. Only superusers can change this setting. | false | | `sample_rate` | Explain only a set fraction of the statements in each session. The default 1 means explain all the queries. In case of nested statements, either all will be explained or none. Only superusers can change this setting. | 1 | +| `log_dist` | Set to false to disable the [DIST option](../../../../api/ysql/the-sql-language/statements/perf_explain/#dist) of `EXPLAIN ANALYZE`. True by default, equivalent to `EXPLAIN (ANALYZE, DIST)`. This setting only applies when `log_analyze` is true. | true | Note that the default behavior is to do nothing, so you must set at least `auto_explain.log_min_duration` if you want any results.