server

Documentation

Index

• func Chain(h http.HandlerFunc, m ...middleware) http.HandlerFunc
• func DecodeJSONBody[T any]() middleware
• func InitMux(ss *scrapeServer, db *database.DBHandle, openHome bool, enableProfiling bool) (*http.ServeMux, error)
• func MaxBytes(n int64) middleware
• func MustScrapeServer(ctx context.Context, opts ...option) *scrapeServer
• func NewScrapeServer(ctx context.Context, opts ...option) (*scrapeServer, error)
• func WithAuthorizationIf(key auth.HMACBase64Key) option
• func WithFeedFetcher(ff fetch.FeedFetcher) option
• func WithHeadlessIf(hf fetch.URLFetcher) option
• func WithURLFetcher(f fetch.URLFetcher) option
• type BatchRequest

Functions

func Chain

func Chain(h http.HandlerFunc, m ...middleware) http.HandlerFunc

Prepend the middlewares to the handler in the order they are provided.

func DecodeJSONBody

func DecodeJSONBody[T any]() middleware

func InitMux

func InitMux(
	ss *scrapeServer,
	db *database.DBHandle,
	openHome bool,
	enableProfiling bool,
) (*http.ServeMux, error)

Mux Initialization Arguments:

• ss: scrapeServer: used for setting up API routes
• db: database.DBHandle: used for healthchecks
• openHome: bool: if true, the the page will always be open, even if auth is enabled
• enableProfiling: bool: if true, pprof routes will be added to the mux

func MaxBytes

func MaxBytes(n int64) middleware

func MustScrapeServer

func MustScrapeServer(ctx context.Context, opts ...option) *scrapeServer

func NewScrapeServer

func NewScrapeServer(ctx context.Context, opts ...option) (*scrapeServer, error)

When the context passed here is cancelled, the associated fetcher will close and release any resources they have open.

func WithAuthorizationIf

func WithAuthorizationIf(key auth.HMACBase64Key) option

func WithFeedFetcher

func WithFeedFetcher(ff fetch.FeedFetcher) option

func WithHeadlessIf

func WithHeadlessIf(hf fetch.URLFetcher) option

func WithURLFetcher

func WithURLFetcher(f fetch.URLFetcher) option

Types

type BatchRequest

type BatchRequest struct {
	Urls []string `json:"urls"`
}