Attention

This documentation pertains to older v2.x releases. Many features and functions have since been updated or replaced. Please refer to the current version for the latest information.

Welcome to pgwatch2’s documentation!

Contents:

• Introduction
  • Quick start with Docker
  • Typical “pull” architecture
  • Typical “push” architecture
• Project background
  • Project feedback
• List of main features
• Advanced features
  • Patroni support
  • Log parsing
  • PgBouncer support
  • Pgpool-II support
  • Prometheus scraping
  • AWS / Azure / GCE support
• Components
  • The metrics gathering daemon
  • Configuration store
  • Metrics storage DB
  • The Web UI
  • Metrics representation
  • Component diagram
  • Component reuse
• Installation options
  • Config DB based operation
  • File based operation
  • Ad-hoc mode
  • Prometheus mode
• Installing using Docker
  • Simple setup steps
  • More future proof setup steps
  • Available Docker images
  • Building custom Docker images
  • Interacting with the Docker container
  • Ports used
  • Docker Compose
• Custom installation
  • Config DB based setup
  • YAML based setup
  • Using InfluxDB for metrics storage
• Preparing databases for monitoring
  • Effects of monitoring
  • Basic preparations
  • Rolling out helper functions
  • Automatic rollout of helpers
  • PL/Python helpers
  • Notice on using metric fetching helpers
  • Running with developer credentials
  • Different DB types explained
• Monitoring managed cloud databases
  • Google Cloud SQL for PostgreSQL
  • Amazon RDS for PostgreSQL
  • Azure Database for PostgreSQL
  • Aiven for PostgreSQL
• Metric definitions
  • Defining custom metrics
  • Metric attributes
  • Column attributes
  • Adding metric fetching helpers
• The Admin Web UI
  • Web UI security
  • Exposing the component logs
• Dashboarding and alerting
  • Grafana intro
  • Alerting
• Sizing recommendations
• Technical details
• Security aspects
  • General security information
  • Launching a more secure Docker container
• Long term installations
  • Keeping inventory in sync
  • Updating the pgwatch2 collector
  • Metrics maintenance
  • Dashboard maintenance
  • Storage monitoring
• Upgrading
  • Updating to a newer Docker version
  • Updating without Docker
  • Updating Grafana
  • Updating Grafana dashboards
  • Updating the config / metrics DB version
  • Updating the pgwatch2 schema
  • Updating the metrics collector
  • Updating the Web UI
  • Updating metric definitions
• Kubernetes

Indices and tables

• Index

• Module Index

• Search Page