Re: wait event docs

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: Jeremy Schneider <schnjere(at)amazon(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: wait event docs
Date: 2019-12-21 22:46:35
Message-ID: 20191221224635.GN11527@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-general pgsql-www

On Fri, Dec 13, 2019 at 03:50:29PM +0900, Michael Paquier wrote:
> On Thu, Dec 12, 2019 at 02:07:14PM -0800, Jeremy Schneider wrote:
> > The wait event information in PostgreSQL is very helpful for
> > troubleshooting.  I always reference the PostgreSQL docs first, and when
> > people ask me about wait events that where I send them first.  The list
> > of wait events there is comprehensive, but the descriptions are a bit
> > terse and often use vocabulary that requires some familiarity with the
> > internals to understand.
>
> (I think that it would be better to avoid cross-posting among multiple
> lists. Please note that I have removed -www and -general in my reply,
> keeping -docs because that7s the most meaningful)
>
> > Could we create a new wiki page as a starting point, and we could draft
> > up and maintain something there for a little while?  Maybe a place like
> > https://wiki.postgresql.org/wiki/Wait_Events ?
>
> That sounds like a good idea, as it is true that the docs are rather
> sparse about the meaning behind a given wait event showing a lot in
> profiles and what it actually means for your application. We have a
> couple of links from the docs to the wiki, so it could be an idea to
> add a link to the wiki in the docs near the wait event table. more to
> the point, this makes me wonder if actually a better place for such
> stuff would be a new section dedicated to wait event profiles here:
> https://www.postgresql.org/docs/devel/monitoring.html

Agreed, it probably should be in the official docs.

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I. As I am, so you will be. +
+ Ancient Roman grave inscription +

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2019-12-22 14:37:03 Default user 'postgres' not mentioned in the documentation?
Previous Message Bruce Momjian 2019-12-21 20:20:17 Re: pg_basebackup page need further clarification

Browse pgsql-general by date

  From Date Subject
Next Message Adrian Klaver 2019-12-21 23:37:04 Re: Semi-unable to add new records to table--primary key needed?
Previous Message Boylan, Ross 2019-12-21 21:41:32 Re: Semi-unable to add new records to table--primary key needed?

Browse pgsql-www by date

  From Date Subject
Next Message tsunakawa.takay@fujitsu.com 2019-12-23 00:38:29 RE: "Resend" in mail archive does not recognize the change of email address
Previous Message Magnus Hagander 2019-12-20 13:00:01 Re: "Resend" in mail archive does not recognize the change of email address