Date: Sat, 21 Dec 2019 17:46:35 -0500
From: Bruce Momjian <bruce@momjian.us>
To: Michael Paquier <michael@paquier.xyz>
Cc: Jeremy Schneider <schnjere@amazon.com>, pgsql-docs@lists.postgresql.org
Subject: Re: wait event docs
Message-ID: <20191221224635.GN11527@momjian.us>
References: <fead9c82-6b58-b40f-1846-9521b76310f5@amazon.com>
 <20191213065029.GF1942@paquier.xyz>
MIME-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20191213065029.GF1942@paquier.xyz>
User-Agent: Mutt/1.10.1 (2018-07-13)
Precedence: bulk

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@momjian.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 +