[health] fix lint issues

Author: capcom6

pkg/health/health.go

@@ -8,7 +8,7 @@ import (
 type health struct {
 }
 
-func NewHealth() *health {
+func newHealth() *health {
 	return &health{}
 }
 
@@ -18,48 +18,50 @@ func (h *health) Name() string {
 }
 
 // LiveProbe implements HealthProvider.
-func (h *health) LiveProbe(ctx context.Context) (Checks, error) {
-	const oneGiB uint64 = 1 << 30
+func (h *health) LiveProbe(_ context.Context) (Checks, error) {
+	const oneMiB uint64 = 1 << 20
+	const memoryThreshold uint64 = 128 * oneMiB
+	const goroutineThreshold = 100
 
 	var m runtime.MemStats
 	runtime.ReadMemStats(&m)
 
 	// Basic runtime health checks
 	goroutineCheck := CheckDetail{
 		Description:   "Number of goroutines",
-		ObservedValue: int(runtime.NumGoroutine()),
+		ObservedValue: runtime.NumGoroutine(),
 		ObservedUnit:  "goroutines",
 		Status:        StatusPass,
 	}
 
 	memoryCheck := CheckDetail{
 		Description:   "Memory usage",
-		ObservedValue: int(m.Alloc / 1024 / 1024), // MiB
+		ObservedValue: int(m.Alloc / oneMiB), //nolint:gosec // not a security issue
 		ObservedUnit:  "MiB",
 		Status:        StatusPass,
 	}
 
 	// Check for potential memory issues
-	if m.Alloc > oneGiB { // 1GB
+	if m.Alloc > memoryThreshold {
 		memoryCheck.Status = StatusWarn
 	}
 
 	// Check for excessive goroutines
-	if goroutineCheck.ObservedValue > 1000 {
+	if goroutineCheck.ObservedValue > goroutineThreshold {
 		goroutineCheck.Status = StatusWarn
 	}
 
 	return Checks{"goroutines": goroutineCheck, "memory": memoryCheck}, nil
 }
 
 // ReadyProbe implements HealthProvider.
-func (h *health) ReadyProbe(ctx context.Context) (Checks, error) {
-	return nil, nil
+func (h *health) ReadyProbe(_ context.Context) (Checks, error) {
+	return nil, nil //nolint:nilnil // empty result
 }
 
 // StartedProbe implements HealthProvider.
-func (h *health) StartedProbe(ctx context.Context) (Checks, error) {
-	return nil, nil
+func (h *health) StartedProbe(_ context.Context) (Checks, error) {
+	return nil, nil //nolint:nilnil // empty result
 }
 
-var _ HealthProvider = (*health)(nil)
+var _ Provider = (*health)(nil)

pkg/health/module.go

@@ -10,7 +10,7 @@ func Module() fx.Option {
 		"health",
 		logger.WithNamedLogger("health"),
 		fx.Provide(
-			AsHealthProvider(NewHealth),
+			AsHealthProvider(newHealth),
 			fx.Private,
 		),
 		fx.Provide(
@@ -22,7 +22,7 @@ func Module() fx.Option {
 func AsHealthProvider(f any) any {
 	return fx.Annotate(
 		f,
-		fx.As(new(HealthProvider)),
+		fx.As(new(Provider)),
 		fx.ResultTags(`group:"health-providers"`),
 	)
 }

pkg/health/service.go

@@ -7,20 +7,23 @@ import (
 )
 
 type Service struct {
-	providers []HealthProvider
+	providers []Provider
 
 	logger *zap.Logger
 }
 
-func NewService(providers []HealthProvider, logger *zap.Logger) *Service {
+func NewService(providers []Provider, logger *zap.Logger) *Service {
 	return &Service{
 		providers: providers,
 
 		logger: logger,
 	}
 }
 
-func (s *Service) checkProvider(ctx context.Context, probe func(context.Context, HealthProvider) (Checks, error)) CheckResult {
+func (s *Service) checkProvider(
+	ctx context.Context,
+	probe func(context.Context, Provider) (Checks, error),
+) CheckResult {
 	check := CheckResult{
 		Checks: map[string]CheckDetail{},
 	}
@@ -34,7 +37,7 @@ func (s *Service) checkProvider(ctx context.Context, probe func(context.Context,
 
 		healthChecks, err := probe(ctx, p)
 		if err != nil {
-			s.logger.Error("Failed check", zap.String("provider", p.Name()), zap.Error(err))
+			s.logger.Error("failed check", zap.String("provider", p.Name()), zap.Error(err))
 			check.Checks[p.Name()] = CheckDetail{
 				Description:   "Failed check",
 				ObservedUnit:  "",
@@ -57,19 +60,19 @@ func (s *Service) checkProvider(ctx context.Context, probe func(context.Context,
 }
 
 func (s *Service) CheckReadiness(ctx context.Context) CheckResult {
-	return s.checkProvider(ctx, func(ctx context.Context, p HealthProvider) (Checks, error) {
+	return s.checkProvider(ctx, func(ctx context.Context, p Provider) (Checks, error) {
 		return p.ReadyProbe(ctx)
 	})
 }
 
 func (s *Service) CheckLiveness(ctx context.Context) CheckResult {
-	return s.checkProvider(ctx, func(ctx context.Context, p HealthProvider) (Checks, error) {
+	return s.checkProvider(ctx, func(ctx context.Context, p Provider) (Checks, error) {
 		return p.LiveProbe(ctx)
 	})
 }
 
 func (s *Service) CheckStartup(ctx context.Context) CheckResult {
-	return s.checkProvider(ctx, func(ctx context.Context, p HealthProvider) (Checks, error) {
+	return s.checkProvider(ctx, func(ctx context.Context, p Provider) (Checks, error) {
 		return p.StartedProbe(ctx)
 	})
 }

pkg/health/types.go

@@ -17,19 +17,13 @@ const (
 	levelFail statusLevel = 2
 )
 
-var statusLevels = map[statusLevel]Status{
-	levelPass: StatusPass,
-	levelWarn: StatusWarn,
-	levelFail: StatusFail,
-}
-
-// Health status of the application.
+// CheckResult represents the result of a set of health checks.
 type CheckResult struct {
 	// A map of check names to their respective details.
-	Checks Checks
+	Checks Checks `json:"checks"`
 }
 
-// Overall status of the application.
+// Status returns the overall status of the application.
 // It can be one of the following values: "pass", "warn", or "fail".
 func (c CheckResult) Status() Status {
 	// Determine overall status
@@ -44,10 +38,19 @@ func (c CheckResult) Status() Status {
 		}
 	}
 
-	return statusLevels[level]
+	switch level {
+	case levelPass:
+		return StatusPass
+	case levelWarn:
+		return StatusWarn
+	case levelFail:
+		return StatusFail
+	}
+
+	return StatusFail
 }
 
-// Details of a health check.
+// CheckDetail of a health check.
 type CheckDetail struct {
 	// A human-readable description of the check.
 	Description string
@@ -60,10 +63,10 @@ type CheckDetail struct {
 	Status Status
 }
 
-// Map of check names to their respective details.
+// Checks is a map of check names to their respective details.
 type Checks map[string]CheckDetail
 
-type HealthProvider interface {
+type Provider interface {
 	Name() string
 
 	StartedProbe(ctx context.Context) (Checks, error)