package metrics import ( "sync" "time" ) // Meters count events to produce exponentially-weighted moving average rates // at one-, five-, and fifteen-minutes and a mean rate. type Meter interface { Count() int64 Mark(int64) Rate1() float64 Rate5() float64 Rate15() float64 RateMean() float64 Snapshot() Meter } // GetOrRegisterMeter returns an existing Meter or constructs and registers a // new StandardMeter. func GetOrRegisterMeter(name string, r Registry) Meter { if nil == r { r = DefaultRegistry } return r.GetOrRegister(name, NewMeter).(Meter) } // GetOrRegisterMeterForced returns an existing Meter or constructs and registers a // new StandardMeter no matter the global switch is enabled or not. func GetOrRegisterMeterForced(name string, r Registry) Meter { if nil == r { r = DefaultRegistry } return r.GetOrRegister(name, NewMeterForced).(Meter) } // NewMeter constructs a new StandardMeter and launches a goroutine. func NewMeter() Meter { if !Enabled { return NilMeter{} } return newStandardMeter() } // NewMeterForced constructs a new StandardMeter and launches a goroutine no matter // the global switch is enabled or not. func NewMeterForced() Meter { return newStandardMeter() } // NewRegisteredMeter constructs and registers a new StandardMeter // and launches a goroutine. func NewRegisteredMeter(name string, r Registry) Meter { c := NewMeter() if nil == r { r = DefaultRegistry } r.Register(name, c) return c } // NewRegisteredMeterForced constructs and registers a new StandardMeter // and launches a goroutine no matter the global switch is enabled or not. func NewRegisteredMeterForced(name string, r Registry) Meter { c := NewMeterForced() if nil == r { r = DefaultRegistry } r.Register(name, c) return c } // MeterSnapshot is a read-only copy of another Meter. type MeterSnapshot struct { count int64 rate1, rate5, rate15, rateMean float64 } // Count returns the count of events at the time the snapshot was taken. func (m *MeterSnapshot) Count() int64 { return m.count } // Mark panics. func (*MeterSnapshot) Mark(n int64) { panic("Mark called on a MeterSnapshot") } // Rate1 returns the one-minute moving average rate of events per second at the // time the snapshot was taken. func (m *MeterSnapshot) Rate1() float64 { return m.rate1 } // Rate5 returns the five-minute moving average rate of events per second at // the time the snapshot was taken. func (m *MeterSnapshot) Rate5() float64 { return m.rate5 } // Rate15 returns the fifteen-minute moving average rate of events per second // at the time the snapshot was taken. func (m *MeterSnapshot) Rate15() float64 { return m.rate15 } // RateMean returns the meter's mean rate of events per second at the time the // snapshot was taken. func (m *MeterSnapshot) RateMean() float64 { return m.rateMean } // Snapshot returns the snapshot. func (m *MeterSnapshot) Snapshot() Meter { return m } // NilMeter is a no-op Meter. type NilMeter struct{} // Count is a no-op. func (NilMeter) Count() int64 { return 0 } // Mark is a no-op. func (NilMeter) Mark(n int64) {} // Rate1 is a no-op. func (NilMeter) Rate1() float64 { return 0.0 } // Rate5 is a no-op. func (NilMeter) Rate5() float64 { return 0.0 } // Rate15 is a no-op. func (NilMeter) Rate15() float64 { return 0.0 } // RateMean is a no-op. func (NilMeter) RateMean() float64 { return 0.0 } // Snapshot is a no-op. func (NilMeter) Snapshot() Meter { return NilMeter{} } // StandardMeter is the standard implementation of a Meter. type StandardMeter struct { lock sync.RWMutex count int64 a1, a5, a15 EWMA startTime time.Time } func newStandardMeter() *StandardMeter { return &StandardMeter{ a1: NewEWMA1(), a5: NewEWMA5(), a15: NewEWMA15(), startTime: time.Now(), } } // Count returns the number of events recorded. // It updates the meter to be as accurate as possible func (m *StandardMeter) Count() int64 { m.lock.RLock() defer m.lock.RUnlock() return m.count } // Mark records the occurrence of n events. func (m *StandardMeter) Mark(n int64) { m.lock.Lock() defer m.lock.Unlock() m.count += n m.a1.Update(n) m.a5.Update(n) m.a15.Update(n) } // Rate1 returns the one-minute moving average rate of events per second. func (m *StandardMeter) Rate1() float64 { return m.a1.Rate() } // Rate5 returns the five-minute moving average rate of events per second. func (m *StandardMeter) Rate5() float64 { return m.a5.Rate() } // Rate15 returns the fifteen-minute moving average rate of events per second. func (m *StandardMeter) Rate15() float64 { return m.a15.Rate() } // RateMean returns the meter's mean rate of events per second. func (m *StandardMeter) RateMean() float64 { m.lock.RLock() defer m.lock.RUnlock() return float64(m.count) / (1 + time.Since(m.startTime).Seconds()) } // Snapshot returns a read-only copy of the meter. func (m *StandardMeter) Snapshot() Meter { return &MeterSnapshot{ count: m.Count(), rate1: m.Rate1(), rate5: m.Rate5(), rate15: m.Rate15(), rateMean: m.RateMean(), } }