Skip to content

Commit

Permalink
docs(pgadmin): system_stats postgres extension
Browse files Browse the repository at this point in the history
  • Loading branch information
shivaraj-bh committed Jun 25, 2024
1 parent fb6de01 commit f276f59
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
Binary file added doc/pgadmin-system-stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions doc/pgadmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<name>`
{
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 protected]";
initialPassword = "password";
};
}
```

Open the pgAdmin dashboard, establish a connection with your database and you will see:
![[pgadmin-system-stats.png]]

0 comments on commit f276f59

Please sign in to comment.