GitHub user edespino added a comment to the discussion: Introducing the 
[perfmon] Extension for Cloudberry Database Monitoring​

### 📚 User Documentation Plans?

This is a feature that will directly impact end users — it introduces an 
extension, SQL tables, background workers, and runtime hooks that people will 
need to understand to use effectively.

Could you clarify what the plans are for **end-user documentation**?

Some important areas that would benefit from formal documentation:

* **How to enable and install `perfmon`** (`CREATE EXTENSION`, configuration 
settings, etc.)
* **How to initialize the `gpperfmon` database** (via `gpperfmon_install`)
* **What each system table stores** (e.g., `queries_now`, `queries_history`, 
`system_*`)
* **How to use `pg_query_state(pid)`** in practice — expected output, 
limitations, and examples
* **What performance overhead, if any, is introduced**
* Any **permissions model** or user roles needed to query these tables or use 
the extension

Ideally this would be integrated into the Cloudberry user docs (`docs/` 
directory), or at least as a README in the `perfmon` source directory for now.

Without documentation, this feature risks being misunderstood or underutilized 
— and it's a missed opportunity for user engagement.

Happy to help review or contribute to the initial docs if that would help.

GitHub link: 
https://github.com/apache/cloudberry/discussions/1087#discussioncomment-13061011

----
This is an automatically sent email for dev@cloudberry.apache.org.
To unsubscribe, please send an email to: dev-unsubscr...@cloudberry.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@cloudberry.apache.org
For additional commands, e-mail: dev-h...@cloudberry.apache.org

Reply via email to