runtimeconfig

package

v1.16.0 Latest Latest Go to latest Published: Nov 19, 2023 License: Apache-2.0 Imports: 16 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cortexproject/cortex

Links

Open Source Insights

Documentation ¶

Index ¶

type BucketClientFactory
type Config
- func (mc *Config) RegisterFlags(f *flag.FlagSet)
type Loader
type Manager
- func New(cfg Config, registerer prometheus.Registerer, logger log.Logger, ...) (*Manager, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BucketClientFactory ¶ added in v1.16.0

type BucketClientFactory func(ctx context.Context) (objstore.Bucket, error)

type Config ¶ added in v1.13.0

type Config 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:"-"`

	StorageConfig bucket.Config `yaml:",inline"`
}

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

func (*Config) RegisterFlags ¶ added in v1.13.0

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

RegisterFlags registers flags.

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 New ¶ added in v1.13.0

func New(cfg Config, registerer prometheus.Registerer, logger log.Logger, factory BucketClientFactory) (*Manager, error)

New 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.

Source Files ¶

View all Source files

manager.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL