handler

type API ¶

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

API bundles shared HTTP handler dependencies.

func NewAPI(
	authToken string,
	service CheckInService,
	registry *metrics.Registry,
	responseDetails bool,
	version, commit string,
	logger *slog.Logger,
) *API

func (a *API) CheckIn() http.HandlerFunc

func (a *API) Healthz() http.HandlerFunc

func (a *API) Metrics() http.Handler

func (a *API) Readyz() http.HandlerFunc

func (a *API) SetNowFn(nowFn func() time.Time)

func (a *API) Status() http.HandlerFunc

func (a *API) Version() http.HandlerFunc

type CheckInService ¶

type CheckInService interface {
	RecordCheckIn(ctx context.Context, at time.Time) service.RecordCheckInResult
	Snapshot() service.SnapshotResult
}

CheckInService exposes the application behavior used by HTTP handler.

type RequestMetadata ¶

type RequestMetadata struct {
	Remote          string
	ClientIP        string
	Method          string
	Path            string
	Host            string
	Proto           string
	UserAgent       string
	RequestID       string
	XForwardedFor   string
	XForwardedProto string
	XForwardedHost  string
	XRealIP         string
	Forwarded       string
}

RequestMetadata describes the request origin used for diagnostic logs.

Remote is the direct TCP peer that connected to this service. ClientIP is a best-effort value from proxy headers first, then from Remote. Do not use it for auth decisions unless your proxy chain sanitizes these headers.

func (m RequestMetadata) LogFields() []any