[+] add pgwatch2-scalefield Docker image (#732)

---------
Co-authored-by: Pavlo Golub <[email protected]>

Author: yanchenko-igor

.github/workflows/docker.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        image: ['-postgres', '-daemon', '-db-bootstrapper', '-webui']        
+        image: ['-postgres', '-daemon', '-db-bootstrapper', '-webui', '-scalefield']
     runs-on: ubuntu-latest
     steps:
 

build-docker-scalefield.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker build --no-cache --build-arg GIT_TIME=`git show -s --format=%cI HEAD` --build-arg GIT_HASH=`git show -s --format=%H HEAD` -t cybertec/pgwatch2-scalefield:latest -f docker/Dockerfile-scalefield .

docker-launcher-scalefield.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+export USER=${DATA_SOURCE_USER:-postgres}
+export PASSWORD=${DATA_SOURCE_PASS:-postgres}
+export NAME=${DATA_SOURCE_URI:-localhost}
+export CLUSTERNAME=${DATA_SOURCE_CLUSTER:-localhost}
+export CUSTOMER=${PG_EXPORTER_CONSTANT_LABEL_CUSTOMER:-customer}
+export CLUSTER_NAME=${PG_EXPORTER_CONSTANT_LABEL_CLUSTER_NAME:-cluster_name}
+export SUPPORT_PLAN=${PG_EXPORTER_CONSTANT_LABEL_SUPPORT_PLAN:-support_plan}
+
+cat /pgwatch2/config/scalefield.template | sed "s/%USER%/$USER/;s/%PASSWORD%/$PASSWORD/;s/%NAME%/$NAME/;s/%CUSTOMER%/$CUSTOMER/;s/%CLUSTER_NAME%/$CLUSTER_NAME/;s/%SUPPORT_PLAN%/$SUPPORT_PLAN/" > /pgwatch2/config/scalefield.yaml
+
+/pgwatch2/metrics/00_helpers/rollout_helper.py --mode single-db --host "$CLUSTERNAME" --dbname postgres --user "$USER" --password "$PASSWORD" --monitoring-user "$USER" --confirm --metrics-path /pgwatch2/metrics/00_helpers/ --helpers get_load_average,get_psutil_cpu,get_psutil_disk_io_total,get_psutil_disk,get_psutil_mem --excluded-helpers ""
+
+exec /pgwatch2/pgwatch2 -c /pgwatch2/config/scalefield.yaml --adhoc-create-helpers=true --prometheus-port=9189 --datastore=prometheus

docker/Dockerfile-scalefield

@@ -0,0 +1,35 @@
+FROM golang:1.21
+
+# For showing Git version via 'pgwatch2 --version'
+ARG GIT_HASH
+ARG GIT_TIME
+ENV GIT_HASH=${GIT_HASH}
+ENV GIT_TIME=${GIT_TIME}
+
+ADD pgwatch2 /pgwatch2
+RUN cd /pgwatch2 && bash build_gatherer.sh
+
+
+FROM ubuntu:22.04
+
+RUN apt-get -q update && apt-get -qy install wget git python3 python3-psycopg2 python3-yaml && apt autoremove -y && mkdir /pgwatch2
+
+ADD pgwatch2/metrics /pgwatch2/metrics
+ADD pgwatch2/config /pgwatch2/config
+ADD docker-launcher-scalefield.sh /pgwatch2/entrypoint.sh
+RUN chmod +x /pgwatch2/entrypoint.sh
+
+# Copy over the compiled gatherer
+COPY --from=0 /pgwatch2/pgwatch2 /pgwatch2
+
+RUN chgrp -R 0 /pgwatch2 \
+    && chmod -R g=u /pgwatch2
+
+# pgwatch2 internal status endpoint
+EXPOSE 8081
+# Prometheus metrics scraping port
+EXPOSE 9189
+
+USER 10001
+
+ENTRYPOINT ["/pgwatch2/entrypoint.sh"]

pgwatch2/config/scalefield.template

@@ -0,0 +1,24 @@
+- unique_name: %NAME%
+  dbtype: postgres
+  host: 127.0.0.1
+  dbname: postgres
+  user: %USER%
+  password: %PASSWORD%
+  sslmode: require    # supported options: disable, require, verify-ca, verify-full
+  stmt_timeout: 5 # in seconds
+  is_superuser: true
+  preset_metrics: remotedba
+  custom_metrics:    # if both preset and custom are specified, custom wins
+  preset_metrics_standby: # optional metrics configuration for standby / replica state, v1.8.1+
+  custom_metrics_standby:
+  dbname_include_pattern: # regex to filter databases to actually monitor for the "continuous" modes
+  dbname_exclude_pattern:
+  is_enabled: true
+  custom_tags:
+    support_plan: %SUPPORT_PLAN%
+    customer: %CUSTOMER%
+    cluster_name: %CLUSTER_NAME%
+  group: default # just for logical grouping of DB hosts or for "sharding", i.e. splitting the workload between many gatherer daemons
+  sslrootcert: ''
+  sslcert: ''
+  sslkey: ''

pgwatch2/metrics/preset-configs.yaml

@@ -350,3 +350,31 @@
     table_stats: 300
     wal: 60
     wal_receiver: 120
+
+- name: remotedba
+  description: Metrics used for monitoring of Remote-DBA Databases
+  metrics:
+    kpi: 120
+    wal: 60
+    locks: 60
+    db_size: 300
+    archiver: 60
+    backends: 60
+    bgwriter: 60
+    cpu_load: 60
+    db_stats: 60
+    settings: 7200
+    wal_size: 300
+    locks_mode: 60
+    index_stats: 900
+    replication: 120
+    sproc_stats: 180
+    table_stats: 300
+    wal_receiver: 120
+    change_events: 300
+    table_io_stats: 600
+    sequence_health: 3600
+    replication_slots: 120
+    psutil_cpu: 120
+    psutil_mem: 120
+    psutil_disk: 120