endpoint

Documentation

Index

• func Build(mux *http.ServeMux, config *Config, datastores map[string]*datastore.Service, ...) error
• func IsHelpOption(args []string) bool
• func NewConfigHandler(config *Config) http.Handler
• func NewProfHandler() *memProfHandler
• func RunApp(version string, args []string, wg *sync.WaitGroup)
• func RunAppError(version string, args []string, wg *sync.WaitGroup) error
• func RunAppWithConfig(version string, args []string, cp configProvider)
• func RunAppWithConfigError(version string, args []string, cp configProvider) error
• func RunAppWithConfigWaitError(version string, args []string, cp configProvider, wg *sync.WaitGroup) error
• type AuthHandler
  • func NewAuthHandler(config *Config, handler http.Handler) *AuthHandler
  • func (h *AuthHandler) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type AuthMux
  • func NewAuthMux(mux *http.ServeMux, config *Config) *AuthMux
  • func (m *AuthMux) Handle(path string, handler http.Handler)
  • func (m *AuthMux) HandleFunc(path string, hf func(w http.ResponseWriter, r *http.Request))
• type Config
  • func NewConfigFromURL(ctx context.Context, URL string) (*Config, error)
  • func (c *Config) Init()
  • func (c *Config) LoadFromURL(ctx context.Context, URL string, target interface{}) error
  • func (c *Config) Validate() error
• type Hook
• type Options
• type Service
  • func New(cfg *Config) (*Service, error)
  • func (s *Service) Listen() (net.Listener, error)
  • func (s *Service) ListenAndServe() error
  • func (s *Service) ListenAndServeTLS(certFile, keyFile string) error
  • func (s *Service) SelfTest() error
  • func (s *Service) Serve(l net.Listener) error
  • func (s *Service) Shutdown(ctx context.Context) error
• type TLSConfig
  • func (t *TLSConfig) Valid() error

Functions

func Build

func Build(mux *http.ServeMux, config *Config, datastores map[string]*datastore.Service,
	hooks []Hook, metrics *gmetric.Service, promReg *prometheus.Registry) error

func IsHelpOption

func IsHelpOption(args []string) bool

IsHelpOption returns true if helper

func NewConfigHandler

func NewConfigHandler(config *Config) http.Handler

func NewProfHandler

func NewProfHandler() *memProfHandler

func RunApp

func RunApp(version string, args []string, wg *sync.WaitGroup)

Deprecated: use RunAppError

func RunAppError

func RunAppError(version string, args []string, wg *sync.WaitGroup) error

func RunAppWithConfig

func RunAppWithConfig(version string, args []string, cp configProvider)

Deprecated: use RunAppErrorWithConfigError

func RunAppWithConfigError

func RunAppWithConfigError(version string, args []string, cp configProvider) error

func RunAppWithConfigWaitError

func RunAppWithConfigWaitError(version string, args []string, cp configProvider, wg *sync.WaitGroup) error

RunAppWithConfigWaitError is the full options versions. version is printed if provided in the options. TODO auto-determine version. cp is a function that can provide a configuration file. wg.Done() will be called once, when the server is finished booting up.

Types

type AuthHandler

type AuthHandler struct {
	*Config
	// contains filtered or unexported fields
}

func NewAuthHandler

func NewAuthHandler(config *Config, handler http.Handler) *AuthHandler

func (*AuthHandler) ServeHTTP

func (h *AuthHandler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

type AuthMux

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

func NewAuthMux

func NewAuthMux(mux *http.ServeMux, config *Config) *AuthMux

func (*AuthMux) Handle

func (m *AuthMux) Handle(path string, handler http.Handler)

func (*AuthMux) HandleFunc

func (m *AuthMux) HandleFunc(path string, hf func(w http.ResponseWriter, r *http.Request))

type Config

type Config struct {
	config.ModelList      `json:",omitempty" yaml:",inline"`
	sconfig.DatastoreList `json:",omitempty" yaml:",inline"`

	// GlobalBatching provides a default batching configuration if
	// models do not provide their own.
	// If GlobalBatching is provided but a model should not be batching,
	// set BatchWait to < 0.
	GlobalBatching *batchconfig.BatcherConfig `json:",omitempty" yaml:",omitempty"`

	Metrics *econfig.MetricsConfig `json:",omitempty" yaml:",omitempty"`

	Endpoint econfig.Endpoint

	EnableMemProf bool
	EnableCPUProf bool

	TLS *TLSConfig

	AllowedSubnet []string `json:",omitempty" yaml:",omitempty"`
}

Config represents an endpoint config

func NewConfigFromURL

func NewConfigFromURL(ctx context.Context, URL string) (*Config, error)

NewConfigFromURL creates a new config from URL

func (*Config) Init

func (c *Config) Init()

Init initialise config

func (*Config) LoadFromURL

func (c *Config) LoadFromURL(ctx context.Context, URL string, target interface{}) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates config

type Hook

type Hook interface {
	Hook(*config.Model, *service.Service)
}

TODO Refactor out

type Options

type Options struct {
	ConfigURL string `short:"c" long:"cfg" description:"config URI"`
	Version   bool   `short:"v" long:"version" description:"indexer version"`
}

Options represents an option

type Service

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

Service is the primary container for all HTTP based services.

func New

func New(cfg *Config) (*Service, error)

func (*Service) Listen

func (s *Service) Listen() (net.Listener, error)

func (*Service) ListenAndServe

func (s *Service) ListenAndServe() error

Deprecated: use Listen and Serve separately

func (*Service) ListenAndServeTLS

func (s *Service) ListenAndServeTLS(certFile, keyFile string) error

Deprecated: ListenAndServeTLS start https endpoint on secure port. Practically we terminate encryption via a load balancer.

func (*Service) SelfTest

func (s *Service) SelfTest() error

Runs a client side call for each model once.

func (*Service) Serve

func (s *Service) Serve(l net.Listener) error

func (*Service) Shutdown

func (s *Service) Shutdown(ctx context.Context) error

Shutdown calls http.(*Server).Shutdown

type TLSConfig

type TLSConfig struct {
	CertFile string
	KeyFile  string
}

func (*TLSConfig) Valid

func (t *TLSConfig) Valid() error