Files
mtusi2026lab3/openspec/specs/health/spec.md
T
ricoromaandClaude Opus 5.5 af4bca08c9 feat: carry lab 2 over and add X-Instance-Id and idempotency keys
- carry the lab 2 solution over and plan lab 3 (PLAN.md, OpenSpec
  change instance-id-idempotency)
- rename the compose project to mtusi-lab3 and the image to :lab3
- add X-Instance-Id to every response and instance_id to every log
  record ([app] instance_id, hostname by default)
- require Idempotency-Key on POST messages: keys table in Postgres,
  key and message in one transaction, replay returns the same 201,
  another body gets 409, TTL from [idempotency] ttl_seconds
- send the key from student-tests, k6 scenarios and the skill driver;
  add idempotency, X-Instance-Id, key race and fault tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 19:42:36 +03:00

3.0 KiB
Raw Blame History

health Specification

Purpose

Проверки жизни и готовности сервиса для оператора, healthcheck контейнера и публичного smoke: жив ли процесс и можно ли направлять на него трафик.

Requirements

Requirement: Liveness

GET /health/live SHALL отвечать 200 с телом {"status": "ok"}, пока процесс обслуживает HTTP. Проверка MUST NOT требовать идентификации и MUST NOT зависеть от состояния хранилища.

Scenario: Процесс жив

  • WHEN клиент запрашивает GET /health/live без заголовков
  • THEN ответ 200, тело {"status": "ok"}, есть X-Request-Id

Requirement: Readiness

GET /health/ready SHALL отвечать 200 с телом {"status": "ok"}, когда сервис может безопасно обслуживать обязательные запросы, и 503 с code unavailable в формате ошибки, когда не может. На лабе 2 критичная зависимость — PostgreSQL: проверка SHALL выполнять запрос к нему с коротким таймаутом при каждом обращении. Valkey — кэш, без него обязательные запросы обслуживаются из PostgreSQL, поэтому его недоступность MUST NOT делать сервис неготовым. Проверка MUST NOT требовать идентификации.

Scenario: Сервис запущен

  • WHEN запуск сервиса завершён, PostgreSQL доступен, и клиент запрашивает GET /health/ready
  • THEN ответ 200, тело {"status": "ok"}

Scenario: Хранилище не готово

  • WHEN PostgreSQL недоступен
  • THEN ответ 503 с code unavailable в формате ошибки не позже таймаута проверки, а GET /health/live при этом отвечает 200

Scenario: Кэш недоступен

  • WHEN Valkey остановлен, а PostgreSQL доступен
  • THEN GET /health/ready отвечает 200

Requirement: Health вне версии API и без идентификации

Эндпоинты health SHALL находиться вне префикса /api/v1, MUST NOT требовать аутентификации и SHALL игнорировать заголовки Authorization и X-User-Id.

Scenario: Неизвестный X-User-Id

  • WHEN клиент запрашивает health с X-User-Id несуществующего пользователя
  • THEN ответ 200, а не 401

Scenario: Неизвестный токен

  • WHEN клиент запрашивает health с Bearer-токеном, которого сервис не выдавал
  • THEN ответ 200, а не 401