classic-health-checks 0.0.1__py3-none-any.whl

classic/health_checks/__init__.py

@@ -0,0 +1,2 @@
+from .health_check import HealthCheck
+from .settings import HealthCheckSettings, HealthCheckSettingsMixin

classic/health_checks/health_check.py

@@ -0,0 +1,46 @@
+import time
+from logging import Logger
+from pathlib import Path
+
+from .settings import HealthCheckSettingsMixin
+
+
+class HealthCheck:
+    """
+    Задача для выполнения проверки работоспособности путем обновления
+    временной метки файла.
+
+    Этот класс реализует простую проверку жизнеспособности (liveness probe).
+    При запуске метода `run` он периодически обновляет указанный файл
+    в файловой системе. Внешняя система мониторинга может отслеживать
+    время последнего изменения этого файла, чтобы убедиться, что сервис
+    активен и не завис.
+
+    Аргументы:
+        logger: Экземпляр стандартного логгера для вывода отладочных сообщений.
+        settings: Объект конфигурации с параметрами для проверки.
+    """
+
+    def __init__(
+        self,
+        logger: Logger,
+        settings: HealthCheckSettingsMixin,
+    ) -> None:
+        self.logger = logger
+        self.filepath = Path(settings.HEALTHCHECK_FILE_PATH)
+        self.interval = settings.HEALTHCHECK_INTERVAL
+        self.filepath.parent.mkdir(parents=True, exist_ok=True)
+
+    def run(self) -> None:
+        """
+        Запускает бесконечный цикл проверки работоспособности.
+
+        Этот метод выполняет бесконечный цикл, в котором:
+        1. Обновляет временную метку файла проверки.
+        2. Приостанавливает выполнение на заданный интервал.
+        3. Логирует отладочное сообщение.
+        """
+        while True:
+            self.filepath.touch()
+            time.sleep(self.interval)
+            self.logger.debug('Healthcheck file written')

classic/health_checks/settings.py

@@ -0,0 +1,18 @@
+from pydantic_settings import BaseSettings
+
+
+class HealthCheckSettingsMixin:
+    """
+    Настройки конфигурации для задачи проверки работоспособности.
+
+    Эти настройки могут быть загружены из переменных окружения или .env файла.
+    """
+    HEALTHCHECK_FILE_PATH: str
+    """Путь к файлу, используемому для проверки работоспособности."""
+
+    HEALTHCHECK_INTERVAL: float = 10.0
+    """Интервал в секундах между обновлениями файла проверки."""
+
+
+class HealthCheckSettings(HealthCheckSettingsMixin, BaseSettings):
+    pass

