proxy

Documentation

Index

• type Config
  • func GetConfigFromEnvironment() (Config, error)
  • func NewConfigWithDefaults() Config
• type Proxy
  • func NewProxy(cfg Config) (Proxy, error)

Types

type Config

type Config struct {
	PortMappings         map[int]int
	MetricsAndHealthPort int
	IgnoredPaths         map[string]struct{}
}

Config represents configuration options for the Osiris Proxy

func GetConfigFromEnvironment

func GetConfigFromEnvironment() (Config, error)

GetConfigFromEnvironment returns configuration derived from environment variables

func NewConfigWithDefaults

func NewConfigWithDefaults() Config

NewConfigWithDefaults returns a Config object with default values already applied. Callers are then free to set custom values for the remaining fields and/or override default values.

type Proxy

type Proxy interface {
	Run(ctx context.Context)
}

func NewProxy

func NewProxy(cfg Config) (Proxy, error)