cybertecpostgresql/pgwatch

cybertecpostgresql/pgwatch 镜像文档

镜像概述与主要用途

cybertecpostgresql/pgwatch 是一个用于 PostgreSQL 监控工具 pgwatch 的 Docker 镜像。该镜像基于 pgwatch 项目构建，提供了预配置的部署方案，旨在简化 PostgreSQL 数据库的监控流程，支持指标收集、可视化展示及多实例管理，是一款轻量高效的 PostgreSQL 指标监控与仪表板工具。

核心功能与特性

• 全面监控能力：跟踪 PostgreSQL 数据库的各类核心指标，包括连接数、查询性能、资源使用率、锁状态等。
• 可定制仪表板：与 Grafana 深度集成，支持自定义监控仪表板，提供直观的可视化监控数据展示。
• 多实例扩展支持：具备良好的可扩展性，可同时监控多个 PostgreSQL 实例，适应复杂部署环境。
• 简化部署流程：提供预配置的容器化方案，减少手动配置步骤，降低部署门槛。
• Prometheus 集成：支持 Prometheus 从统一端点抓取监控指标，便于接入现有监控体系。

使用场景与适用范围

• 企业级 PostgreSQL 监控：适用于生产环境中对 PostgreSQL 数据库稳定性、性能的实时监控需求。
• 多实例管理场景：需同时监控多个 PostgreSQL 实例（如主从架构、分布式部署）的环境。
• 可视化监控需求：需要通过直观仪表板展示数据库运行状态、趋势分析的场景。
• Prometheus 监控架构：已采用 Prometheus 作为核心监控系统，需扩展 PostgreSQL 指标采集能力的场景。

使用方法

Docker Run 命令示例

通过 docker run 快速启动容器（基础配置）：

bash
docker run -d \
  --name pgwatch \
  -p 8080:8080 \  # Grafana 端口（默认）
  -p 9090:9090 \  # Prometheus 端口（默认）
  -e PGWATCH_TARGET_DB_HOST=your-postgres-host \
  -e PGWATCH_TARGET_DB_PORT=5432 \
  -e PGWATCH_TARGET_DB_USER=postgres \
  -e PGWATCH_TARGET_DB_PASSWORD=your-password \
  -e PGWATCH_TARGET_DB_NAME=postgres \
  cybertecpostgresql/pgwatch

注：上述命令为基础示例，实际部署需根据目标环境调整端口映射及环境变量。

Docker Compose 配置示例

推荐使用 docker-compose 管理容器，以下为典型配置（含 Grafana、Prometheus 集成）：

yaml
version: '3.8'

services:
  pgwatch:
    image: cybertecpostgresql/pgwatch
    container_name: pgwatch
    ports:
      - "8080:8080"  # Grafana Web 端口
      - "9090:9090"  # Prometheus 端口
      - "5000:5000"  # pgwatch 指标暴露端口
    environment:
      # 目标 PostgreSQL 实例配置
      - PGWATCH_TARGET_DB_HOST=postgres-instance-1
      - PGWATCH_TARGET_DB_PORT=5432
      - PGWATCH_TARGET_DB_USER=monitor_user
      - PGWATCH_TARGET_DB_PASSWORD=secure_password
      - PGWATCH_TARGET_DB_NAME=app_db
      # 监控频率配置（单位：秒）
      - PGWATCH_SCRAPE_INTERVAL=60
      # Grafana 配置
      - PGWATCH_GRAFANA_ADMIN_USER=admin
      - PGWATCH_GRAFANA_ADMIN_PASSWORD=grafana_admin_pass
    volumes:
      - pgwatch_data:/var/lib/pgwatch  # 持久化监控数据
    restart: unless-stopped

volumes:
  pgwatch_data:

完整配置示例可参考 https://github.com/cybertec-postgresql/pgwatch/tree/master/docker%E3%80%82

配置说明

环境变量配置

容器支持通过环境变量调整核心配置，常用参数如下：

更多环境变量配置可参考 pgwatch 官方文档。

配置文件配置

对于复杂场景，可通过挂载配置文件实现精细化配置。容器默认配置文件路径为 /etc/pgwatch/config.yml，支持自定义指标采集规则、仪表板模板等。配置文件示例及说明可参考 https://github.com/cybertec-postgresql/pgwatch%E3%80%82

支持与反馈

如遇部署或使用问题，可通过以下渠道获取支持：

• GitHub issues：https://github.com/cybertec-postgresql/pgwatch/issues
• 官方文档：[***]