Re: wait event docs

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Jeremy Schneider <schnjere(at)amazon(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: wait event docs
Date: 2019-12-13 06:50:29
Message-ID: 20191213065029.GF1942@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-general pgsql-www

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
--
Michael

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2019-12-15 22:35:17 Re: Example 42.4. A PL/pgSQL Trigger Function for Auditing
Previous Message Jeremy Schneider 2019-12-12 22:07:14 wait event docs

Browse pgsql-general by date

  From Date Subject
Next Message Daulat Ram 2019-12-13 08:56:48 How to Change collate & ctype for an existing database?
Previous Message Josef Šimánek 2019-12-13 01:11:06 Re: REINDEX VERBOSE unknown option

Browse pgsql-www by date

  From Date Subject
Next Message Doanld 2019-12-16 10:41:11 Wiki editor request
Previous Message Jeremy Schneider 2019-12-12 22:07:14 wait event docs