Improve comment about dropped entries in pgstat.c
authorMichael Paquier <michael@paquier.xyz>
Mon, 9 Dec 2024 05:35:39 +0000 (14:35 +0900)
committerMichael Paquier <michael@paquier.xyz>
Mon, 9 Dec 2024 05:35:39 +0000 (14:35 +0900)
commit001a537b83ec6e2ab8fa8af44458b0502c94dd5e
tree8f10f2166d22b18f6ffa55906d15069ac6112328
parent2d0152d6147bb7d12eb120b7e749a323bf91aa6e
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