observability

Documentation

Index

• Constants
• func NoopProbe(context.Context) error
• type MetricServer
  • func (s *MetricServer) ConstructHandler() http.Handler
  • func (s *MetricServer) Run(ctx context.Context) error
• type Probe
• type ProbeRegistry
  • func NewProbeRegistry() *ProbeRegistry
  • func (p *ProbeRegistry) Liveness(ctx context.Context) error
  • func (p *ProbeRegistry) Readiness(ctx context.Context) error
  • func (p *ProbeRegistry) RegisterLivenessProbe(key string, probe Probe)
  • func (p *ProbeRegistry) RegisterReadinessProbe(key string, probe Probe)
  • func (p *ProbeRegistry) RegisterReadinessToggle(key string) func()

Constants

const (
	ModuleName = "observability"
)

Functions

func NoopProbe

func NoopProbe(context.Context) error

NoopProbe is a placeholder probe for convenience

Types

type MetricServer

type MetricServer struct {
	Log *zap.Logger
	Api modshared.Api
	// Name is the name of the application.
	Name                  string
	Listener              net.Listener
	PrometheusUrlPath     string
	LivenessProbeUrlPath  string
	ReadinessProbeUrlPath string
	Gatherer              prometheus.Gatherer
	Registerer            prometheus.Registerer
	ProbeRegistry         *ProbeRegistry
}

func (*MetricServer) ConstructHandler

func (s *MetricServer) ConstructHandler() http.Handler

func (*MetricServer) Run

func (s *MetricServer) Run(ctx context.Context) error

type Probe

type Probe func(context.Context) error

Probe is the expected type for probe functions

type ProbeRegistry

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

func NewProbeRegistry

func NewProbeRegistry() *ProbeRegistry

func (*ProbeRegistry) Liveness

func (p *ProbeRegistry) Liveness(ctx context.Context) error

func (*ProbeRegistry) Readiness

func (p *ProbeRegistry) Readiness(ctx context.Context) error

func (*ProbeRegistry) RegisterLivenessProbe

func (p *ProbeRegistry) RegisterLivenessProbe(key string, probe Probe)

func (*ProbeRegistry) RegisterReadinessProbe

func (p *ProbeRegistry) RegisterReadinessProbe(key string, probe Probe)

func (*ProbeRegistry) RegisterReadinessToggle

func (p *ProbeRegistry) RegisterReadinessToggle(key string) func()