pihace 0.9.0

Python Integrated Health Check - A modular and extensible health check system for services and system resources.

pihace

Python Integrated Health Check (pihace) is a modular and extensible Python library for system and service health monitoring. It helps you build consistent, informative, and developer-friendly health check endpoints or tools across your applications and infrastructure.

---

✨ Features

• ✅ Built-in system checks: CPU, memory, disk usage, Python version, OS
• 📦 Modular service checks: MySQL, MongoDB, InfluxDB, HTTP, and more
• 🧩 Custom check functions
• 📧 Providers buildin: HTTP Service
• 🧾 Diverse health output format
• 🐍 Pythonic API design
• 🔧 Extensible with easy register() method

---

📦 Installation

pip install pihace

🚀 Quick Start

from pihace.healthcheck import HealthCheck
from pihace.plugins.mysql import MySQL
from pihace.plugins.mongodb import MongoDB
from pihace.plugins.influxdb import InfluxDB
from pihace.plugins.http import HTTP

if __name__ == "__main__":
    hc = HealthCheck(with_system=True, name="example-api", version="v0.1.0")

    hc.register("MySQL A", MySQL(dsn="mysql://root:root@localhost:3306/testdb"), timeout=5, retries=2)
    hc.register("MongoDB B", MongoDB(dsn="mongodb://localhost:27017"))
    hc.register("InfluxDB C", InfluxDB(url="http://localhost:8086", token="admintoken", org="myorg"))
    hc.register("HTTP D", HTTP(url="https://example.com"))

    print(hc.check(output="str"))
    print(hc.check(output="json", pretty=True))
    print(hc.check())

---

🧪 Custom Health Check

def function_that_mock_failure():
    return (False, "something broke")

def function_that_mock_success():
    return True

healthcheck.register("Mock Fail", function_that_mock_failure)
healthcheck.register("Mock Success", function_that_mock_success)`

---

📤 Example Output

{
  "status": "Partially Available",
  "timestamp": "2023-07-01T14:59:55.711Z",
  "failure": {
    "MongoDB B": "authentication failed"
  },
  "rate": "2/3",
  "system": {
    "cpu_usage": "18%",
    "memory_usage": "32%",
    "disk_usage": "47%",
    "memory_available": "512MB",
    "python_version": "3.10",
    "os": "Windows 10"
  },
  "component": {
    "name": "something-api",
    "version": "v1.0.0"
  }
}

---

🔌 Supported Checkers

• ✅ MySQL

• ✅ MongoDB

• ✅ InfluxDB

• ✅ HTTP

• 🧩 Custom check functions

🔌 Supported Providers

• ✅ Web HTTP

More plugins and providers are coming soon!

---

🧰 Development

Clone this repository:

git clone https://github.com/ahmadzeinalwafi/pihace.git
cd pihace
pip install -e ".[dev]"`

Run tests:

python -m unittest

---

🐳 Docker Compose Example

Start a testing environment:

docker-compose up

---

📜 License

This project is licensed under the Apache License 2.0.

---

🤝 Contributing

Contributions are welcome! Please open an issue or PR to add new checkers, fix bugs, or suggest improvements on github.

---

📫 Author

Ahmad Zein Al Wafi
📧 [e-mail]
🔗 LinkedIn
🌍 Website

---