profiler

Documentation

Index

• Variables
• func AddHealthCheck(f func() error)
• func CheckHealth() error
• func ExecuteHealthCheck() error
• func Monitor(addr string) func()
• type State
  • func DefaultState() *State
  • func NewState() *State
  • func (s *State) AddHealthCheck(f func() error)
  • func (s *State) CheckHealth() error
  • func (s *State) IsReady() bool
  • func (s *State) IsStarted() bool
  • func (s *State) Monitor(addr string) func()
  • func (s *State) Reset()
  • func (s *State) SetReady(ready bool)
  • func (s *State) SetStarted(started bool)

Variables

var (
	// Started is true once the app has initialized successfully (DB connected, etc.).
	Started atomic.Bool
	// Ready is true once the server is accepting traffic (Fiber listening / NATS subscribed).
	Ready atomic.Bool
)

Probe flags for Kubernetes. Set by the application lifecycle (main.go).

var ErrServiceIsOffline = errors.New("service is offline")

ErrServiceIsOffline indicates that a health check dependency is offline.

Functions

func AddHealthCheck

func AddHealthCheck(f func() error)

AddHealthCheck registers a function called on /healthz, /readyz, and /livez. If any check returns an error the service is considered unhealthy.

Deprecated: use NewState and State.AddHealthCheck for explicit ownership.

func CheckHealth

func CheckHealth() error

CheckHealth runs every registered health check concurrently and returns a joined error if any fail. Exported so the main app server can expose /healthz on the Traefik-facing port without auth.

Deprecated: use NewState and State.CheckHealth for explicit ownership.

func ExecuteHealthCheck

func ExecuteHealthCheck() error

ExecuteHealthCheck runs every registered health check.

Deprecated: use CheckHealth.

func Monitor

func Monitor(addr string) func()

Monitor starts a standalone HTTP server on addr exposing health probes and pprof. It should be called as early as possible in main(), before DB/NATS/app init. Returns a shutdown function that should be deferred.

Usage:

shutdown := profiler.Monitor(":8011")
defer shutdown()

Deprecated: use NewState and State.Monitor for explicit ownership.

Types

type State

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

State owns profiler health checks and probe flags.

func DefaultState

func DefaultState() *State

DefaultState returns the package-level compatibility profiler state.

func NewState

func NewState() *State

NewState returns isolated profiler health and probe state.

func (*State) AddHealthCheck

func (s *State) AddHealthCheck(f func() error)

AddHealthCheck registers a function called on /healthz, /readyz, and /livez. If any check returns an error the service is considered unhealthy.

func (*State) CheckHealth

func (s *State) CheckHealth() error

CheckHealth runs every registered health check concurrently and returns a joined error if any fail.

func (*State) IsReady

func (s *State) IsReady() bool

IsReady returns the readiness probe flag.

func (*State) IsStarted

func (s *State) IsStarted() bool

IsStarted returns the startup probe flag.

func (*State) Monitor

func (s *State) Monitor(addr string) func()

Monitor starts a standalone HTTP server on addr using this state.

func (*State) Reset

func (s *State) Reset()

Reset clears health checks and probe flags.

func (*State) SetReady

func (s *State) SetReady(ready bool)

SetReady stores the readiness probe flag.

func (*State) SetStarted

func (s *State) SetStarted(started bool)

SetStarted stores the startup probe flag.