observability

Documentation

Index

• Constants
• func NoopProbe(context.Context) error
• type MetricServer
  • func (s *MetricServer) Run(ctx context.Context) error
• type Probe

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
	LivenessProbe         Probe
	ReadinessProbe        Probe
}

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