Skip to content

standarised status endpoints for backend services #50

@simonchapman1986

Description

@simonchapman1986

one thing i think that would be nice, and isn't always well approached by APIM's, is the status endpoint.

My proposal is as follows.

each registered backend service to be granted a reserved resource, /_status this resource will return a standardised response of the health and version of the backend it points to

{
   "version": "v2023.03.07.1139",  # defined at point of backend registry/backend update API
   "healthly": true,  # bool of whether backend is healthy
   "deploy-date": 1678328038,  # epoch time
   "last-checked": 1678328038  # epoch time
}

with something like this in place, it'll then be easy to extend having a status site displaying the various backends and how healthy they are.

this will also help feed into support of multiple versions of apps i.e. for canary/blue/green support

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is neededquestionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions