metrics

Documentation

Index

• Constants
• type CacheSizeFunction
• type Metric
  • func (metric *Metric) Clear() *Metric
  • func (metric *Metric) Inc(byValue int64) *Metric
  • func (metric *Metric) Set(newValue int64) *Metric
  • func (metric *Metric) Value() int64
• type Metrics
  • func New(config *config.GudgeonConfig) Metrics
• type MetricsEntry

Constants

const (
	// metrics prefix
	MetricsPrefix = "gudgeon-"
	// metrics names are prefixed by the metrics prefix and delim
	TotalRules             = "active-rules"
	TotalQueries           = "total-session-queries"
	TotalLifetimeQueries   = "total-lifetime-queries"
	TotalIntervalQueries   = "total-interval-queries"
	CachedQueries          = "cached-queries"
	BlockedQueries         = "blocked-session-queries"
	BlockedLifetimeQueries = "blocked-lifetime-queries"
	BlockedIntervalQueries = "blocked-interval-queries"
	QueryTime              = "query-time"
	// cache entries
	CurrentCacheEntries = "cache-entries"
	// rutnime metrics
	GoRoutines         = "goroutines"
	CurrentlyAllocated = "allocated-bytes"    // heap allocation in go runtime stats
	UsedMemory         = "process-used-bytes" // from the process api
	FreeMemory         = "free-memory-bytes"
	SystemMemory       = "system-memory-bytes"
	// cpu metrics
	CPUHundredsPercent = "cpu-hundreds-percent" // 17 == 0.17 percent, expressed in integer terms
)

Types

type CacheSizeFunction

type CacheSizeFunction = func() int64

type Metric

type Metric struct {
	Count int64 `json:"count"`
}

func (*Metric) Clear

func (metric *Metric) Clear() *Metric

func (*Metric) Inc

func (metric *Metric) Inc(byValue int64) *Metric

func (*Metric) Set

func (metric *Metric) Set(newValue int64) *Metric

func (*Metric) Value

func (metric *Metric) Value() int64

type Metrics

type Metrics interface {
	GetAll() map[string]*Metric
	Get(name string) *Metric

	// use cache function
	UseCacheSizeFunction(function CacheSizeFunction)

	// record relevant metrics based on request
	RecordQueryMetrics(request *dns.Msg, response *dns.Msg, rCon *resolver.RequestContext, result *resolver.ResolutionResult)

	// Query metrics from db
	Query(start time.Time, end time.Time) ([]*MetricsEntry, error)

	// stop
	Stop()
}

func New

func New(config *config.GudgeonConfig) Metrics

type MetricsEntry

type MetricsEntry struct {
	FromTime        time.Time
	AtTime          time.Time
	Values          map[string]*Metric
	IntervalSeconds int
}