runtimeconfig

Documentation

Index

• type Loader
• type Manager
  • func NewRuntimeConfigManager(cfg ManagerConfig, registerer prometheus.Registerer) (*Manager, error)
  • func (om *Manager) CloseListenerChannel(listener <-chan interface{})
  • func (om *Manager) CreateListenerChannel(buffer int) <-chan interface{}
  • func (om *Manager) GetConfig() interface{}
• type ManagerConfig
  • func (mc *ManagerConfig) RegisterFlags(f *flag.FlagSet)

Types

type Loader

type Loader func(r io.Reader) (interface{}, error)

Loader loads the configuration from file.

type Manager

type Manager struct {
	services.Service
	// contains filtered or unexported fields
}

Manager periodically reloads the configuration from a file, and keeps this configuration available for clients.

func NewRuntimeConfigManager

func NewRuntimeConfigManager(cfg ManagerConfig, registerer prometheus.Registerer) (*Manager, error)

NewRuntimeConfigManager creates an instance of Manager and starts reload config loop based on config

func (*Manager) CloseListenerChannel

func (om *Manager) CloseListenerChannel(listener <-chan interface{})

CloseListenerChannel removes given channel from list of channels to send notifications to and closes channel.

func (*Manager) CreateListenerChannel

func (om *Manager) CreateListenerChannel(buffer int) <-chan interface{}

CreateListenerChannel creates new channel that can be used to receive new config values. If there is no receiver waiting for value when config manager tries to send the update, or channel buffer is full, update is discarded.

When config manager is stopped, it closes all channels to notify receivers that they will not receive any more updates.

func (*Manager) GetConfig

func (om *Manager) GetConfig() interface{}

GetConfig returns last loaded config value, possibly nil.

type ManagerConfig

type ManagerConfig struct {
	ReloadPeriod time.Duration `yaml:"period"`
	// LoadPath contains the path to the runtime config file, requires an
	// non-empty value
	LoadPath string `yaml:"file"`
	Loader   Loader `yaml:"-"`
}

ManagerConfig holds the config for an Manager instance. It holds config related to loading per-tenant config.

func (*ManagerConfig) RegisterFlags

func (mc *ManagerConfig) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.