health

Documentation

Overview

Package health provides HTTP handlers for health check operations. It includes endpoints for monitoring application health and status.

Package health provides health check functionality for the application. This file includes cache health check endpoints.

Index

• Constants
• type CacheHealthAPI
  • func NewCacheHealthAPI(logger *logger.Logger, cache *cache.Cache) *CacheHealthAPI
  • func (h *CacheHealthAPI) CacheHealth(w http.ResponseWriter, r *http.Request)
  • func (h *CacheHealthAPI) CacheStats(w http.ResponseWriter, r *http.Request)
  • func (h *CacheHealthAPI) FlushCache(w http.ResponseWriter, r *http.Request)
  • func (h *CacheHealthAPI) RegisterHandlers(router *mux.Router)
• type HealthAPI
  • func NewHealthAPI(logger *logger.Logger) *HealthAPI
  • func (api *HealthAPI) HealthCheckAPIHandler(w http.ResponseWriter, r *http.Request)
  • func (api *HealthAPI) RegisterHandlers(router *mux.Router)

Constants

const (
	HealthCheckPath = "/health-check"
	CacheHealthPath = "/cache/health"
	CacheStatsPath  = "/cache/stats"
	FlushCachePath  = "/cache/flush"
)

HealthCheckPath is the path for health check endpoint

Types

type CacheHealthAPI

type CacheHealthAPI struct {
	// contains filtered or unexported fields
}

CacheHealthAPI provides cache health check endpoints

func NewCacheHealthAPI

func NewCacheHealthAPI(logger *logger.Logger, cache *cache.Cache) *CacheHealthAPI

NewCacheHealthAPI creates a new cache health API instance

func (*CacheHealthAPI) CacheHealth

func (h *CacheHealthAPI) CacheHealth(w http.ResponseWriter, r *http.Request)

CacheHealth checks if Redis cache is healthy

func (*CacheHealthAPI) CacheStats

func (h *CacheHealthAPI) CacheStats(w http.ResponseWriter, r *http.Request)

CacheStats returns cache statistics

func (*CacheHealthAPI) FlushCache

func (h *CacheHealthAPI) FlushCache(w http.ResponseWriter, r *http.Request)

FlushCache clears all cache data

func (*CacheHealthAPI) RegisterHandlers

func (h *CacheHealthAPI) RegisterHandlers(router *mux.Router)

RegisterHandlers registers the cache health check routes

type HealthAPI

type HealthAPI struct {
	// contains filtered or unexported fields
}

func NewHealthAPI

func NewHealthAPI(logger *logger.Logger) *HealthAPI

func (*HealthAPI) HealthCheckAPIHandler

func (api *HealthAPI) HealthCheckAPIHandler(w http.ResponseWriter, r *http.Request)

HealthCheckAPIHandler godoc @Summary ping example @Description do ping @Tags HealthCheck @Accept json @Produce json @Success 200 {string} string "OK" @Router /api/health-check [get] HealthCheckAPIHandler handles HTTP requests for health check endpoints. It returns a simple OK response to indicate the service is running.

func (*HealthAPI) RegisterHandlers

func (api *HealthAPI) RegisterHandlers(router *mux.Router)