Background worker for monitoring PostgreSQL
bg_mon is a contrib module compatible with PostgreSQL starting from version 9.3
It collects per-process statistics combined with
pg_stat_activity for the processes that have the rows there, global system stats, per-partition information and the memory stats.
By default webserver listen on
127.0.0.1:8080 and statistics is collected every second. Optionally, if compiled with libbrotli, the worker will keep statistics in the aggregated format for the past
history_buckets minutes in memory. Brotli compression is used because the compression ratio is very efficient and most of the modern browsers support it out of the box.
List of available GUC variables
bg_mon.listen_address = '0.0.0.0' # listen on all available interfaces (default value: 127.0.0.1)
bg_mon.port = 8888 # listen on port 8888 (default value: 8080)
bg_mon.naptime = 10 # collect statistics every 10 seconds (default value: 1)
bg_mon.history_buckets = 60 # keep one-minute aggregated statistics in memory for 60 minutes (default value: 20)
How to build and install:
- You have to install
- $ USE_PGXS=1 make
- $ sudo USE_PGXS=1 make install
How to run it:
shared_preload_libraries = 'bg_mon'to your postgresql.conf
- If you want to change default values of
bg_mon.history_buckets- just add them to the postgresql.conf
- restart postgresql
If you did everything right, go to you browser and type following URLs to see results:
http://<bg_mon.listen_address>:<bg_mon.port>/ -- expose collected statistics in a JSON format.
http://<bg_mon.listen_address>:<bg_mon.port>/X -- get aggregated statistics from the bucket X, where X is between 0 and history_buckets. The array with the current bucket might be not yet closed.
http://<bg_mon.listen_address>:<bg_mon.port>/ui -- simple web page which fetches statistics from server every second and renders it in a simple html format.