Проверить health-эндпоинты API
Проверяет список health-URL, повторяет неудачные попытки и считает задержку.
Что делает скрипт
Скрипт принимает адреса из аргументов или файла, делает несколько попыток с паузой и считает код ответа и время. Успехом считается любой код 2xx, иначе проверка помечается как сбой. Итоговая таблица помогает быстро понять, какой сервис не отвечает.
Быстрый старт
python api_health.py http://127.0.0.1:8000/health
Скачайте файл, откройте терминал в папке со скриптом и выполните команду.
В Linux и macOS интерпретатор может называться python3, в Windows - python или py.
Другие варианты
python api_health.py http://127.0.0.1:8000/health http://127.0.0.1:8000/readypython api_health.py --file endpoints.txt --retries 3 --json report.json
Что понадобится
winget install Python.Python.3.12
brew install python
sudo apt install python3
api_health.py
#!/usr/bin/env python3
"""Проверка health-эндпоинтов с повторами."""
from __future__ import annotations
import argparse
import json
import time
from pathlib import Path
from urllib.error import HTTPError, URLError
from urllib.request import Request, urlopen
def load_endpoints(args: argparse.Namespace) -> list[tuple[str, str]]:
endpoints = [(url, url) for url in args.url]
if args.file:
if not args.file.is_file():
raise SystemExit(f"Файл не найден: {args.file}")
for line in args.file.read_text(encoding="utf-8").splitlines():
line = line.strip()
if not line or line.startswith("#"):
continue
if " " in line or "\t" in line:
name, url = line.split(None, 1)
else:
name, url = line, line
endpoints.append((name, url.strip()))
return endpoints
def check(url: str, timeout: float) -> tuple[int | None, float, str]:
request = Request(url, headers={"Accept": "application/json", "User-Agent": "popovdev-scriptdock/1.0"})
started = time.perf_counter()
try:
with urlopen(request, timeout=timeout) as response:
response.read(65536)
return response.status, (time.perf_counter() - started) * 1000, ""
except HTTPError as error:
error.read(65536)
return error.code, (time.perf_counter() - started) * 1000, str(error.reason)
except URLError as error:
return None, (time.perf_counter() - started) * 1000, str(error.reason)
def main() -> int:
parser = argparse.ArgumentParser(description="Проверить health-эндпоинты")
parser.add_argument("url", nargs="*", help="Адреса health-эндпоинтов")
parser.add_argument("--file", type=Path, help="Файл со строками name url")
parser.add_argument("--retries", type=int, default=2)
parser.add_argument("--delay", type=float, default=1.0, help="Пауза между попытками")
parser.add_argument("--timeout", type=float, default=5.0)
parser.add_argument("--json", type=Path, help="Сохранить отчёт")
args = parser.parse_args()
endpoints = load_endpoints(args)
if not endpoints:
parser.error("Укажите хотя бы один URL или --file")
results = []
failed = 0
print(f"{'Сервис':<24} {'Статус':<8} {'Время':>8} Итог")
for name, url in endpoints:
status = None
elapsed = 0.0
detail = ""
for attempt in range(1, args.retries + 1):
status, elapsed, detail = check(url, args.timeout)
if status is not None and 200 <= status < 300:
break
if attempt < args.retries:
time.sleep(args.delay)
ok = status is not None and 200 <= status < 300
if not ok:
failed += 1
shown = str(status) if status is not None else "нет"
print(f"{name[:24]:<24} {shown:<8} {elapsed:>6.0f} мс {'ok' if ok else 'fail'}")
results.append({"name": name, "url": url, "status": status, "ms": round(elapsed), "ok": ok, "detail": detail})
if args.json:
args.json.write_text(json.dumps(results, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
print(f"Отчёт: {args.json}")
return 0 if failed == 0 else 1
if __name__ == "__main__":
raise SystemExit(main())
Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.