endpoint

Documentation

Overview

Package endpoint implements the HTTP endpoints of Ayd such as status page.

Index

• func HealthzEndpoint(s Store) http.HandlerFunc
• func IncidentsCSVEndpoint(s Store) http.HandlerFunc
• func IncidentsHTMLEndpoint(s Store) http.HandlerFunc
• func IncidentsJSONEndpoint(s Store) http.HandlerFunc
• func IncidentsRSSEndpoint(s Store) http.HandlerFunc
• func LogCSVEndpoint(s Store) http.HandlerFunc
• func LogHTMLEndpoint(s Store) http.HandlerFunc
• func LogJsonEndpoint(s Store) http.HandlerFunc
• func LogLTSVEndpoint(s Store) http.HandlerFunc
• func LogXlsxEndpoint(s Store) http.HandlerFunc
• func MetricsEndpoint(s Store) http.HandlerFunc
• func New(s Store) http.Handler
• func StatusHTMLEndpoint(s Store) http.HandlerFunc
• func StatusJSONEndpoint(s Store) http.HandlerFunc
• func StatusTextEndpoint(s Store) http.HandlerFunc
• func TargetsJSONEndpoint(s Store) http.HandlerFunc
• func TargetsTextEndpoint(s Store) http.HandlerFunc
• func WithBasicAuth(handler http.Handler, userinfo string) http.Handler
• type BasicAuth
  • func (a BasicAuth) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type CommonHeader
  • func (ch CommonHeader) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ContextScanner
  • func NewContextScanner(ctx context.Context, s api.LogScanner) ContextScanner
  • func (cs ContextScanner) Close() error
  • func (cs ContextScanner) Record() api.Record
  • func (cs ContextScanner) Scan() bool
• type FilterScanner
  • func (f FilterScanner) Close() error
  • func (f FilterScanner) Record() api.Record
  • func (f FilterScanner) Scan() bool
• type LinkHeader
  • func (lh LinkHeader) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PagingScanner
  • func (s *PagingScanner) Close() error
  • func (s *PagingScanner) Record() api.Record
  • func (s *PagingScanner) Scan() bool
  • func (s *PagingScanner) ScanTotal() uint64
• type Query
  • func ParseQuery(query string) Query
  • func (qs Query) Match(r api.Record) bool
• type Store

Functions

func HealthzEndpoint

func HealthzEndpoint(s Store) http.HandlerFunc

HealthzEndpoint is the http.HandlerFunc for /healthz page.

func IncidentsCSVEndpoint

func IncidentsCSVEndpoint(s Store) http.HandlerFunc

func IncidentsHTMLEndpoint

func IncidentsHTMLEndpoint(s Store) http.HandlerFunc

func IncidentsJSONEndpoint

func IncidentsJSONEndpoint(s Store) http.HandlerFunc

func IncidentsRSSEndpoint

func IncidentsRSSEndpoint(s Store) http.HandlerFunc

func LogCSVEndpoint

func LogCSVEndpoint(s Store) http.HandlerFunc

func LogHTMLEndpoint

func LogHTMLEndpoint(s Store) http.HandlerFunc

func LogJsonEndpoint

func LogJsonEndpoint(s Store) http.HandlerFunc

func LogLTSVEndpoint

func LogLTSVEndpoint(s Store) http.HandlerFunc

func LogXlsxEndpoint

func LogXlsxEndpoint(s Store) http.HandlerFunc

func MetricsEndpoint

func MetricsEndpoint(s Store) http.HandlerFunc

MetricsEndpoint implements Prometheus metrics endpoint. This endpoint follows both of Prometheus specification and OpenMetrics specification.

func New

func New(s Store) http.Handler

New makes new http.Handler

func StatusHTMLEndpoint

func StatusHTMLEndpoint(s Store) http.HandlerFunc

func StatusJSONEndpoint

func StatusJSONEndpoint(s Store) http.HandlerFunc

func StatusTextEndpoint

func StatusTextEndpoint(s Store) http.HandlerFunc

func TargetsJSONEndpoint

func TargetsJSONEndpoint(s Store) http.HandlerFunc

TargetsJSONEndpoint replies target list in json format.

func TargetsTextEndpoint

func TargetsTextEndpoint(s Store) http.HandlerFunc

TargetsTextEndpoint replies target list in text.

func WithBasicAuth

func WithBasicAuth(handler http.Handler, userinfo string) http.Handler

WithBasicAuth wraps http.Handler with a BasicAuth.

Types

type BasicAuth

type BasicAuth struct {
	Handler            http.Handler
	Username, Password string
}

BasicAuth is a http.Handler wrapper that handles Basic Authorization. It supports only one pair of username and password.

func (BasicAuth) ServeHTTP

func (a BasicAuth) ServeHTTP(w http.ResponseWriter, r *http.Request)

type CommonHeader

type CommonHeader struct {
	Upstream http.Handler
}

func (CommonHeader) ServeHTTP

func (ch CommonHeader) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ContextScanner

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

func NewContextScanner

func NewContextScanner(ctx context.Context, s api.LogScanner) ContextScanner

func (ContextScanner) Close

func (cs ContextScanner) Close() error

func (ContextScanner) Record

func (cs ContextScanner) Record() api.Record

func (ContextScanner) Scan

func (cs ContextScanner) Scan() bool

type FilterScanner

type FilterScanner struct {
	Scanner api.LogScanner
	Targets []string
	Query   Query
}

func (FilterScanner) Close

func (f FilterScanner) Close() error

func (FilterScanner) Record

func (f FilterScanner) Record() api.Record

func (FilterScanner) Scan

func (f FilterScanner) Scan() bool

type LinkHeader

type LinkHeader struct {
	Upstream http.HandlerFunc
	Link     string
}

func (LinkHeader) ServeHTTP

func (lh LinkHeader) ServeHTTP(w http.ResponseWriter, r *http.Request)

type PagingScanner

type PagingScanner struct {
	Scanner api.LogScanner
	Offset  uint64
	Limit   uint64
	// contains filtered or unexported fields
}

func (*PagingScanner) Close

func (s *PagingScanner) Close() error

func (*PagingScanner) Record

func (s *PagingScanner) Record() api.Record

func (*PagingScanner) Scan

func (s *PagingScanner) Scan() bool

func (*PagingScanner) ScanTotal

func (s *PagingScanner) ScanTotal() uint64

ScanTotal scans all logs and return number of records. Don't call this before get records you need, because this method consumes all logs.

type Query

type Query []keyword

func ParseQuery

func ParseQuery(query string) Query

func (Query) Match

func (qs Query) Match(r api.Record) bool

type Store

type Store interface {
	// Targets returns target URLs include inactive target.
	Targets() []string

	// ProbeHistory returns a slice of ProbeHistory.
	ProbeHistory() []api.ProbeHistory

	// MakeReport creates ayd.Report for exporting for endpoint.
	MakeReport(probeHistoryLength int) api.Report

	// ReportInternalError reports Ayd internal error.
	ReportInternalError(scope, message string)

	// Errors returns a list of internal (critical) errors.
	Errors() (healthy bool, messages []string)

	// IncidentCount returns the count of incident causes.
	IncidentCount() int

	// OpenLog opens ayd.LogScanner.
	OpenLog(since, until time.Time) (api.LogScanner, error)
}