pghero Docker镜像文档

镜像概述和主要用途

pghero Docker镜像是基于PostgreSQL性能监控工具pghero构建的容器化部署方案，旨在简化PostgreSQL数据库性能监控的搭建流程。通过该镜像，用户无需手动配置依赖环境，可快速部署pghero服务，实现对PostgreSQL数据库的实时性能分析、查询监控及优化建议生成。

核心功能和特性

1. 查询性能分析：自动捕获并分析SQL查询执行时间、调用频率、锁等待等关键指标，识别性能瓶颈
2. 慢查询跟踪：记录执行时间超过阈值的慢查询，支持按时间范围、数据库表等维度筛选
3. 数据库健康监控：实时展示连接数、内存使用、表空间大小等数据库运行状态指标
4. 索引优化建议：基于查询 patterns 自动推荐缺失索引、冗余索引清理方案
5. 可视化报表：通过 Web 界面直观展示性能数据图表（如查询耗时趋势、热门表访问频率等）
6. 轻量级部署：容器化设计，支持单机部署或集成至现有Docker Compose架构

使用场景和适用范围

• 开发环境：辅助开发人员调试SQL性能问题，验证查询优化效果
• 生产环境：作为长期监控工具，跟踪数据库性能变化，预警潜在风险
• 运维场景：DBA用于批量分析多实例PostgreSQL性能，制定集群优化策略
• 适用对象：使用PostgreSQL的开发团队、数据库运维人员、需要优化数据库性能的技术团队

详细使用方法和配置说明

前置条件

• 已安装Docker Engine（20.10+）或Docker Desktop
• 目标PostgreSQL数据库（9.5+版本）可通过网络访问，且配置允许pghero连接（需开放权限或配置信任源）

Docker Run命令示例

通过以下命令快速启动pghero服务：

docker run -d \
  --name pghero \
  -p 3000:3000 \
  -e DATABASE_URL="postgres://user:password@postgres-host:5432/dbname?sslmode=require" \
  -e PORT=3000 \
  -e PGHERO_USERNAME="admin" \
  -e PGHERO_PASSWORD="secure-pass" \
  biow0lf/evemonk-pghero:latest

启动后，通过 http://localhost:3000 访问pghero Web界面，使用配置的PGHERO_USERNAME和PGHERO_PASSWORD登录。

Docker Compose配置示例

若需与PostgreSQL数据库联动部署，可使用以下docker-compose.yml配置：

version: '3.8'
services:
  pghero:
    image: biow0lf/evemonk-pghero:latest
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL="postgres://postgres:postgres@postgres:5432/mydb?sslmode=disable"  # 连接同一网络的PostgreSQL容器
      - PORT=3000
      - PGHERO_USERNAME="pghero-admin"
      - PGHERO_PASSWORD="your-strong-password"
    depends_on:
      - postgres  # 依赖PostgreSQL服务启动
    restart: unless-stopped

  postgres:
    image: postgres:15-alpine
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=mydb
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

环境变量配置说明

访问与验证

服务启动后，通过浏览器访问 http://<宿主机IP>:<PORT>（如http://localhost:3000），输入配置的PGHERO_USERNAME和PGHERO_PASSWORD（若启用认证）即可进入pghero控制台，查看数据库性能数据。

注意事项

1. 生产环境安全：生产环境中需启用PGHERO_USERNAME和PGHERO_PASSWORD认证，并限制访问IP（可通过Docker网络策略或反向代理实现）
2. 数据库权限：pghero连接用户需具备pg_stat_statements扩展权限（执行CREATE EXTENSION pg_stat_statements;），否则部分性能指标无法采集
3. 数据持久化：pghero自身无持久化数据（依赖PostgreSQL的pg_stat_statements等系统表），无需额外挂载卷