stats

Documentation

Index

• type QueryStats
  • func NewQueryStats(tracker QueryStatsTracker) QueryStats
  • func NoOpQueryStats() QueryStats
• type QueryStatsTracker
  • func DefaultQueryStatsTrackerForMetrics(opts instrument.Options) QueryStatsTracker
• type QueryStatsValues

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 QueryStatsTracker

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

QueryStatsTracker provides an interface for tracking current query stats.

func DefaultQueryStatsTrackerForMetrics

func DefaultQueryStatsTrackerForMetrics(opts instrument.Options) QueryStatsTracker

DefaultQueryStatsTrackerForMetrics provides a tracker implementation that emits query stats as metrics.

type QueryStatsValues

type QueryStatsValues struct {
	RecentDocs int64
	NewDocs    int64
}

QueryStatsValues stores values of query stats.