github_mirrors/go-zero
1
0
Fork 0
mirror of https://github.com/zeromicro/go-zero.git synced 2025-01-23 09:00:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

add custom health response information (#4034)

Browse Source 
Co-authored-by: Kevin Wan <wanjunfeng@gmail.com>
This commit is contained in:
fearlessfei 2024-04-03 22:33:55 +08:00 committed by GitHub
parent 6f3d094eba
commit 968727412d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/stores/redis/metrics_test.go
View File

@ -19,7 +19,7 @@ func TestRedisMetric(t *testing.T) {
cfg := devserver.Config{}
_ = conf.FillDefault(&cfg)
server := devserver.NewServer(cfg)
server.StartAsync()
server.StartAsync(cfg)
time.Sleep(time.Second)
metricReqDur.Observe(8, "test-cmd")

2
core/stores/sqlx/metrics_test.go
View File

@ -20,7 +20,7 @@ func TestSqlxMetric(t *testing.T) {
_ = conf.FillDefault(&cfg)
cfg.Port = 6480
server := devserver.NewServer(cfg)
server.StartAsync()
server.StartAsync(cfg)
time.Sleep(time.Second)
metricReqDur.Observe(8, "test-cmd")

15
internal/devserver/config.go
View File

@ -2,11 +2,12 @@ package devserver
// Config is config for inner http server.
type Config struct {
Enabled bool `json:",default=true"`
Host string `json:",optional"`
Port int `json:",default=6060"`
MetricsPath string `json:",default=/metrics"`
HealthPath string `json:",default=/healthz"`
EnableMetrics bool `json:",default=true"`
EnablePprof bool `json:",default=true"`
Enabled bool `json:",default=true"`
Host string `json:",optional"`
Port int `json:",default=6060"`
MetricsPath string `json:",default=/metrics"`
HealthPath string `json:",default=/healthz"`
EnableMetrics bool `json:",default=true"`
EnablePprof bool `json:",default=true"`
HealthRespInfo string `json:",default=OK"`
}

10
internal/devserver/server.go
View File

@ -32,13 +32,13 @@ func NewServer(config Config) *Server {
}
}
func (s *Server) addRoutes() {
func (s *Server) addRoutes(c Config) {
// route path, routes list
s.handleFunc("/", func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(s.routes)
})
// health
s.handleFunc(s.config.HealthPath, health.CreateHttpHandler())
s.handleFunc(s.config.HealthPath, health.CreateHttpHandler(c.HealthRespInfo))
// metrics
if s.config.EnableMetrics {
@ -62,8 +62,8 @@ func (s *Server) handleFunc(pattern string, handler http.HandlerFunc) {
}
// StartAsync start inner http server background.
func (s *Server) StartAsync() {
s.addRoutes()
func (s *Server) StartAsync(c Config) {
s.addRoutes(c)
threading.GoSafe(func() {
addr := fmt.Sprintf("%s:%d", s.config.Host, s.config.Port)
logx.Infof("Starting dev http server at %s", addr)
@ -78,7 +78,7 @@ func StartAgent(c Config) {
once.Do(func() {
if c.Enabled {
s := NewServer(c)
s.StartAsync()
s.StartAsync(c)
}
})
}

4
internal/health/health.go
View File

@ -44,10 +44,10 @@ func AddProbe(probe Probe) {
}
// CreateHttpHandler create health http handler base on given probe.
func CreateHttpHandler() http.HandlerFunc {
func CreateHttpHandler(healthRespInfo string) http.HandlerFunc {
return func(w http.ResponseWriter, _ *http.Request) {
if defaultHealthManager.IsReady() {
_, _ = w.Write([]byte("OK"))
_, _ = w.Write([]byte(healthRespInfo))
} else {
http.Error(w, "Service Unavailable\n"+defaultHealthManager.verboseInfo(),
http.StatusServiceUnavailable)

2
internal/health/health_test.go
View File

@ -121,7 +121,7 @@ func TestAddGlobalProbes(t *testing.T) {
func TestCreateHttpHandler(t *testing.T) {
cleanupForTest(t)
srv := httptest.NewServer(CreateHttpHandler())
srv := httptest.NewServer(CreateHttpHandler("OK"))
defer srv.Close()
resp, err := http.Get(srv.URL)