Installation

pgmetrics is distributed as a single, dependency-free binary. There is no installation procedure as such, other than copying the binary to somewhere in your $PATH. There are no configuration files. It is meant to be invoked and used like psql.

pgmetrics can be downloaded from the releases page on GitHub. Here are a set of commands to get the 1.17.0 release tarball for Linux:

wget https://github.com/rapidloop/pgmetrics/releases/download/v1.17.0/pgmetrics_1.17.0_linux_amd64.tar.gz
tar xvf pgmetrics_1.17.0_linux_amd64.tar.gz
cd pgmetrics_1.17.0_linux_amd64
./pgmetrics --help

Docker

pgmetrics can be built as a Docker image with:

docker build -t pgmetrics:1.17.0 https://github.com/rapidloop/pgmetrics.git#v1.17.0

FreeBSD

pgmetrics is available for FreeBSD as the port databases/pgmetrics, maintained by Palle Girgensohn. You can install it with:

pkg install pgmetrics

or build and install using portsnap:

portsnap fetch update
cd /usr/ports/database/pgmetrics
make install

Windows

pgmetrics is available as a Chocolatey package for Windows here: pgmetrics. It is maintained by Miodrag Milić. You can install the package with:

choco install pgmetrics

Other platforms

Pre-built binaries are also available from GitHub for:

  • Mac OS: Intel, M1
  • Linux: amd64, ARMv6, ARMv8
  • Windows: amd64