Documentation
¶
Overview ¶
Package options provides options for configuration reload support
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// ListenAddress is IP address from which the Reload API is available at ReloadHandlerPath
ListenAddress string `toml:"listen_address"`
// ListenPort is TCP Port from which the Reload API is available at ReloadHandlerPath
ListenPort int `toml:"listen_port"`
// ReloadHandlerPath provides the path to register the Config Reload Handler
HandlerPath string `toml:"handler_path"`
// DrainTimeoutSecs provides the duration to wait for all sessions to drain before closing
// old resources following a reload
DrainTimeoutSecs int `toml:"drain_timeout_secs"`
// RateLimitSecs limits the # of handled config reload HTTP requests to 1 per CheckRateSecs
// if multiple HTTP requests are received in the rate limit window, only the first is handled
// This prevents a bad actor from stating the config file with millions of concurrent requets
// The rate limit does not apply to SIGHUP-based reload requests
RateLimitSecs int `toml:"rate_limit_secs"`
}
Options is a collection of configurations for in-process config reloading
func NewOptions ¶
func NewOptions() *Options
NewOptions returns a new Options references with Default Values set
Click to show internal directories.
Click to hide internal directories.