pyroscope

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2025 License: AGPL-3.0 Imports: 105 Imported by: 0

Documentation

Index

Constants

View Source 
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"
	FeatureFlags      string = "feature-flags"

	Metastore            string = "metastore"
	MetastoreClient      string = "metastore-client"
	MetastoreAdmin       string = "metastore-admin"
	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"
	PlacementAgent       string = "placement-agent"
	PlacementManager     string = "placement-manager"
	HealthServer         string = "health-server"
	RecordingRulesClient string = "recording-rules-client"
	Symbolizer           string = "symbolizer"
)

The various modules that make up Pyroscope.

Variables

This section is empty.

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"`
	TenantSettings    settings.Config        `yaml:"tenant_settings"`

	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"`
	ShutdownDelay       time.Duration     `yaml:"shutdown_delay,omitempty"`

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

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

	V2                bool                    `yaml:"-" doc:"hidden"`
	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"`
	AdaptivePlacement placement.Config        `yaml:"adaptive_placement" doc:"hidden"`
	Symbolizer        symbolizer.Config       `yaml:"symbolizer"         doc:"hidden"`
}

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(f *flag.FlagSet)

RegisterFlagsWithContext registers flag.

func (*Config) Validate 

func (c *Config) Validate() error

type Pyroscope 

type Pyroscope 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) (*Pyroscope, error)

func (*Pyroscope) Run 

func (f *Pyroscope) Run() error

func (*Pyroscope) Stop 

func (f *Pyroscope) 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"`
	UseK6Middleware      bool `yaml:"use_k6_middleware,omitempty"`
}

func (*SelfProfilingConfig) RegisterFlags 

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

type StorageConfig 

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

func (*StorageConfig) RegisterFlags 

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.