Health Check Response Format for HTTP APIs

A service health check response format for HTTP APIs

Usage of task-specific or application-specific formats creates significant challenges, disallowing any meaningful interoperability across different implementations and between different tooling. See specification for details.

• ALPS
• Application State Diagram
• Semantic Descriptors
  • affectedEndpoints (semantic), A JSON array containing URI Templates
  • checks (semantic), List of downstream dependencies
  • componentId (semantic), A unique identifier of an instance of a specific sub-component/dependency.
  • componentName (semantic), Human-readable name for the component.
  • componentType (semantic), SHOULD be present if componentName is present (component, datastore, system).
  • description (semantic), A human-friendly description of the service.
  • goHealth (safe), Navigate to the Health Checks resource
  • goHome (safe), Navigate to the home resource
  • health (semantic), Health Check resource
  • home (semantic), Home resource
  • links (semantic), An object containing link relations and URIs [RFC3986] for external links
  • measurementName (semantic), Web URL
  • notes (semantic), An array of notes relevant to current state of health
  • observedUnit (semantic), The unit of measurement in which observedValue is reported
  • observedValue (semantic), Any valid JSON value
  • output (semantic), The raw error output, in case of 'fail' or 'warn' states.
  • releaseId (semantic), Release/version identifier for the service.
  • serviceId (semantic), A unique identifier of the service.
  • status (semantic), indicates service status (pass, fail, warn)
  • time (semantic), The date-time at which the reading of the observedValue was recorded.
  • version (semantic), Public version of the service.
• Tags
  • checks
  • choreography
  • ontology
  • taxonomy