cortex

Documentation

Index

• Constants
• type Config
  • func (c *Config) RegisterFlags(f *flag.FlagSet)
  • func (c *Config) Validate() error
• type Cortex
  • func New(cfg Config) (*Cortex, error)
  • func (t *Cortex) Run() error
  • func (t *Cortex) Stop() error

Constants

const (
	Ring moduleName = iota
	Overrides
	Server
	Distributor
	Ingester
	Querier
	QueryFrontend
	Store
	TableManager
	Ruler
	Configs
	AlertManager
	All
)

The various modules that make up Cortex.

Types

type Config

type Config struct {
	Target      moduleName `yaml:"target,omitempty"`
	AuthEnabled bool       `yaml:"auth_enabled,omitempty"`
	PrintConfig bool       `yaml:"-"`
	HTTPPrefix  string     `yaml:"http_prefix"`

	Server         server.Config            `yaml:"server,omitempty"`
	Distributor    distributor.Config       `yaml:"distributor,omitempty"`
	Querier        querier.Config           `yaml:"querier,omitempty"`
	IngesterClient client.Config            `yaml:"ingester_client,omitempty"`
	Ingester       ingester.Config          `yaml:"ingester,omitempty"`
	Storage        storage.Config           `yaml:"storage,omitempty"`
	ChunkStore     chunk.StoreConfig        `yaml:"chunk_store,omitempty"`
	Schema         chunk.SchemaConfig       `yaml:"schema,omitempty"`
	LimitsConfig   validation.Limits        `yaml:"limits,omitempty"`
	Prealloc       client.PreallocConfig    `yaml:"prealloc,omitempty"`
	Worker         frontend.WorkerConfig    `yaml:"frontend_worker,omitempty"`
	Frontend       frontend.Config          `yaml:"frontend,omitempty"`
	TableManager   chunk.TableManagerConfig `yaml:"table_manager,omitempty"`
	Encoding       encoding.Config          `yaml:"-"` // No yaml for this, it only works with flags.

	Ruler        ruler.Config                               `yaml:"ruler,omitempty"`
	ConfigStore  config_client.Config                       `yaml:"config_store,omitempty"`
	Alertmanager alertmanager.MultitenantAlertmanagerConfig `yaml:"alertmanager,omitempty"`
}

Config is the root config for Cortex.

func (*Config) RegisterFlags

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

RegisterFlags registers flag.

func (*Config) Validate

func (c *Config) Validate() error

Validate the cortex config and returns an error if the validation doesn't pass

type Cortex

type Cortex struct {
	// contains filtered or unexported fields
}

Cortex is the root datastructure for Cortex.

func New

func New(cfg Config) (*Cortex, error)

New makes a new Cortex.

func (*Cortex) Run

func (t *Cortex) Run() error

Run starts Cortex running, and blocks until a signal is received.

func (*Cortex) Stop

func (t *Cortex) Stop() error

Stop gracefully stops a Cortex.