Getting started

Getting started with pgSCV.

TLDR: download and run pgSCV, scrape metrics with cURL.

1. Go to releases page and select latest release, for example v0.9.6. Copy url of .tar.gz archive from assets section.

2. Go to the server and download and unpack archive using cURL utility.

curl -s -L https://github.com/cherts/pgscv/releases/download/v0.9.6/pgscv_0.9.6_linux_$(uname -m).tar.gz -o - | tar xzf - -C /usr/sbin pgscv

3. Create config file where you need to specify credentials for connecting to PostgreSQL.

cat << EOF > /etc/pgscv.yaml
services:
  "postgres:5432":
    service_type: "postgres"
    conninfo: "postgres://postgres:supersecretpassword@127.0.0.1:5432/postgres"
EOF

Instead of postgres user you could use other user.

4. Run pgSCV

/usr/sbin/pgscv --config-file=/etc/pgscv.yaml

You should see no error. After startup pgSCV connecting to PostgreSQL service using provided credentials.

5. Open the second terminal and check metrics

curl -s 127.0.0.1:9890/metrics

You should see metrics in Prometheus format.