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
  • func (f *Phlare) Stop() func(context.Context) error
• type SelfProfilingConfig
  • func (c *SelfProfilingConfig) RegisterFlags(f *flag.FlagSet)
• type StorageConfig
  • func (c *StorageConfig) RegisterFlagsWithContext(ctx context.Context, f *flag.FlagSet)

Constants

const (
	All               string = "all"
	API               string = "api"
	Version           string = "version"
	Distributor       string = "distributor"
	Server            string = "server"
	IngesterRing      string = "ring"
	Ingester          string = "ingester"
	MemberlistKV      string = "memberlist-kv"
	Querier           string = "querier"
	StoreGateway      string = "store-gateway"
	GRPCGateway       string = "grpc-gateway"
	Storage           string = "storage"
	UsageReport       string = "usage-stats"
	QueryFrontend     string = "query-frontend"
	QueryScheduler    string = "query-scheduler"
	RuntimeConfig     string = "runtime-config"
	Overrides         string = "overrides"
	OverridesExporter string = "overrides-exporter"
	Compactor         string = "compactor"
	Admin             string = "admin"
	TenantSettings    string = "tenant-settings"
	AdHocProfiles     string = "ad-hoc-profiles"
	EmbeddedGrafana   string = "embedded-grafana"

	Metastore           string = "metastore"
	MetastoreClient     string = "metastore-client"
	SegmentWriter       string = "segment-writer"
	SegmentWriterRing   string = "segment-writer-ring"
	SegmentWriterClient string = "segment-writer-client"
	QueryBackend        string = "query-backend"
	QueryBackendClient  string = "query-backend-client"
	CompactionWorker    string = "compaction-worker"
	HealthService       string = "health-service"
)

The various modules that make up Pyroscope.

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"`
	API               api.Config             `yaml:"api"`
	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"`
	LimitsConfig      validation.Limits      `yaml:"limits"`
	QueryScheduler    scheduler.Config       `yaml:"query_scheduler"`
	Ingester          ingester.Config        `yaml:"ingester,omitempty"`
	StoreGateway      storegateway.Config    `yaml:"store_gateway,omitempty"`
	MemberlistKV      memberlist.KVConfig    `yaml:"memberlist"`
	PhlareDB          phlaredb.Config        `yaml:"pyroscopedb,omitempty"`
	Tracing           tracing.Config         `yaml:"tracing"`
	OverridesExporter exporter.Config        `yaml:"overrides_exporter" doc:"hidden"`
	RuntimeConfig     runtimeconfig.Config   `yaml:"runtime_config"`
	Compactor         compactor.Config       `yaml:"compactor"`

	Storage       StorageConfig       `yaml:"storage"`
	SelfProfiling SelfProfilingConfig `yaml:"self_profiling,omitempty"`

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

	EmbeddedGrafana grafana.Config `yaml:"embedded_grafana,omitempty"`

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

	SegmentWriter    segmentwriter.Config    `yaml:"segment_writer" doc:"hidden"`
	Metastore        metastore.Config        `yaml:"metastore" doc:"hidden"`
	QueryBackend     querybackend.Config     `yaml:"query_backend" doc:"hidden"`
	CompactionWorker compactionworker.Config `yaml:"compaction_worker" doc:"hidden"`
	// contains filtered or unexported fields
}

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)

RegisterFlagsWithContext registers flag.

func (*Config) Validate

func (c *Config) Validate() error

type Phlare

type Phlare struct {
	Cfg Config

	ModuleManager *modules.Manager

	API           *api.API
	Server        *server.Server
	SignalHandler *signals.Handler
	MemberlistKV  *memberlist.KVInitService

	RuntimeConfig *runtimeconfig.Manager
	Overrides     *validation.Overrides
	Compactor     *compactor.MultitenantCompactor

	TenantLimits validation.TenantLimits
	// contains filtered or unexported fields
}

func New

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

func (*Phlare) Run

func (f *Phlare) Run() error

func (*Phlare) Stop

func (f *Phlare) Stop() func(context.Context) error

type SelfProfilingConfig

type SelfProfilingConfig struct {
	DisablePush          bool `yaml:"disable_push,omitempty"`
	MutexProfileFraction int  `yaml:"mutex_profile_fraction,omitempty"`
	BlockProfileRate     int  `yaml:"block_profile_rate,omitempty"`
}

func (*SelfProfilingConfig) RegisterFlags

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

type StorageConfig

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

func (*StorageConfig) RegisterFlagsWithContext

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