stats

Documentation

Index

• Constants
• type QueryStats
  • func NewQueryStats(tracker QueryStatsTracker) QueryStats
  • func NoOpQueryStats() QueryStats
• type QueryStatsOptions
  • func (opts QueryStatsOptions) Validate() error
• type QueryStatsTracker
  • func DefaultQueryStatsTracker(instrumentOpts instrument.Options, queryStatsOpts QueryStatsOptions) QueryStatsTracker
• type QueryStatsValues

Constants

const DefaultLookback = time.Second * 5

DefaultLookback is the default lookback used for query stats tracking.

Types

type QueryStats

type QueryStats interface {
	Update(newDocs int) error
	Start()
	Stop()
}

QueryStats provides an interface for updating query stats.

func NewQueryStats

func NewQueryStats(tracker QueryStatsTracker) QueryStats

NewQueryStats enables query stats to be tracked within a recency lookback duration.

func NoOpQueryStats

func NoOpQueryStats() QueryStats

NoOpQueryStats returns inactive query stats.

type QueryStatsOptions

type QueryStatsOptions struct {
	// MaxDocs limits how many recently queried max
	// documents are allowed before queries are abandoned.
	MaxDocs int64
	// Lookback specifies the lookback period over which stats are aggregated.
	Lookback time.Duration
}

QueryStatsOptions holds options for how a tracker should handle query stats.

func (QueryStatsOptions) Validate

func (opts QueryStatsOptions) Validate() error

Validate returns an error if the query stats options are invalid.

type QueryStatsTracker

type QueryStatsTracker interface {
	Lookback() time.Duration
	TrackStats(stats QueryStatsValues) error
}

QueryStatsTracker provides an interface for tracking current query stats.

func DefaultQueryStatsTracker

func DefaultQueryStatsTracker(
	instrumentOpts instrument.Options,
	queryStatsOpts QueryStatsOptions,
) QueryStatsTracker

DefaultQueryStatsTracker provides a tracker implementation that emits query stats as metrics and enforces limits.

type QueryStatsValues

type QueryStatsValues struct {
	RecentDocs int64
	NewDocs    int64
}

QueryStatsValues stores values of query stats.