external
/
pg_stat_monitor
mirror of https://github.com/percona/pg_stat_monitor.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PG-359 Doc - Update pg_stat_monitor_settings view with new options 

modified:   docs/USER_GUIDE.md
pull/195/head
Anastasia Alexadrova 2022-03-25 15:22:01 +02:00
parent 7196d6106f
commit 56e744044e
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/USER_GUIDE.md
View File

@ -109,7 +109,6 @@ Learn more about using histograms from the [usage example](#histogram-1).
## Views
`pg_stat_monitor` provides the following views:
* `pg_stat_monitor` is the view where statistics data is presented.
* `pg_stat_monitor_settings` view shows available configuration options which you can change.
@ -172,18 +171,18 @@ The following table shows setup options for each configuration parameter and whe
| ----------------------------------------------|--------------------|-----|-------------------|-------------------|---------------------
| [pg_stat_monitor.pgsm_max](#pg_stat_monitorpgsm_max) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_query_max_len](#pg_stat_monitorpgsm_query_max_len) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_enable](#pg_stat_monitorpgsm_enable) | :heavy_check_mark: | :x: |:heavy_check_mark: |:x: | :x:
| [pg_stat_monitor.pgsm_track_utility](#pg_stat_monitorpgsm_track_utility) | :heavy_check_mark: | :heavy_check_mark: |:heavy_check_mark: |:x: | :heavy_check_mark:
| [pg_stat_monitor.pgsm_normalized_query](#pg_stat_monitorpgsm_normalized_query) | :heavy_check_mark: | :heavy_check_mark: |:heavy_check_mark: |:x: | :heavy_check_mark:
| [pg_stat_monitor.pgsm_max_buckets](#pg_stat_monitorpgsm_max_buckets) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :heavy_check_mark:
| [pg_stat_monitor.pgsm_bucket_time](#pg_stat_monitorpgsm_bucket_time) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_object_cache](#pg-stat-monitorpgsm-object-cache) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_histogram_min](#pg_stat_monitorpgsm_histogram_min) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_histogram_max](#pg_stat_monitorpgsm_histogram_max) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_histogram_buckets](#pg_stat_monitorpgsm_histogram_buckets) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_query_shared_buffer](#pg_stat_monitorpgsm_query_shared_buffer) | :heavy_check_mark: | :x: |:x: |:heavy_check_mark: | :x:
| [pg_stat_monitor.pgsm_overflow_target](#pg_stat_monitorpgsm_overflow_target) | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: |
| [pg_stat_monitor.pgsm_enable_query_plan](#pg_stat_monitorpgsm_enable_query_plan) | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: |
| [pg_stat_monitor.track](#pg_stat_monitortrack) | :heavy_check_mark: | :x: | :x: | :x: | :heavy_check_mark: |
| [pg_stat_monitor.extract_comments](#pg_stat_monitorextract_comments)| :heavy_check_mark: | :x: | :x: | :x: | :heavy_check_mark: |
| [pg_stat_monitor.pgsm_track_planning](#pg_stat_monitorpgsm_track_planning) | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: |
#### Parameters description:
@ -192,7 +191,6 @@ The following table shows setup options for each configuration parameter and whe
##### pg_stat_monitor.pgsm_max
Values:
- Min: 1
- Max: 1000
- Default: 100
@ -203,18 +201,12 @@ This parameter defines the limit of shared memory (in MB) for ``pg_stat_monitor`
##### pg_stat_monitor.pgsm_query_max_len
Values:
- Min: 1024
- Max: 2147483647
- Default: 1024
Sets the maximum size of the query. This parameter can only be set at the start of PostgreSQL. For long queries, the query is truncated to that particular length. This is to avoid unnecessary usage of shared memory. Requires the server restart.
##### pg_stat_monitor.pgsm_enable
Type: boolean. Default: 1
Enables or disables the monitoring. "Disable" (0) means that ``pg_stat_monitor`` will not collect the statistics for the whole cluster.
##### pg_stat_monitor.pgsm_track_utility
@ -231,7 +223,6 @@ By default, the query shows the actual parameter instead of the placeholder. It
##### pg_stat_monitor.pgsm_max_buckets
Values:
- Min: 1
- Max: 10
- Default: 10
@ -243,7 +234,6 @@ Requires the server restart.
##### pg_stat_monitor.pgsm_bucket_time
Values:
- Min: 1
- Max: 2147483647
- Default: 60
@ -255,7 +245,6 @@ Requires the server restart.
##### pg_stat_monitor.pgsm_histogram_min
Values:
- Min: 0
- Max: 2147483647
- Default: 0
@ -267,7 +256,6 @@ Requires the server restart.
##### pg_stat_monitor.pgsm_histogram_max
Values:
- Min: 10
- Max: 2147483647
- Default: 100000
@ -277,7 +265,6 @@ This parameter sets the upper bound of the execution time histogram (in ms). Req
##### pg_stat_monitor.pgsm_histogram_buckets
Values:
- Min: 2
- Max: 2147483647
- Default: 10
@ -287,7 +274,6 @@ This parameter sets the maximum number of histogram buckets. Requires the server
##### pg_stat_monitor.pgsm_query_shared_buffer
Values:
- Min: 1
- Max: 10000
- Default: 20
@ -306,6 +292,21 @@ Type: boolean. Default: 1
Enables or disables query plan monitoring. When the `pgsm_enable_query_plan` is disabled (0), the query plan will not be captured by `pg_stat_monitor`. Enabling it may adversely affect the database performance. Requires the server restart.
##### pg_stat_monitor.track
This parameter controls which statements are tracked by `pg_stat_monitor`.
Values:
- `top`: Default, track only top level queries (those issued directly by clients).
- `all`: Track top along with sub/nested queries. As a result, some SELECT statement may be shown as duplicates.
- `none`: Disable query monitoring.
##### pg_stat_monitor.extract_comments
Type: boolean. Default: 0
This parameter controls whether to enable or disable extracting comments from queries.
##### pg_stat_monitor.pgsm_track_planning