endpoint

package
v0.16.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 23, 2024 License: MIT Imports: 21 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HealthzEndpoint 

func HealthzEndpoint(s Store) http.HandlerFunc

HealthzEndpoint is the http.HandlerFunc for /healthz page.

func IncidentsCSVEndpoint added in v0.14.0 

func IncidentsCSVEndpoint(s Store) http.HandlerFunc

func IncidentsHTMLEndpoint added in v0.14.0 

func IncidentsHTMLEndpoint(s Store) http.HandlerFunc

func IncidentsJSONEndpoint added in v0.14.0 

func IncidentsJSONEndpoint(s Store) http.HandlerFunc

func IncidentsRSSEndpoint added in v0.14.0 

func IncidentsRSSEndpoint(s Store) http.HandlerFunc

func LogCSVEndpoint 

func LogCSVEndpoint(s Store) http.HandlerFunc

func LogHTMLEndpoint added in v0.14.0 

func LogHTMLEndpoint(s Store) http.HandlerFunc

func LogJsonEndpoint 

func LogJsonEndpoint(s Store) http.HandlerFunc

func LogLTSVEndpoint added in v0.16.0 

func LogLTSVEndpoint(s Store) http.HandlerFunc

func LogXlsxEndpoint added in v0.16.0 

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 added in v0.12.0 

func TargetsJSONEndpoint(s Store) http.HandlerFunc

TargetsJSONEndpoint replies target list in json format.

func TargetsTextEndpoint added in v0.12.0 

func TargetsTextEndpoint(s Store) http.HandlerFunc

TargetsTextEndpoint replies target list in text.

func WithBasicAuth added in v0.12.0 

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 added in v0.13.3 

type CommonHeader struct {
	Upstream http.Handler
}

func (CommonHeader) ServeHTTP added in v0.13.3 

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

type ContextScanner added in v0.16.1 

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

func NewContextScanner added in v0.16.1 

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

func (ContextScanner) Close added in v0.16.1 

func (cs ContextScanner) Close() error

func (ContextScanner) Record added in v0.16.1 

func (cs ContextScanner) Record() api.Record

func (ContextScanner) Scan added in v0.16.1 

func (cs ContextScanner) Scan() bool

type FilterScanner added in v0.16.0 

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

func (FilterScanner) Close added in v0.16.0 

func (f FilterScanner) Close() error

func (FilterScanner) Record added in v0.16.0 

func (f FilterScanner) Record() api.Record

func (FilterScanner) Scan added in v0.16.0 

func (f FilterScanner) Scan() bool

type LinkHeader added in v0.13.3 

type LinkHeader struct {
	Upstream http.HandlerFunc
	Link     string
}

func (LinkHeader) ServeHTTP added in v0.13.3 

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

type PagingScanner added in v0.16.0 

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

func (*PagingScanner) Close added in v0.16.0 

func (s *PagingScanner) Close() error

func (*PagingScanner) Record added in v0.16.0 

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

func (*PagingScanner) Scan added in v0.16.0 

func (s *PagingScanner) Scan() bool

func (*PagingScanner) ScanTotal added in v0.16.0 

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 added in v0.14.0 

type Query []keyword

func ParseQuery added in v0.14.0 

func ParseQuery(query string) Query

func (Query) Match added in v0.14.0 

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

type Store added in v0.12.0 

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)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.