IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

add /healthz endpoint (#27536)

Browse Source 
kuberentes (and Im sure other orchastrators does as well) support two
kind of checks. readiness checks and liveness checks. Grafanas current
`/api/health` endpoint requires database access which might not
always be required for the instance to be considered active.
This commit is contained in:
Carl Bergquist 2020-09-18 13:03:18 +02:00 committed by GitHub
parent 20292bdb0e
commit 6dc73a6712
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pkg/api/api.go
View File

@ -437,7 +437,8 @@ func (hs *HTTPServer) registerRoutes() {
r.Delete("/api/snapshots/:key", reqEditorRole, Wrap(DeleteDashboardSnapshot)) r.Delete("/api/snapshots/:key", reqEditorRole, Wrap(DeleteDashboardSnapshot))
// Health check // Health check
r.Get("/api/health", hs.healthHandler) r.Get("/api/health", hs.apiHealthHandler)
r.Get("/healthz", hs.healthzHandler)
r.Get("/*", reqSignedIn, hs.Index) r.Get("/*", reqSignedIn, hs.Index)
} }

15
pkg/api/http_server.go
View File

@ -375,12 +375,19 @@ func (hs *HTTPServer) metricsEndpoint(ctx *macaron.Context) {
ServeHTTP(ctx.Resp, ctx.Req.Request) ServeHTTP(ctx.Resp, ctx.Req.Request)
} }
func (hs *HTTPServer) healthHandler(ctx *macaron.Context) { // healthzHandler always return 200 - Ok if Grafana's web server is running
notHeadOrGet := ctx.Req.Method != http.MethodGet && ctx.Req.Method != http.MethodHead func (hs *HTTPServer) healthzHandler(ctx *macaron.Context) {
if notHeadOrGet || ctx.Req.URL.Path != "/api/health" { ctx.WriteHeader(200)
return _, err := ctx.Resp.Write([]byte("Ok"))
if err != nil {
hs.log.Error("could not write to response", "err", err)
} }
}
// apiHealthHandler will return ok if Grafana's web server is running and it
// can access the database. If the database cannot be access it will return
// http status code 503.
func (hs *HTTPServer) apiHealthHandler(ctx *macaron.Context) {
data := simplejson.New() data := simplejson.New()
data.Set("database", "ok") data.Set("database", "ok")
if !hs.Cfg.AnonymousHideVersion { if !hs.Cfg.AnonymousHideVersion {