flow

Documentation

Index

• Variables
• type Meter
  • func (m *Meter) Mark(count uint64)
  • func (m *Meter) Snapshot() Snapshot
  • func (m *Meter) String() string
• type MeterRegistry
  • func (r *MeterRegistry) ForEach(iterFunc func(string, *Meter))
  • func (r *MeterRegistry) Get(name string) *Meter
  • func (r *MeterRegistry) Remove(name string)
• type Snapshot
  • func (s Snapshot) String() string

Variables

var IdleRate = 1e-13

IdleRate the rate at which we declare a meter idle (and stop tracking it until it's re-registered).

The default ensures that 1 event every ~30s will keep the meter from going idle.

Types

type Meter

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

Meter is a meter for monitoring a flow.

func (*Meter) Mark

func (m *Meter) Mark(count uint64)

Mark updates the total.

func (*Meter) Snapshot

func (m *Meter) Snapshot() Snapshot

Snapshot gets a consistent snapshot of the total and rate.

func (*Meter) String

func (m *Meter) String() string

type MeterRegistry

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

MeterRegistry is a registry for named meters.

func (*MeterRegistry) ForEach

func (r *MeterRegistry) ForEach(iterFunc func(string, *Meter))

ForEach calls the passed function for each registered meter.

func (*MeterRegistry) Get

func (r *MeterRegistry) Get(name string) *Meter

Get gets (or creates) a meter by name.

func (*MeterRegistry) Remove

func (r *MeterRegistry) Remove(name string)

Remove removes the named meter from the registry.

Note: The only reason to do this is to save a bit of memory. Unused meters don't consume any CPU (after they go idle).

type Snapshot

type Snapshot struct {
	Rate  float64
	Total uint64
}

Snapshot is a rate/total snapshot.

func (Snapshot) String

func (s Snapshot) String() string