storage

Documentation

Index

• type Config
  • func NewConfig(server *config.Server) *Config
  • func (c *Config) WithInMemory() *Config
  • func (c *Config) WithPath(path string) *Config
• type DeleteInput
• type GetInput
• type GetOutput
• type MetricsExporter
• type PutInput
• type SampleObserver
• type Storage
  • func New(c *Config, logger *logrus.Logger, reg prometheus.Registerer) (*Storage, error)
  • func (s *Storage) CacheStats() map[string]uint64
  • func (s *Storage) Close() error
  • func (s *Storage) Delete(di *DeleteInput) error
  • func (s *Storage) DeleteApp(appname string) error
  • func (s *Storage) DiskUsage() map[string]bytesize.ByteSize
  • func (s *Storage) EnforceRetentionPolicy(rp *segment.RetentionPolicy) error
  • func (s *Storage) Get(gi *GetInput) (*GetOutput, error)
  • func (s *Storage) GetAppNames() []string
  • func (s *Storage) GetKeys(cb func(string) bool)
  • func (s *Storage) GetKeysByQuery(query string, cb func(_k string) bool) error
  • func (s *Storage) GetValues(key string, cb func(v string) bool)
  • func (s *Storage) GetValuesByQuery(label string, query string, cb func(v string) bool) error
  • func (s *Storage) InstallID() string
  • func (s *Storage) JWT() (string, error)
  • func (s *Storage) Put(pi *PutInput) error

Types

type Config

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

func NewConfig

func NewConfig(server *config.Server) *Config

NewConfig returns a new storage config from a server config

func (*Config) WithInMemory

func (c *Config) WithInMemory() *Config

WithInMemory makes the storage in-memory.

func (*Config) WithPath

func (c *Config) WithPath(path string) *Config

WithPath sets the storage base path

type DeleteInput

type DeleteInput struct {
	// Key must match exactly one segment.
	Key *segment.Key
}

type GetInput

type GetInput struct {
	StartTime time.Time
	EndTime   time.Time
	Key       *segment.Key
	Query     *flameql.Query
}

type GetOutput

type GetOutput struct {
	Tree       *tree.Tree
	Timeline   *segment.Timeline
	SpyName    string
	SampleRate uint32
	Units      string
}

type MetricsExporter

type MetricsExporter interface {
	// Evaluate evaluates metrics export rules against the input key and creates
	// prometheus counters for new time series, if required. Returned observer can
	// be used to evaluate and observe particular samples.
	//
	// If there are no matching rules, the function returns false.
	Evaluate(*PutInput) (SampleObserver, bool)
}

MetricsExporter exports values of particular stack traces sample from profiling data as a Prometheus metrics.

type PutInput

type PutInput struct {
	StartTime       time.Time
	EndTime         time.Time
	Key             *segment.Key
	Val             *tree.Tree
	SpyName         string
	SampleRate      uint32
	Units           string
	AggregationType string
}

type SampleObserver

type SampleObserver interface {
	// Observe adds v to the matched counters if k satisfies node selector.
	// k is a sample stack trace where frames are delimited by semicolon.
	// v is the sample value.
	Observe(k []byte, v int)
}

type Storage

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

func New

func New(c *Config, logger *logrus.Logger, reg prometheus.Registerer) (*Storage, error)

func (*Storage) CacheStats

func (s *Storage) CacheStats() map[string]uint64

func (*Storage) Close

func (s *Storage) Close() error

func (*Storage) Delete

func (s *Storage) Delete(di *DeleteInput) error

func (*Storage) DeleteApp

func (s *Storage) DeleteApp(appname string) error

DeleteApp fully deletes an app It does so by deleting Segments, Dictionaries, Trees, Dimensions and Labels It's an idempotent call, ie. if the app already does not exist, no error is triggered. TODO cancelation?

func (*Storage) DiskUsage

func (s *Storage) DiskUsage() map[string]bytesize.ByteSize

func (*Storage) EnforceRetentionPolicy

func (s *Storage) EnforceRetentionPolicy(rp *segment.RetentionPolicy) error

func (*Storage) Get

func (s *Storage) Get(gi *GetInput) (*GetOutput, error)

func (*Storage) GetAppNames

func (s *Storage) GetAppNames() []string

GetAppNames returns the list of all app's names

func (*Storage) GetKeys

func (s *Storage) GetKeys(cb func(string) bool)

func (*Storage) GetKeysByQuery

func (s *Storage) GetKeysByQuery(query string, cb func(_k string) bool) error

func (*Storage) GetValues

func (s *Storage) GetValues(key string, cb func(v string) bool)

func (*Storage) GetValuesByQuery

func (s *Storage) GetValuesByQuery(label string, query string, cb func(v string) bool) error

func (*Storage) InstallID

func (s *Storage) InstallID() string

func (*Storage) JWT

func (s *Storage) JWT() (string, error)

func (*Storage) Put

func (s *Storage) Put(pi *PutInput) error