loki

Documentation

Index

• Constants
• Variables
• type Config
  • func (c *Config) Clone() flagext.Registerer
  • func (c *Config) RegisterFlags(f *flag.FlagSet)
  • func (c *Config) Validate() error
• type Loki
  • func New(cfg Config) (*Loki, error)
  • func (t *Loki) Run() error

Constants

const (
	Ring            string = "ring"
	RuntimeConfig   string = "runtime-config"
	Overrides       string = "overrides"
	TenantConfigs   string = "tenant-configs"
	Server          string = "server"
	Distributor     string = "distributor"
	Ingester        string = "ingester"
	Querier         string = "querier"
	IngesterQuerier string = "ingester-querier"
	QueryFrontend   string = "query-frontend"
	RulerStorage    string = "ruler-storage"
	Ruler           string = "ruler"
	Store           string = "store"
	TableManager    string = "table-manager"
	MemberlistKV    string = "memberlist-kv"
	Compactor       string = "compactor"
	All             string = "all"
)

The various modules that make up Loki.

Variables

var GRPCStreamAuthInterceptor = func(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
	switch info.FullMethod {

	case "/logproto.Ingester/TransferChunks", "/frontend.Frontend/Process":
		return handler(srv, ss)
	default:
		return middleware.StreamServerUserHeaderInterceptor(srv, ss, info, handler)
	}
}

Types

type Config

type Config struct {
	Target      string `yaml:"target,omitempty"`
	AuthEnabled bool   `yaml:"auth_enabled,omitempty"`
	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"`
	StorageConfig    storage.Config              `yaml:"storage_config,omitempty"`
	ChunkStoreConfig chunk.StoreConfig           `yaml:"chunk_store_config,omitempty"`
	SchemaConfig     storage.SchemaConfig        `yaml:"schema_config,omitempty"`
	LimitsConfig     validation.Limits           `yaml:"limits_config,omitempty"`
	TableManager     chunk.TableManagerConfig    `yaml:"table_manager,omitempty"`
	Worker           worker.Config               `yaml:"frontend_worker,omitempty"`
	Frontend         lokifrontend.Config         `yaml:"frontend,omitempty"`
	Ruler            ruler.Config                `yaml:"ruler,omitempty"`
	QueryRange       queryrange.Config           `yaml:"query_range,omitempty"`
	RuntimeConfig    runtimeconfig.ManagerConfig `yaml:"runtime_config,omitempty"`
	MemberlistKV     memberlist.KVConfig         `yaml:"memberlist"`
	Tracing          tracing.Config              `yaml:"tracing"`
	CompactorConfig  compactor.Config            `yaml:"compactor,omitempty"`
}

Config is the root config for Loki.

func (*Config) Clone

func (c *Config) Clone() flagext.Registerer

Clone takes advantage of pass-by-value semantics to return a distinct *Config. This is primarily used to parse a different flag set without mutating the original *Config.

func (*Config) RegisterFlags

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

RegisterFlags registers flag.

func (*Config) Validate

func (c *Config) Validate() error

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

type Loki

type Loki struct {
	Cfg Config

	// set during initialization
	ModuleManager *modules.Manager

	Server *server.Server

	Ingester *ingester.Ingester
	Querier  *querier.Querier

	Store storage.Store

	RulerStorage rulestore.RuleStore

	QueryFrontEndTripperware cortex_tripper.Tripperware

	HTTPAuthMiddleware middleware.Interface
	// contains filtered or unexported fields
}

Loki is the root datastructure for Loki.

func New

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

New makes a new Loki.

func (*Loki) Run

func (t *Loki) Run() error

Run starts Loki running, and blocks until a Loki stops.