healthz.h

Go to the documentation of this file.

 
#ifndef __CWIST_HEALTHZ_H__
#define __CWIST_HEALTHZ_H__
 
#include <cwist/net/http/http.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* -------------------------------------------------------------------------
 * Probe types
 * ---------------------------------------------------------------------- */
 
typedef enum cwist_health_status {
    CWIST_HEALTH_OK,       
    CWIST_HEALTH_DEGRADED, 
    CWIST_HEALTH_FAIL,     
} cwist_health_status_t;
 
typedef struct cwist_health_probe {
    const char *name;           
    cwist_health_status_t status;
    const char *message;        
} cwist_health_probe_t;
 
typedef cwist_health_probe_t (*cwist_health_probe_fn)(void *ctx);
 
/* -------------------------------------------------------------------------
 * Registry
 * ---------------------------------------------------------------------- */
 
bool cwist_healthz_register(const char *name, cwist_health_probe_fn fn, void *ctx);
 
void cwist_healthz_unregister(const char *name);
 
void cwist_healthz_run(cwist_health_probe_t *out_probes, size_t max_probes, size_t *out_count,
                       cwist_health_status_t *out_overall);
 
/* -------------------------------------------------------------------------
 * HTTP integration
 * ---------------------------------------------------------------------- */
 
void cwist_app_healthz(cwist_http_response *res);
 
void cwist_app_enable_healthz(struct cwist_app *app);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __CWIST_HEALTHZ_H__ */