Ignition icon indicating copy to clipboard operation
Ignition copied to clipboard

_system or _meta endpoints for ping / healthchecks?

Open pysysops opened this issue 7 years ago • 1 comments

I'm looking into monitoring a couple of internal services that make use of ignition and thought may be we could discuss having some basic, consistent endpoints to help like a:

  • /_system/health - an endpoint / interface (adaptor?) that could check health such as DB connectivity / pool, file system permissions for things that should be writable and other health checks (responds with JSON / YAML / Whatever Accept header format, 200 for OK and 5XX for not okay).

  • /_system/ping - an endpoint to respond with a 200 / "pong" to indicate aliveness.

  • /_system/metrics - an endpoint to expose metrics in a format fit for scraping (by prometheus for example?)

Is this something that would fit in Ignition?

pysysops avatar Aug 28 '18 15:08 pysysops

FYI: Ignition doesn't do anything with database connections yet.

Ignition is a centralised, generic tool for multiple repositories. Do you know where these endpoints would be used? e.g. a metric endpoint feels like you need a lot of custom logic based on the project you are working on.

Let me know 👍

kirrg001 avatar Sep 06 '18 09:09 kirrg001