Brohammad / Brohammad/VoxForge

Make uptime-ready-check.sh honor READY_FAIL_ON_DEGRADED

Open
#47 0 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
4
Forks
1
Avg merge
5d 13m
Merged PRs (30d)
10

Description

## Summary

`/api/v1/ready` returns HTTP 200 when status is `degraded` unless `READY_FAIL_ON_DEGRADED=true`. `scripts/uptime-ready-check.sh` treats `degraded` as OK, so monitors will not page on optional-dep failure.

## Context

- `src/voxforge/infrastructure/observability/health.py`
- `scripts/uptime-ready-check.sh`
- `docs/deployment/uptime.md`

## Acceptance criteria

- [ ] Optional flag (e.g. `FAIL_ON_DEGRADED=true`) fails on `status=degraded`
- [ ] Default behavior unchanged
- [ ] Docs show both monitor recipes
- [ ] Small test or documented fixture for JSON parsing

Contributor guide

Open the contributing guide

Research direction

Start with scripts/uptime-ready-check.sh and compare its handling of the /api/v1/ready response with READY_FAIL_ON_DEGRADED in src/voxforge/infrastructure/observability/health.py. Add the optional degraded-status failure behavior while preserving the default, then update docs/deployment/uptime.md with both monitor recipes and add a small JSON-parsing test or documented fixture.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, shell
Domain
devops, documentation, observability
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.