proxy

Documentation

Index

• func Handlers(lock *sync.RWMutex, cfg *config.ProxyMode, serverURL *url.URL, ...) fasthttp.RequestHandler
• func NewHandlerUpdater(lock *sync.RWMutex, logger *logrus.Logger, oasStorage storage.DBOpenAPILoader, ...) updater.Updater
• type Health
  • func (h Health) Liveness(ctx *fasthttp.RequestCtx) error
  • func (h Health) Readiness(ctx *fasthttp.RequestCtx) error
• type Specification
  • func (s *Specification) Find(rctx *router.Context, schemaID int, method, path string) (router.Handler, error)
  • func (s *Specification) Load() (storage.DBOpenAPILoader, error)
  • func (s *Specification) Run()
  • func (s *Specification) Shutdown() error
  • func (s *Specification) Start() error

Functions

func Handlers

func Handlers(lock *sync.RWMutex, cfg *config.ProxyMode, serverURL *url.URL, shutdown chan os.Signal, logger *logrus.Logger, httpClientsPool proxy.Pool, specStorage storage.DBOpenAPILoader, deniedTokens *denylist.DeniedTokens, allowedIPCache *allowiplist.AllowedIPsType, waf coraza.WAF) fasthttp.RequestHandler

func NewHandlerUpdater

func NewHandlerUpdater(lock *sync.RWMutex, logger *logrus.Logger, oasStorage storage.DBOpenAPILoader, cfg *config.ProxyMode, serverURL *url.URL, api *fasthttp.Server, shutdown chan os.Signal, pool proxy.Pool, deniedTokens *denylist.DeniedTokens, allowedIPCache *allowiplist.AllowedIPsType, waf coraza.WAF) updater.Updater

NewHandlerUpdater function defines configuration updater controller

Types

type Health

type Health struct {
	Build  string
	Logger *logrus.Logger
	Pool   proxy.Pool
}

func (Health) Liveness

func (h Health) Liveness(ctx *fasthttp.RequestCtx) error

Liveness returns simple status info if the service is alive. If the app is deployed to a Kubernetes cluster, it will also return pod, node, and namespace details via the Downward API. The Kubernetes environment variables need to be set within your Pod/Deployment manifest.

func (Health) Readiness

func (h Health) Readiness(ctx *fasthttp.RequestCtx) error

Readiness checks if the Fasthttp connection pool is ready to handle new requests.

type Specification

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

func (*Specification) Find

func (s *Specification) Find(rctx *router.Context, schemaID int, method, path string) (router.Handler, error)

Find function searches for the handler by path and method

func (*Specification) Load

func (s *Specification) Load() (storage.DBOpenAPILoader, error)

Load function reads DB file and returns it

func (*Specification) Run

func (s *Specification) Run()

Run function performs update of the specification

func (*Specification) Shutdown

func (s *Specification) Shutdown() error

Shutdown function stops update process

func (*Specification) Start

func (s *Specification) Start() error

Start function starts update process every ConfigurationUpdatePeriod