phlare

Documentation

Index

• Constants
• func DisableSignalHandling(config *server.Config)
• func NewServerService(serv *server.Server, servicesToWaitFor func() []services.Service, ...) services.Service
• func RegisterHealthServer(mux *mux.Router, checks ...grpcutil.Check)
• type Config
  • func (c *Config) ApplyDynamicConfig() cfg.Source
  • func (c *Config) Clone() flagext.Registerer
  • func (c *Config) RegisterFlags(f *flag.FlagSet)
  • func (c *Config) RegisterFlagsWithContext(ctx context.Context, f *flag.FlagSet)
  • func (c *Config) Validate() error
• type Phlare
  • func New(cfg Config) (*Phlare, error)
  • func (f *Phlare) Run() error
• type StorageConfig
  • func (c *StorageConfig) RegisterFlagsWithContext(ctx context.Context, f *flag.FlagSet)

Constants

const (
	All            string = "all"
	Agent          string = "agent"
	Distributor    string = "distributor"
	Server         string = "server"
	Ring           string = "ring"
	Ingester       string = "ingester"
	MemberlistKV   string = "memberlist-kv"
	Querier        string = "querier"
	GRPCGateway    string = "grpc-gateway"
	Storage        string = "storage"
	UsageReport    string = "usage-stats"
	QueryFrontend  string = "query-frontend"
	QueryScheduler string = "query-scheduler"
)

The various modules that make up Phlare.

Functions

func DisableSignalHandling

func DisableSignalHandling(config *server.Config)

DisableSignalHandling puts a dummy signal handler

func NewServerService

func NewServerService(serv *server.Server, servicesToWaitFor func() []services.Service, log log.Logger) services.Service

NewServerService constructs service from Server component. servicesToWaitFor is called when server is stopping, and should return all services that need to terminate before server actually stops. N.B.: this function is NOT Cortex specific, please let's keep it that way. Passed server should not react on signals. Early return from Run function is considered to be an error.

func RegisterHealthServer

func RegisterHealthServer(mux *mux.Router, checks ...grpcutil.Check)

Types

type Config

type Config struct {
	Target         flagext.StringSliceCSV `yaml:"target,omitempty"`
	AgentConfig    agent.Config           `yaml:",inline"`
	Server         server.Config          `yaml:"server,omitempty"`
	Distributor    distributor.Config     `yaml:"distributor,omitempty"`
	Querier        querier.Config         `yaml:"querier,omitempty"`
	Frontend       frontend.Config        `yaml:"frontend,omitempty"`
	Worker         worker.Config          `yaml:"frontend_worker"`
	QueryScheduler scheduler.Config       `yaml:"query_scheduler"`
	Ingester       ingester.Config        `yaml:"ingester,omitempty"`
	MemberlistKV   memberlist.KVConfig    `yaml:"memberlist"`
	PhlareDB       phlaredb.Config        `yaml:"phlaredb,omitempty"`
	Tracing        tracing.Config         `yaml:"tracing"`

	Storage StorageConfig `yaml:"storage"`

	MultitenancyEnabled bool              `yaml:"multitenancy_enabled,omitempty"`
	Analytics           usagestats.Config `yaml:"analytics"`

	ConfigFile      string `yaml:"-"`
	ShowVersion     bool   `yaml:"-"`
	ConfigExpandEnv bool   `yaml:"-"`
}

func (*Config) ApplyDynamicConfig

func (c *Config) ApplyDynamicConfig() cfg.Source

func (*Config) Clone

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

func (*Config) RegisterFlags

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

func (*Config) RegisterFlagsWithContext

func (c *Config) RegisterFlagsWithContext(ctx context.Context, f *flag.FlagSet)

RegisterFlags registers flag.

func (*Config) Validate

func (c *Config) Validate() error

type Phlare

type Phlare struct {
	Cfg Config

	ModuleManager *modules.Manager

	HTTPAuthMiddleware middleware.Interface
	Server             *server.Server
	SignalHandler      *signals.Handler
	MemberlistKV       *memberlist.KVInitService
	// contains filtered or unexported fields
}

func New

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

func (*Phlare) Run

func (f *Phlare) Run() error

type StorageConfig

type StorageConfig struct {
	Bucket objstoreclient.Config `yaml:",inline"`
}

func (*StorageConfig) RegisterFlagsWithContext

func (c *StorageConfig) RegisterFlagsWithContext(ctx context.Context, f *flag.FlagSet)