Improve comment about dropped entries in pgstat.c
authorMichael Paquier <michael@paquier.xyz>
Mon, 9 Dec 2024 05:35:46 +0000 (14:35 +0900)
committerMichael Paquier <michael@paquier.xyz>
Mon, 9 Dec 2024 05:35:46 +0000 (14:35 +0900)
commitec194b448cbc7f9fe2204cdb7690eb4c21a46d8e
tree7edff574e4ca51a6b7d6ef4cf267018486892d73
parentae77bcc3aa1b869568c6b01726e4f1276f7381bb
Improve comment about dropped entries in pgstat.c

pgstat_write_statsfile() discards any entries marked as dropped from
being written to the stats file at shutdown, and also included an
assertion based on the same condition.

The intention of the assertion is to track that no pgstats entries
should be left around as terminating backends should drop any entries
they still hold references on before the stats file is written by the
checkpointer, and it not worth taking down the server in this case if
there is a bug making that possible.

Let's improve the comment of this area to document clearly what's
intended.

Based on a discussion with Bertrand Drouvot and Anton A. Melnikov.

Author: Bertrand Drouvot
Discussion: https://postgr.es/m/a13e8cdf-b97a-4ecb-8f42-aaa367974e29@postgrespro.ru
Backpatch-through: 15
src/backend/utils/activity/pgstat.c