Skip to main content

Module dashboard

Expand description

The Overview tab, the Suotar health panel and phase pause/resume/run-now controls.

Structs§

AdminPausePhasePayload
AdminPhaseActionPayload
CreditRegistrationCircuitBreakerState
The circuit breaker as this web process holds it. The global key only — a narrowed run gets its own — and the counters live in process memory, so this says whether this server would currently skip a study registry call, not whether the workers would.
CreditRegistrationErrorCodeTotal
CreditRegistrationOldestNonTerminal
CreditRegistrationOverview
CreditRegistrationPhaseStatus
One pipeline phase’s heartbeat, written by the worker loops and by unscoped runs only, never by a narrowed one. Returned by the pause/resume/run-now actions; the Workers tab lists CreditRegistrationPhaseRow instead, which is wider.
CreditRegistrationStateTotal
CreditRegistrationStuckTotal
CreditRegistrationThroughputBucket
SuotarEndpointStanding
Where one study registry endpoint stands, over all time.
SuotarEndpointWindowStats
SuotarHealth
SuotarHealthWindow

Constants§

ENDPOINT_STATS_WINDOWS_SECS 🔒
THROUGHPUT_DAYS 🔒

Functions§

_add_routes
admin_pause_phase
POST /api/v0/main-frontend/credit-registration-admin/phases/{phase}/pause - Pauses one phase: the worker loop skips it on every tick until it is resumed.
admin_resume_phase
POST /api/v0/main-frontend/credit-registration-admin/phases/{phase}/resume - Resumes one paused phase.
admin_run_phase_now
POST /api/v0/main-frontend/credit-registration-admin/phases/{phase}/run-now - Makes one phase due immediately: the worker loop picks it up on its next tick instead of waiting out next_run_at.
circuit_breaker_state 🔒
get_credit_registration_overview
GET /api/v0/main-frontend/credit-registration-admin/overview - Everything the Overview tab and the alert banner render, in one request so the tiles cannot contradict each other.
get_suotar_health
GET /api/v0/main-frontend/credit-registration-admin/suotar-health - Per-endpoint call counts, success rates and latency percentiles over an hour, a day and a week.
one_phase_status 🔒
One phase’s status, so a pause/resume/run-now response shows the effect without a second request.
require_known_phase 🔒
Resolves a path segment to the spelling credit_registration_phase_state stores, refusing anything that is not a canonical phase name.
to_endpoint_standing 🔒
to_endpoint_window_stats_for_window 🔒
to_error_code_total 🔒
to_oldest_non_terminal 🔒
to_phase_status 🔒
to_stuck_total 🔒