stat

Documentation

Index

• Constants
• func ErrorOnly() counter.Provider
• func ErrorWrap(err error) errorWrap
• func NewCache() counter.Provider
• func NewClient() counter.Provider
• func NewCtxErrOnly() counter.Provider
• func NewHttp() counter.Provider
• func NewWrite() counter.Provider
• func TestMapping(t *testing.T, builder func() counter.Provider)
• type Count
  • func (c Count) Aggregate(value interface{})
• type Dir
  • func (_ Dir) Aggregate(value interface{})
• type E
• type GMeter
  • func DefaultGMeter(m *gmetric.Service) *GMeter
  • func (g *GMeter) MOp(location, name, desc string, p counter.Provider) *gmetric.Operation
  • func (g *GMeter) Op(location, name, desc string) *gmetric.Operation
• type Occupancy
  • func (a *Occupancy) Aggregate(value interface{})
• type Sum
  • func (s *Sum) Aggregate(value interface{})
• type TopK
  • func NewTopK(n, mod int) *TopK
  • func (k *TopK) Aggregate(value interface{})
• type Values
  • func NewValues() *Values
  • func (v *Values) Append(item interface{})
  • func (v *Values) AppendError(err error)
  • func (v *Values) Values() []interface{}

Constants

const (
	// Not deprecated since still used in other metrics
	NoSuchKey = "noKey"

	// Deprecated due to complications
	HasValue = "hasValue"
	CacheHit = "cacheHit"

	CacheCollision = "collision"
	CacheExpired   = "expired"
	LocalHasValue  = "localHasValue"
	LocalNoSuchKey = "localNoKey"

	L1NoSuchKey = "L1NoKey"
	L1HasValue  = "L1HasValue"
	L2NoSuchKey = "L2NoKey"
	L1Copy      = "L1Copy"

	// Aerospike Errors - still complicated
	Timeout = "timeout"
	Down    = "down"
)

const (
	ErrorKey = "error"
	// Context errors
	Canceled         = "canceled"
	DeadlineExceeded = "deadlineExceeded"
)

const (
	Enter = Dir(true)
	Exit  = Dir(false)
)

const (
	L1Write = "L1Write"
	L2Write = "L2Write"
)

const (
	EarlyCtxError = "ctx"
)

const Pending = "pending"

Functions

func ErrorOnly

func ErrorOnly() counter.Provider

func ErrorWrap

func ErrorWrap(err error) errorWrap

func NewCache

func NewCache() counter.Provider

func NewClient

func NewClient() counter.Provider

func NewCtxErrOnly

func NewCtxErrOnly() counter.Provider

func NewHttp

func NewHttp() counter.Provider

func NewWrite

func NewWrite() counter.Provider

func TestMapping

func TestMapping(t *testing.T, builder func() counter.Provider)

TestMapping checks to ensure that a standard 1-to-1 mapping between keys and values exists.

Types

type Count

type Count uint64

func (Count) Aggregate

func (c Count) Aggregate(value interface{})

Implements counter.CustomCounter so that it can be used by counter.CustomCounter

type Dir

type Dir bool

Dir (direction) should be true if this is an enter event; otherwise should be false. It is expected that every Dir has an Exit, but that may not always happen.

func (Dir) Aggregate

func (_ Dir) Aggregate(value interface{})

Implements counter.CustomCounter so that it can be passed to Occupancy, representing the element side of reduce.

type E

type E struct {
	Error string
	Count uint64
}

type GMeter

type GMeter struct {
	*gmetric.Service

	Unit           time.Duration
	RecentDuration time.Duration
	NumRecent      int
}

func DefaultGMeter

func DefaultGMeter(m *gmetric.Service) *GMeter

func (*GMeter) MOp

func (g *GMeter) MOp(location, name, desc string, p counter.Provider) *gmetric.Operation

func (*GMeter) Op

func (g *GMeter) Op(location, name, desc string) *gmetric.Operation

type Occupancy

type Occupancy struct {
	// Members are exposed due to how gmetrics operates.
	Max uint64 `json:",omitempty"`
	// contains filtered or unexported fields
}

Occupancy keeps track of in-out metrics (not input-output); in-out counters are numbers that track the number of start and end events; with a focus on tracking the maximum number of starts without an end event.

func (*Occupancy) Aggregate

func (a *Occupancy) Aggregate(value interface{})

Aggregate implements counter.CustomCounter, but represents the aggregate side.

type Sum

type Sum struct {
	Total uint64 `json:",omitempty"`
}

TODO consider https://github.com/beorn7/perks

func (*Sum) Aggregate

func (s *Sum) Aggregate(value interface{})

type TopK

type TopK struct {
	Top []E
	// contains filtered or unexported fields
}

func NewTopK

func NewTopK(n, mod int) *TopK

func (*TopK) Aggregate

func (k *TopK) Aggregate(value interface{})

implements github.com/viant/gmetric/counter.CustomCounter

type Values

type Values []interface{}

Values is a utility to pass multiple events to gmetric.

func NewValues

func NewValues() *Values

func (*Values) Append

func (v *Values) Append(item interface{})

func (*Values) AppendError

func (v *Values) AppendError(err error)

func (*Values) Values

func (v *Values) Values() []interface{}