classic_health_checks-0.0.1.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: classic-health-checks
+Version: 0.0.1
+Summary: Simple health-checks
+Author-email: Sergei Variasov <variasov@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/variasov/classic-health-checks
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build~=1.2.2.post1; extra == "dev"
+Requires-Dist: pytest==8.3.4; extra == "dev"
+Requires-Dist: pytest-cov==6.0.0; extra == "dev"
+Requires-Dist: isort==6.0.0; extra == "dev"
+Requires-Dist: yapf==0.43.0; extra == "dev"
+Requires-Dist: flake8==7.1.1; extra == "dev"
+Requires-Dist: Flake8-pyproject==1.2.3; extra == "dev"
+Dynamic: license-file
+
+# Classic Health Checks
+
+[![PyPI version](https://badge.fury.io/py/classic-health-checks.svg)](https://badge.fury.io/py/classic-health-checks)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Простая реализация проверки работоспособности сервиса (liveness probe) через обновление временной метки файла.
+
+Этот пакет предоставляет задачу, которая может быть запущена в отдельном потоке или гринлете для периодического обновления файла на диске. Внешние системы мониторинга, такие как Kubernetes или systemd, могут отслеживать время последнего изменения этого файла, чтобы убедиться, что сервис активен и не завис.
+
+## Установка
+
+```bash
+pip install classic-health-checks
+```
+
+## Использование (Usage)
+
+Вот минимальный пример использования `HealthCheck` в отдельном потоке.
+
+
+### Использование с `gevent`
+
+Для использования с `gevent` убедитесь, что он установлен:
+```bash
+pip install gevent
+```
+
+`HealthCheck` легко интегрируется с `gevent`. Инициализируем и запускаем run в гринлете.
+```python
+import gevent
+from gevent.monkey import patch_all
+
+patch_all()
+
+import logging
+from pydantic_settings import BaseSettings
+from classic.health_checks import HealthCheck, HealthCheckSettingsMixin
+
+# Настройте базовый логгер
+logging.basicConfig(
+    level=logging.DEBUG,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+)
+logger = logging.getLogger(__name__)
+
+class AppSettings(HealthCheckSettingsMixin, BaseSettings):
+   ...
+
+settings = AppSettings(HEALTHCHECK_FILE_PATH='/tmp/healthcheck')
+
+# 1. Создаем экземпляр
+
+health_check = HealthCheck(
+    logger=logger,
+    settings=settings,
+)
+
+# 2. Запускаем HealthCheck и другие задачи в своих гринлетах
+
+# Псевдо-задачи для примера
+class LongRunningTask:
+    def __init__(self, name: str):
+        self.name = name
+    def run(self):
+        logger.info(f"Задача '{self.name}' запущена.")
+        while True:
+            gevent.sleep(60)
+
+task1 = LongRunningTask("Обработчик сообщений")
+task2 = LongRunningTask("Сборщик метрик")
+
+all_greenlets = [
+    gevent.spawn(health_check.run),
+    gevent.spawn(task1.run),
+    gevent.spawn(task2.run),
+]
+
+logger.info(f"Запущено {len(all_greenlets)} гринлетов, включая HealthCheck.")
+
+# 3. Ожидаем завершения всех задач и обрабатываем остановку
+try:
+    gevent.joinall(all_greenlets, raise_error=True)
+except (KeyboardInterrupt, SystemExit):
+    logger.info("Получен сигнал остановки, завершаем все гринлеты...")
+    gevent.killall(all_greenlets)
+    logger.info("Приложение остановлено.")
+
+```
+
+> **Подсказка:** "Сигнал остановки" обычно отправляется нажатием `Ctrl+C` в терминале, где запущен скрипт.
+
+### Интеграция с Kubernetes
+
+Вы можете использовать этот механизм для настройки `livenessProbe` в вашем Helm-чарте:
+
+```yaml
+# ... внутри spec.template.spec.containers[]
+# Добавляем переменную окружения, чтобы она была доступна в livenessProbe
+env:
+- name: HEALTHCHECK_FILE_PATH
+  value: /tmp/my_app_healthy
+  
+  
+envsFromSecret:
+  secret-envs:
+    ...
+livenessProbe:
+  exec:
+    command:
+    - /bin/sh
+    - -c
+    - "[ $(($(date +%s) - $(stat -c %Y $HEALTHCHECK_FILE_PATH))) -le 10 ]"
+  periodSeconds: 10
+  initialDelaySeconds: 30
+  failureThreshold: 3
+```

classic_health_checks-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+classic/health_checks/__init__.py,sha256=T5w_I9QTG8iAt91UCUhDyGTUY7QZ92nvEEHC9-moGHo,106
+classic/health_checks/health_check.py,sha256=w3zUt7uSL61O-GKsipyLUJnpgxOQF7Q3YwTmOY9nbMg,2137
+classic/health_checks/settings.py,sha256=AINmmz9EUo-w8Q8xT4LMbuvJk_0AO0g4K6wQWFw6Iy8,735
+classic_health_checks-0.0.1.dist-info/licenses/LICENSE,sha256=NJlZYf1BWmSV82IG29S9QdVpNjUsMMIeMwAtJpkkU9w,1071
+classic_health_checks-0.0.1.dist-info/METADATA,sha256=1Jpn-08_ebaOePLl7FgLPsN5r3St-bxXsAvyNYs2OYk,5016
+classic_health_checks-0.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+classic_health_checks-0.0.1.dist-info/top_level.txt,sha256=NGd9e95FycaETli7Cs0MwFTtdjK6EYJ3tq_ErbSLNZg,8
+classic_health_checks-0.0.1.dist-info/RECORD,,

classic_health_checks-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

classic_health_checks-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sergei Variasov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

classic_health_checks-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+classic