-
Notifications
You must be signed in to change notification settings - Fork 20.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
metrics: add cpu counters #26796
metrics: add cpu counters #26796
Changes from 7 commits
499f1af
a013a5c
e91a75f
f20aed1
1416574
e848132
1255fc1
32b976b
ce73844
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,153 @@ | ||
package metrics | ||
|
||
import ( | ||
"sync" | ||
) | ||
|
||
// CounterFloat64 holds a float64 value that can be incremented and decremented. | ||
type CounterFloat64 interface { | ||
Clear() | ||
Value() float64 | ||
Dec(float64) | ||
Inc(float64) | ||
Snapshot() CounterFloat64 | ||
} | ||
|
||
// GetOrRegisterCounterFloat64 returns an existing CounterFloat64 or constructs and registers | ||
// a new StandardCounterFloat64. | ||
func GetOrRegisterCounterFloat64(name string, r Registry) CounterFloat64 { | ||
if nil == r { | ||
r = DefaultRegistry | ||
} | ||
return r.GetOrRegister(name, NewCounterFloat64).(CounterFloat64) | ||
} | ||
|
||
// GetOrRegisterCounterFloat64Forced returns an existing CounterFloat64 or constructs and registers a | ||
// new CounterFloat64 no matter the global switch is enabled or not. | ||
// Be sure to unregister the counter from the registry once it is of no use to | ||
// allow for garbage collection. | ||
func GetOrRegisterCounterFloat64Forced(name string, r Registry) CounterFloat64 { | ||
if nil == r { | ||
r = DefaultRegistry | ||
} | ||
return r.GetOrRegister(name, NewCounterFloat64Forced).(CounterFloat64) | ||
} | ||
|
||
// NewCounterFloat64 constructs a new StandardCounterFloat64. | ||
func NewCounterFloat64() CounterFloat64 { | ||
if !Enabled { | ||
return NilCounterFloat64{} | ||
} | ||
return &StandardCounterFloat64{value: 0.0} | ||
} | ||
|
||
// NewCounterFloat64Forced constructs a new StandardCounterFloat64 and returns it no matter if | ||
// the global switch is enabled or not. | ||
func NewCounterFloat64Forced() CounterFloat64 { | ||
return &StandardCounterFloat64{value: 0.0} | ||
} | ||
|
||
// NewRegisteredCounterFloat64 constructs and registers a new StandardCounterFloat64. | ||
func NewRegisteredCounterFloat64(name string, r Registry) CounterFloat64 { | ||
c := NewCounterFloat64() | ||
if nil == r { | ||
r = DefaultRegistry | ||
} | ||
r.Register(name, c) | ||
return c | ||
} | ||
|
||
// NewRegisteredCounterFloat64Forced constructs and registers a new StandardCounterFloat64 | ||
// and launches a goroutine no matter the global switch is enabled or not. | ||
// Be sure to unregister the counter from the registry once it is of no use to | ||
// allow for garbage collection. | ||
func NewRegisteredCounterFloat64Forced(name string, r Registry) CounterFloat64 { | ||
c := NewCounterFloat64Forced() | ||
if nil == r { | ||
r = DefaultRegistry | ||
} | ||
r.Register(name, c) | ||
return c | ||
} | ||
|
||
// CounterFloat64Snapshot is a read-only copy of another CounterFloat64. | ||
type CounterFloat64Snapshot float64 | ||
|
||
// Clear panics. | ||
func (CounterFloat64Snapshot) Clear() { | ||
panic("Clear called on a CounterFloat64Snapshot") | ||
} | ||
|
||
// Value returns the value at the time the snapshot was taken. | ||
func (c CounterFloat64Snapshot) Value() float64 { return float64(c) } | ||
|
||
// Dec panics. | ||
func (CounterFloat64Snapshot) Dec(float64) { | ||
panic("Dec called on a CounterFloat64Snapshot") | ||
} | ||
|
||
// Inc panics. | ||
func (CounterFloat64Snapshot) Inc(float64) { | ||
panic("Inc called on a CounterFloat64Snapshot") | ||
} | ||
|
||
// Snapshot returns the snapshot. | ||
func (c CounterFloat64Snapshot) Snapshot() CounterFloat64 { return c } | ||
|
||
// NilCounterFloat64 is a no-op CounterFloat64. | ||
type NilCounterFloat64 struct{} | ||
|
||
// Clear is a no-op. | ||
func (NilCounterFloat64) Clear() {} | ||
|
||
// Value is a no-op. | ||
func (NilCounterFloat64) Value() float64 { return 0.0 } | ||
|
||
// Dec is a no-op. | ||
func (NilCounterFloat64) Dec(i float64) {} | ||
|
||
// Inc is a no-op. | ||
func (NilCounterFloat64) Inc(i float64) {} | ||
|
||
// Snapshot is a no-op. | ||
func (NilCounterFloat64) Snapshot() CounterFloat64 { return NilCounterFloat64{} } | ||
|
||
// StandardCounterFloat64 is the standard implementation of a CounterFloat64 and uses the | ||
// sync.Mutex package to manage a single float64 value. | ||
type StandardCounterFloat64 struct { | ||
mutex sync.Mutex | ||
value float64 | ||
} | ||
|
||
// Clear sets the counter to zero. | ||
func (c *StandardCounterFloat64) Clear() { | ||
c.mutex.Lock() | ||
defer c.mutex.Unlock() | ||
c.value = 0.0 | ||
} | ||
|
||
// Value returns the current value. | ||
func (c *StandardCounterFloat64) Value() float64 { | ||
c.mutex.Lock() | ||
defer c.mutex.Unlock() | ||
return c.value | ||
} | ||
|
||
// Dec decrements the counter by the given amount. | ||
func (c *StandardCounterFloat64) Dec(v float64) { | ||
c.mutex.Lock() | ||
defer c.mutex.Unlock() | ||
c.value -= v | ||
} | ||
|
||
// Inc increments the counter by the given amount. | ||
func (c *StandardCounterFloat64) Inc(v float64) { | ||
c.mutex.Lock() | ||
defer c.mutex.Unlock() | ||
c.value += v | ||
} | ||
|
||
// Snapshot returns a read-only copy of the counter. | ||
func (c *StandardCounterFloat64) Snapshot() CounterFloat64 { | ||
return CounterFloat64Snapshot(c.Value()) | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
package metrics | ||
|
||
import "testing" | ||
|
||
func BenchmarkCounterFloat64(b *testing.B) { | ||
c := NewCounterFloat64() | ||
b.ResetTimer() | ||
for i := 0; i < b.N; i++ { | ||
c.Inc(1.0) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Clear(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Inc(1.0) | ||
c.Clear() | ||
if count := c.Value(); count != 0 { | ||
t.Errorf("c.Value(): 0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Dec1(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Dec(1.0) | ||
if count := c.Value(); count != -1.0 { | ||
t.Errorf("c.Value(): -1.0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Dec2(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Dec(2.0) | ||
if count := c.Value(); count != -2.0 { | ||
t.Errorf("c.Value(): -2.0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Inc1(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Inc(1.0) | ||
if count := c.Value(); count != 1.0 { | ||
t.Errorf("c.Value(): 1.0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Inc2(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Inc(2.0) | ||
if count := c.Value(); count != 2.0 { | ||
t.Errorf("c.Value(): 2.0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Snapshot(t *testing.T) { | ||
c := NewCounterFloat64() | ||
c.Inc(1.0) | ||
snapshot := c.Snapshot() | ||
c.Inc(1.0) | ||
if count := snapshot.Value(); count != 1.0 { | ||
t.Errorf("c.Value(): 1.0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestCounterFloat64Zero(t *testing.T) { | ||
c := NewCounterFloat64() | ||
if count := c.Value(); count != 0 { | ||
t.Errorf("c.Value(): 0 != %v\n", count) | ||
} | ||
} | ||
|
||
func TestGetOrRegisterCounterFloat64(t *testing.T) { | ||
r := NewRegistry() | ||
NewRegisteredCounterFloat64("foo", r).Inc(47.0) | ||
if c := GetOrRegisterCounterFloat64("foo", r); c.Value() != 47.0 { | ||
t.Fatal(c) | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -144,6 +144,9 @@ func CollectProcessMetrics(refresh time.Duration) { | |
cpuSysLoad = GetOrRegisterGauge("system/cpu/sysload", DefaultRegistry) | ||
cpuSysWait = GetOrRegisterGauge("system/cpu/syswait", DefaultRegistry) | ||
cpuProcLoad = GetOrRegisterGauge("system/cpu/procload", DefaultRegistry) | ||
cpuSysLoadTotal = GetOrRegisterCounterFloat64("system/cpu/sysload/total", DefaultRegistry) | ||
cpuSysWaitTotal = GetOrRegisterCounterFloat64("system/cpu/syswait/total", DefaultRegistry) | ||
cpuProcLoadTotal = GetOrRegisterCounterFloat64("system/cpu/procload/total", DefaultRegistry) | ||
cpuThreads = GetOrRegisterGauge("system/cpu/threads", DefaultRegistry) | ||
cpuGoroutines = GetOrRegisterGauge("system/cpu/goroutines", DefaultRegistry) | ||
cpuSchedLatency = getOrRegisterRuntimeHistogram("system/cpu/schedlatency", secondsToNs, nil) | ||
|
@@ -172,13 +175,17 @@ func CollectProcessMetrics(refresh time.Duration) { | |
secondsSinceLastCollect := collectTime.Sub(lastCollectTime).Seconds() | ||
lastCollectTime = collectTime | ||
if secondsSinceLastCollect > 0 { | ||
sysLoad := (cpustats[now].GlobalTime - cpustats[prev].GlobalTime) / secondsSinceLastCollect | ||
sysWait := (cpustats[now].GlobalWait - cpustats[prev].GlobalWait) / secondsSinceLastCollect | ||
procLoad := (cpustats[now].LocalTime - cpustats[prev].LocalTime) / secondsSinceLastCollect | ||
sysLoad := cpustats[now].GlobalTime - cpustats[prev].GlobalTime | ||
sysWait := cpustats[now].GlobalWait - cpustats[prev].GlobalWait | ||
procLoad := cpustats[now].LocalTime - cpustats[prev].LocalTime | ||
// Convert to integer percentage. | ||
cpuSysLoad.Update(int64(sysLoad * 100)) | ||
cpuSysWait.Update(int64(sysWait * 100)) | ||
cpuProcLoad.Update(int64(procLoad * 100)) | ||
cpuSysLoad.Update(int64(sysLoad / secondsSinceLastCollect * 100)) | ||
cpuSysWait.Update(int64(sysWait / secondsSinceLastCollect * 100)) | ||
cpuProcLoad.Update(int64(procLoad / secondsSinceLastCollect * 100)) | ||
// increment counters (ms) | ||
cpuSysLoadTotal.Inc(sysLoad) | ||
cpuSysWaitTotal.Inc(sysWait) | ||
cpuProcLoadTotal.Inc(procLoad) | ||
Comment on lines
+186
to
+188
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't these be divided by the time since last collect? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No they should not. The gauges contain the fraction (percentage) of time in which the CPU was active. The counters contain the total CPU time in seconds. |
||
} | ||
|
||
// Threads | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be called
count
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, as I mentioned above, I decided to rename the value field to
Value
. Are you guys ok with that?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be called
count
in exported metrics because it's a counter. The internal method name can beValue
orCount
, it doesn't matter that much to me.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could always change it back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll change it back to count. It is better to be consistent with the existing int64 counter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fjl Hey, I hope you don't think I was beig a jerk when I said "I could always change it back" right after you explicitly said that is what I should do. Maybe it came across that way. What happened was, your comment of "It should be called count ..." hadn't come up on my screen yet for some reason, so I was just kind of talking into the void. When I finally saw your comment, I was like "Oh oh. My comment probably didn't come across very well!"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, please don't worry! I think it's great that you are contributing this code. The reason why it's not merged yet, is that I wanted to test it on my node, but haven't gotten around to that yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, no rush.