alb

Documentation

Overview

Package alb implements the Application Load Balancer Backend

Index

• Variables
• func GetResponseGates(w http.ResponseWriter, r *http.Request, hl []http.Handler) merge.ResponseGates
• func NewClient(name string, o *bo.Options, router http.Handler, _ cache.Cache, ...) (backends.Backend, error)
• func SetStatusHeader(w http.ResponseWriter, mgs merge.ResponseGates)
• func StartALBPools(clients backends.Backends, hcs healthcheck.StatusLookup) error
• func ValidatePools(clients backends.Backends) error
• type Client
  • func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options
  • func (c *Client) Handlers() map[string]http.Handler
  • func (c *Client) ValidateAndStartPool(clients backends.Backends, hcs healthcheck.StatusLookup) error
  • func (c *Client) ValidatePool(clients backends.Backends) error

Variables

var ErrInvalidTimeSeriesMergeProvider = errors.New("invalid time series merge provider")

Functions

func GetResponseGates

func GetResponseGates(w http.ResponseWriter, r *http.Request, hl []http.Handler) merge.ResponseGates

GetResponseGates make the client request to each fanout backend and returns a collection of responses

func NewClient

func NewClient(name string, o *bo.Options, router http.Handler,
	_ cache.Cache, _ backends.Backends, factories types.Lookup,
) (backends.Backend, error)

NewClient returns a new ALB client reference

func SetStatusHeader

func SetStatusHeader(w http.ResponseWriter, mgs merge.ResponseGates)

SetStatusHeader inspects the X-Trickster-Result header value crafted for each mergeable response and aggregates into a single header value for the primary merged response

func StartALBPools

func StartALBPools(clients backends.Backends, hcs healthcheck.StatusLookup) error

StartALBPools ensures that ALB's are fully loaded, which can't be done until all backends are processed, so the ALB's destination backend names can be mapped to their respective clients

func ValidatePools

func ValidatePools(clients backends.Backends) error

ValidatePools iterates the backends and validates ALB backends

Types

type Client

type Client struct {
	backends.Backend
	// contains filtered or unexported fields
}

Client Implements the Proxy Client Interface

func (*Client) DefaultPathConfigs

func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options

DefaultPathConfigs returns the default PathConfigs for the given Provider

func (*Client) Handlers

func (c *Client) Handlers() map[string]http.Handler

Handlers returns a map of the HTTP Handlers the client has registered

func (*Client) ValidateAndStartPool

func (c *Client) ValidateAndStartPool(clients backends.Backends, hcs healthcheck.StatusLookup) error

ValidateAndStartPool starts this Client's pool up using the provided list of backends to validate and map out the pool configuration

func (*Client) ValidatePool

func (c *Client) ValidatePool(clients backends.Backends) error

ValidatePool confirms the provided list of backends to is valid