checkgrp

Documentation

Overview

Package checkgrp maintains the group of handlers for health checking.

Index

• type Handlers
  • func (h Handlers) Liveness(w http.ResponseWriter, r *http.Request)
  • func (h Handlers) Readiness(w http.ResponseWriter, r *http.Request)

Types

type Handlers

type Handlers struct {
	Build string
	Log   *zap.SugaredLogger
	DB    *bun.DB
}

Handlers manages the set of check endpoints.

func (Handlers) Liveness

func (h Handlers) Liveness(w http.ResponseWriter, r *http.Request)

Liveness returns simple status info if the service is alive. If the app is deployed to a Kubernetes cluster, it will also return pod, node, and namespace details via the Downward API. The Kubernetes environment variables need to be set within your Pod/Deployment manifest.

func (Handlers) Readiness

func (h Handlers) Readiness(w http.ResponseWriter, r *http.Request)

Readiness checks if the database is ready and if not will return a 500 status. Do not respond by just returning an error because further up in the call stack it will interpret that as a non-trusted error.