geopython/geohealthcheck

GeoHealthCheck Docker镜像文档

镜像概述和主要用途

GeoHealthCheck (GHC) 是一款针对OGC Web服务和通用Web API的服务状态及服务质量（QoS）检查工具。该Docker镜像旨在简化GHC的部署流程，帮助用户快速搭建服务监控系统，实现对目标服务可用性和性能的持续跟踪。

核心功能和特性

• 多类型服务监控：支持OGC Web服务（如WMS、WFS等）和各类Web API的状态检查
• QoS评估能力：不仅监控服务是否可用，还能评估服务质量指标
• 灵活配置选项：允许自定义数据库连接、数据保留策略、系统标题等参数
• Web管理界面：提供直观的Web应用界面，便于查看监控结果和管理检查任务
• 可分离架构：支持Web服务器与检查任务调度器独立运行，适应不同部署需求

使用场景和适用范围

• OGC服务提供商：监控自有WMS、WFS等地理空间服务的运行状态
• API服务管理员：跟踪Web API的可用性和响应性能
• 系统运维团队：确保关键业务服务持续稳定运行
• 开发测试环境：验证服务在开发和测试阶段的质量表现

使用方法和配置说明

推荐部署方式

运行GHC最简单的方式是使用Docker，详细使用指南参见https://github.com/geopython/GeoHealthCheck/blob/master/docker/README.md%E3%80%82

手动安装步骤（Unix-based系统）

以下是在macOS或Linux系统上的手动安装流程：

bash
# 创建并激活虚拟环境
virtualenv GeoHealthCheck && cd $_
. bin/activate

# 克隆代码仓库
git clone https://github.com/geopython/GeoHealthCheck.git
cd GeoHealthCheck

# 安装依赖工具
pip install Paver

# 执行安装设置
paver setup

# 生成应用密钥
paver create_secret_key

# 配置本地设置（覆盖默认配置）
vi instance/config_site.py
# 至少需配置以下参数（复制paver create_secret_key的输出结果）：
# - SECRET_KEY  # 应用密钥

# 可选配置参数（根据需求调整）：
# - SQLALCHEMY_DATABASE_URI  # 数据库连接URI
# - GHC_RETENTION_DAYS       # 数据保留天数
# - GHC_SELF_REGISTER        # 是否允许自注册服务
# - GHC_RUNNER_IN_WEBAPP     # 是否在Web应用中内置调度器
# - GHC_ADMIN_EMAIL          # 管理员邮箱
# - GHC_SITE_TITLE           # 网站标题
# - GHC_MAP                  # 地图配置（可使用默认值）

# 初始化数据库和超级用户（交互式操作）
paver create

# 启动Web服务器（默认地址0.0.0.0:8000，含内置调度器）
python GeoHealthCheck/app.py
# 或指定端口
python GeoHealthCheck/app.py 0.0.0.0:8881
# 或指定IP和端口
python GeoHealthCheck/app.py 192.168.0.105:8001

# 独立运行模式（Web服务器与调度器分离）
vi instance/config_site.py
# 设置 GHC_RUNNER_IN_WEBAPP = False
# 启动调度器后台进程
python GeoHealthCheck/scheduler.py & 
# 启动Web服务器
python GeoHealthCheck/app.py  

常用管理命令

bash
# 删除数据库
python GeoHealthCheck/models.py drop

# 加载数据到数据库（警告：会删除现有数据！）
# 数据文件示例位于tests/data目录
python GeoHealthCheck/models.py load <.json数据文件> [y/n]

核心配置参数说明

更多详细信息参见完整GHC文档。