pixels icon indicating copy to clipboard operation
pixels copied to clipboard

Aliveness check endpoint

Open ChrisLovering opened this issue 4 years ago • 6 comments

Implement a /ping endpoint (or similar) so that we can check when the system is ready to serve requests.

This should only return a 2XX code once all caches are up to date.

ChrisLovering avatar Jun 20 '21 13:06 ChrisLovering

Can I implement this one :P

vcokltfre avatar Jun 20 '21 13:06 vcokltfre

As part of this, we should also move GET /size back into the general router, so it requires auth

ChrisLovering avatar Jun 20 '21 13:06 ChrisLovering

Can I implement this one :P

Yes :) But I suggest waiting until #106 is merged :P

ChrisLovering avatar Jun 20 '21 13:06 ChrisLovering

Bikeshed: /healthcheck is a better name for the route :P

Akarys42 avatar Jun 20 '21 15:06 Akarys42

Maybe two endpoints? An aliveness check which returns as soon as it's serving, and then a readiness check, which is when the caches are ready.

This will line up with the checks we can configure in k8s

ChrisLovering avatar Jun 24 '21 09:06 ChrisLovering

On second thought, and some discussion in #dev-pixels having one health check endpoint should be enough.

As long as it returns when the caches are ready, we can use that for a liveness and readiness check.

ChrisLovering avatar Jun 24 '21 10:06 ChrisLovering