Monitoring

Instance monitoring can be handled by Prometheus, temBoard and/or PoWA.

Prometheus

Prometheus satellite component can be enabled through site settings by defining a prometheus key with at least execpath field set, e.g.:

settings.yaml

 prometheus:
   execpath: /usr/bin/prometheus-postgres-exporter

Note

See settings schema for further information about available configuration and their model.

Note

Prometheus postgres_exporter must be installed on the system.

A service for Prometheus postgres_exporter will be deployed at instance creation.

Command line interface

The postgres_exporter command line entry point exposes commands to start and stop the service, when bound to a local instance. It also provides installation commands to setup a postgres_exporter service on a remote host:

$ pglift postgres_exporter install dbserver "host=dbserver.example.com user=monitoring" 9188 --state=stopped --password
Password:
Repeat for confirmation:
$ pglift postgres_exporter start --foreground dbserver
INFO[0000] Established new database connection to "dbserver.example.com:5432".  source="postgres_exporter.go:878"
...
$ pglift postgres_exporter uninstall dbserver

Ansible module

The postgres_exporter module within dalibo.pglift collection is the main entry point for managing a postgres_exporter service for a non-local instance through Ansible.

Example task:

tasks:
  - dalibo.pglift.postgres_exporter:
      name: 13-main  # usually a reference to target instance
      dsn: "port=5455 host=dbserver.example.com role=monitoring"
      password: "m0n 1tor"
      port: 9871

temBoard

pglift provides support for temBoard (version 8 or higher).

This component can be enabled through site settings by defining a temboard key with at least ui_url, signing_key and certificate fields set, e.g.:

settings.yaml

 temboard:
    ui_url: https://temboardui.host:8888
    signing_key: /tmp/temboard/signing-public.pem
    certificate:
       ca_cert: /tmp/temboard/temboard-agent_ca.pem
       cert: /tmp/temboard/temboard-agent.pem
       key: /tmp/temboard/temboard-agent.key

Note

temBoard agent must be installed on the system.

The signing-public.pem key must be copied from the UI server to a local folder and specified in the signing_key parameter.

The ca_cert file may be omitted, as explain in temBoard agent documentation, it avoid verifying the certificate (not recommended).

The agent is configured automatically at instance creation. It must then be registered on the temBoard UI.

You can either use the temboard-agent register command or add new instance in temBoard UI.

Logging can be configured via site settings with logpath, logmethod and loglevel. By default logmethod is set to stderr. If file is selected, a logfile for each instance will be created in the logpath folder named temboard_agent_{qualname}.log. More information in temBoard agent logging documentation.

PoWA

In pglift, PoWA is meant to be used in Remote setup mode (ie. stats data collected from a remote server).

This component can be enabled through site settings by defining a non-null powa key, e.g.:

settings.yaml

 powa: {}

Note

PoWA archivist (ie. powa) and Stats Extensions (ie. pg_stat_kcache, pg_qualstats) must be installed (via packages) on the system.

The extensions for collecting stats for PoWA are configured and installed automatically at instance creation.

Once created the instance can be registered on the PoWA repository (created outside of pglift).