pg_stat_monitor: USER_GUIDE.md Needs a Revamp

Description

The user documentation leaves a lot to be desired. Here is a list of issues I see:

  • The configuration parameters are missing min/max/default values.

  • The column names are not explained.

  • The examples provided have no text around them defining purpose and expected results.

  • The functions used in the example SQL queries are not explained properly; e.g. histogram function.

 

Overall, the file needs a complete review and fixing.

How to document

None

How to test

None

Smart Checklist

Activity

Show:
Done

Details

Assignee

Reporter

Labels

Time tracking

1w 3d 3h 35m logged

Components

Priority

Smart Checklist

Created July 29, 2021 at 7:25 PM
Updated March 12, 2025 at 7:09 AM
Resolved November 12, 2021 at 12:22 PM