artefactual / artefactual/atom

Feature Request: health check endpoint

Open
#2,284 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
297
Forks
152
Avg merge
1d 8h
Merged PRs (30d)
3

Description

Would it be possible to create a route that provides some basic health check of the app?

For example: Atom worker running, elasticsearch running, memcached (if enabled), gearman (if enabled) are all running, and return a 200 OK and maybe a json response with OK's for everything, and if anything is down return a 503?

That way we can easily monitor from both a load balancer perspective, but also from our standard system checks!

Thanks for your consideration.

Contributor guide

Open the contributing guide

Research direction

Start by locating the route entry point and the existing checks for the Atom worker, Elasticsearch, Memcached, and Gearman. Define how enabled and unavailable services should affect the response, then verify that the endpoint returns 200 with per-service OK results when healthy and 503 when a required check fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, memcached, php
Domain
api, backend, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.