GeoHealthCheck

Overview

GeoHealthCheck (GHC) is a Python application to support monitoring OGC services uptime, availability and Quality of Service (QoS).

GHC can be used to monitor overall health of OGC services (OWS) like WMS, WFS, WCS, WMTS, SOS, CSW and more, plus some recent OGC APIs like SensorThings API and WFS v3 (OGC Features API). But also standard web REST APIs and ordinary URLs can be monitored.

Features

• lightweight (Python with Flask)

• easy setup

• support for numerous OGC resources

• flexible and customizable: look and feel, scoring matrix

• user management

• database agnostic: any SQLAlchemy supported backend

• database upgrades: using Alembic with Flask-Migrate

• extensible healthchecks via Plugins

• per-resource scheduling and notifications

• per-resource HTTP-authentication like Basic, Token (optional)

• regular status summary report via email (optional)

Links

• website: http://geohealthcheck.org

• GitHub: https://github.com/geopython/geohealthcheck

• Demo: https://demo.geohealthcheck.org (official demo, master branch)

• Presentation: http://geohealthcheck.org/presentation

• Gitter Chat: https://gitter.im/geopython/GeoHealthCheck

This document applies to GHC version 0.8.3 and was generated on Apr 30, 2021. The latest version is always available at http://docs.geohealthcheck.org.

Contents:

• 1. Installation
  • 1.1. Docker
  • 1.2. Requirements
  • 1.3. Install
  • 1.4. Upgrade
  • 1.5. Running
  • 1.6. Running under a sub-path
  • 1.7. Production Recommendations
• 2. Configuration
  • 2.1. Configuration Parameters
  • 2.2. Email Configuration
  • 2.3. Healthcheck Scheduling
  • 2.4. Language Translations
  • 2.5. Customizing the Score Matrix
  • 2.6. Securing GHC Webapp
• 3. Administration
  • 3.1. Database
  • 3.2. User Management
  • 3.3. Build Documentation
• 4. User Guide
  • 4.1. Terminology
  • 4.2. Registration
  • 4.3. Home Screen
  • 4.4. Adding Resources
  • 4.5. Editing Resources
  • 4.6. Deleting Resources
  • 4.7. Tagging
  • 4.8. Failure Analysis
  • 4.9. Per-Resource Notifications
  • 4.10. GeoNode Resource Type
  • 4.11. GeoHealthCheck Reporter Type
  • 4.12. Resource Authentication
• 5. Architecture
  • 5.1. Core Concepts
  • 5.2. Data Model
  • 5.3. GHC Webapp Design
  • 5.4. GHC Runner Design
• 6. Plugins
  • 6.1. Concepts
  • 6.2. Implementation
  • 6.3. Examples
  • 6.4. Configuration
  • 6.5. User Plugins via Docker
  • 6.6. Plugin API Docs
• 7. License
• 8. Contact
  • 8.1. Links

Indices and tables

• Index

• Module Index

• Search Page