Skip to content

Commit

Permalink
[#23814] docs: Add log_dist option to auto_explain page. (#23921)
Browse files Browse the repository at this point in the history
Mention log_dist option that allows users to disable DIST stats when using auto_explain with log_analyze.

---------

Co-authored-by: Dwight Hodge <ghodge@yugabyte.com>
  • Loading branch information
pao214 and ddhodge authored Sep 13, 2024
1 parent 02a4bac commit dbddb04
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit dbddb04

Please sign in to comment.