runnerpool

Documentation

Overview

The consistent hash ring from the original fnlb.

The behaviour of this depends on changes to the runner list leaving it relatively stable.

Index

• func NewPlacerTracker(requestCtx context.Context, cfg *PlacerConfig, call RunnerCall) *placerTracker
• func RegisterPlacerViews(tagKeys []string, latencyDist []float64)
• type MTLSRunnerFactory
• type Placer
  • func NewCHPlacer(cfg *PlacerConfig) Placer
  • func NewFakeDetachedPlacer(cfg *PlacerConfig, st time.Duration) Placer
  • func NewNaivePlacer(cfg *PlacerConfig) Placer
• type PlacerConfig
  • func NewPlacerConfig() PlacerConfig
• type Runner
• type RunnerCall
• type RunnerPool
• type RunnerStatus

Functions

func NewPlacerTracker

func NewPlacerTracker(requestCtx context.Context, cfg *PlacerConfig, call RunnerCall) *placerTracker

func RegisterPlacerViews

func RegisterPlacerViews(tagKeys []string, latencyDist []float64)

Types

type MTLSRunnerFactory

type MTLSRunnerFactory func(addr string, tlsConf *tls.Config) (Runner, error)

MTLSRunnerFactory represents a factory method for constructing runners using mTLS

type Placer

type Placer interface {
	PlaceCall(ctx context.Context, rp RunnerPool, call RunnerCall) error
	GetPlacerConfig() PlacerConfig
}

Placer implements a placement strategy for calls that are load-balanced across runners in a pool

func NewCHPlacer

func NewCHPlacer(cfg *PlacerConfig) Placer

func NewFakeDetachedPlacer

func NewFakeDetachedPlacer(cfg *PlacerConfig, st time.Duration) Placer

func NewNaivePlacer

func NewNaivePlacer(cfg *PlacerConfig) Placer

type PlacerConfig

type PlacerConfig struct {
	// After all runners in the runner list is tried, apply a delay before retrying.
	RetryAllDelay time.Duration `json:"retry_all_delay"`

	// Maximum amount of time a placer can hold a request during runner attempts
	PlacerTimeout time.Duration `json:"placer_timeout"`

	// Maximum amount of time a placer can hold an ack sync request during runner attempts
	DetachedPlacerTimeout time.Duration `json:"detached_placer_timeout"`
}

Common config for placers.

func NewPlacerConfig

func NewPlacerConfig() PlacerConfig

type Runner

type Runner interface {
	TryExec(ctx context.Context, call RunnerCall) (bool, error)
	Status(ctx context.Context) (*RunnerStatus, error)
	Close(ctx context.Context) error
	Address() string
}

Runner is the interface to invoke the execution of a function call on a specific runner

type RunnerCall

type RunnerCall interface {
	SlotHashId() string
	Extensions() map[string]string
	RequestBody() io.ReadCloser
	ResponseWriter() http.ResponseWriter
	StdErr() io.ReadWriteCloser
	Model() *models.Call
}

RunnerCall provides access to the necessary details of request in order for it to be processed by a RunnerPool

type RunnerPool

type RunnerPool interface {
	// returns an error for unrecoverable errors that should not be retried
	Runners(call RunnerCall) ([]Runner, error)
	Shutdown(ctx context.Context) error
}

RunnerPool is the abstraction for getting an ordered list of runners to try for a call

type RunnerStatus

type RunnerStatus struct {
	ActiveRequestCount int32           // Number of active running requests on Runner
	RequestsReceived   uint64          // Number of requests received by Runner
	RequestsHandled    uint64          // Number of requests handled without NACK by Runner
	StatusFailed       bool            // True if Status execution failed
	Cached             bool            // True if Status was provided from cache
	StatusId           string          // Call ID for Status
	Details            string          // General/Debug Log information
	ErrorCode          int32           // If StatusFailed, then error code is set
	ErrorStr           string          // Error details if StatusFailed and ErrorCode is set
	CreatedAt          common.DateTime // Status creation date at Runner
	StartedAt          common.DateTime // Status execution date at Runner
	CompletedAt        common.DateTime // Status completion date at Runner
}

RunnerStatus is general information on Runner health as returned by Runner::Status() call