Skip to content

Add docs for server health check endpoint response fields and what each indicates #571

Description

@Chucks1093

Summary

The health check endpoint is used by deployment infrastructure to determine if the server is ready to receive traffic. Its response fields are undocumented so operators do not know what each field means or what values indicate a healthy vs degraded state.

Scope

  • Document all fields in the health check response: database connectivity, indexer lag, cache status, uptime
  • Define what values indicate healthy, degraded, and unhealthy for each field
  • Explain the difference between the liveness and readiness checks if both exist
  • Add a note on which field causes a non-200 response

Acceptance Criteria

  • All response fields documented with possible values
  • Healthy vs degraded vs unhealthy states defined per field
  • Liveness vs readiness distinction explained
  • Non-200 trigger condition documented

ETA: 12 hours


Coordinate on Telegram

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions