diff --git a/doc/pgadmin-system-stats.png b/doc/pgadmin-system-stats.png new file mode 100644 index 00000000..523d4547 Binary files /dev/null and b/doc/pgadmin-system-stats.png differ diff --git a/doc/pgadmin.md b/doc/pgadmin.md index 77214d0e..8c103de2 100644 --- a/doc/pgadmin.md +++ b/doc/pgadmin.md @@ -16,3 +16,34 @@ }; } ``` + +## Guide + +### Visualize system statistics + +`pgAdmin` uses the functions exposed by [system_stats](https://github.com/EnterpriseDB/system_stats) [[postgresql]] extension to monitor the system metrics such as CPU, memory and disk information. Use this in your config: + +```nix +# In `perSystem.process-compose.` +{ + services.postgres."pg1" = { + enable = true; + extensions = exts: [ + exts.system_stats + ]; + # This creates the extensions for the `postgres` database, if you need it for a custom database, + # ensure to add the below script in `schemas` of the database of your choice under `initialDatabses`. + initialScript.before = '' + CREATE EXTENSION system_stats; + ''; + }; + services.pgadmin."pgad1" = { + enable = true; + initialEmail = "email@gmail.com"; + initialPassword = "password"; + }; +} +``` + +Open the pgAdmin dashboard, establish a connection with your database and you will see: +![[pgadmin-system-stats.png]]