Cpufreq plugin #4215
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # CPUFreq Input Plugin For Telegraf Agent | ||
|
|
||
| The CPUFreq plugin collects the current CPU's frequency. This plugin work only with linux. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ```toml | ||
| [[inputs.cpufreq]] | ||
| ## Path for sysfs filesystem. | ||
| ## See https://www.kernel.org/doc/Documentation/filesystems/sysfs.txt | ||
| ## Defaults: | ||
| # host_sys = "/sys" | ||
| ## Gather CPU throttles per core | ||
| ## Defaults: | ||
| # gather_throttles = false | ||
| ``` | ||
|
|
||
| ## Example output | ||
|
|
||
| ``` | ||
| > cpufreq,cpu=0,host=server01 cur_freq=3756293000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=1,host=server01 cur_freq=3735119000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=2,host=server01 cur_freq=3786381000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=3,host=server01 cur_freq=3823190000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=4,host=server01 cur_freq=3780804000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=5,host=server01 cur_freq=3801758000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=6,host=server01 cur_freq=3839194000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
| > cpufreq,cpu=7,host=server01 cur_freq=3877989000i,max_freq=3900000000i,min_freq=800000000i,throttle_count=0i 1527789803000000000 | ||
|
Comment on lines
+21
to
+28
There was a problem hiding this comment. How about renaming |
||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,116 @@ | ||||||||
| package cpufreq | ||||||||
|
There was a problem hiding this comment. As this only works on linux, please make sure it only builds on linux.
Suggested change
There was a problem hiding this comment. @R4scal To build (but not include in binary) your plugin succesfully for non-Linux systems. Look at systtat plugin: https://github.com/influxdata/telegraf/tree/f7d94430d29d15c42d8d186c99bfd065b9a21fa0/plugins/inputs/sysstat |
||||||||
|
|
||||||||
| import ( | ||||||||
| "io/ioutil" | ||||||||
| "os" | ||||||||
| "path" | ||||||||
| "path/filepath" | ||||||||
| "strconv" | ||||||||
| "strings" | ||||||||
|
|
||||||||
| "github.com/influxdata/telegraf" | ||||||||
| "github.com/influxdata/telegraf/plugins/inputs" | ||||||||
| ) | ||||||||
|
|
||||||||
| const defaultHostSys = "/sys" | ||||||||
|
|
||||||||
| type CPUFreq struct { | ||||||||
| PathSysfs string `toml:"host_sys"` | ||||||||
| GatherThrottles bool `toml:"gather_throttles"` | ||||||||
| } | ||||||||
|
|
||||||||
| var sampleConfig = ` | ||||||||
| ## Path for sysfs filesystem. | ||||||||
| ## See https://www.kernel.org/doc/Documentation/filesystems/sysfs.txt | ||||||||
| ## Defaults: | ||||||||
| # host_sys = "/sys" | ||||||||
| ## Gather CPU throttles per core | ||||||||
| ## Defaults: | ||||||||
| # gather_throttles = false | ||||||||
| ` | ||||||||
|
|
||||||||
| func (g *CPUFreq) SampleConfig() string { | ||||||||
| return sampleConfig | ||||||||
| } | ||||||||
|
|
||||||||
| func (g *CPUFreq) Description() string { | ||||||||
| return "Read specific statistics per cgroup" | ||||||||
|
There was a problem hiding this comment. Probably
Suggested change
would be better, wouldn't it? |
||||||||
| } | ||||||||
|
|
||||||||
| func (g *CPUFreq) Gather(acc telegraf.Accumulator) error { | ||||||||
|
|
||||||||
| if g.PathSysfs == "" { | ||||||||
| if os.Getenv("HOST_SYS") != "" { | ||||||||
| g.PathSysfs = os.Getenv("HOST_SYS") | ||||||||
|
Comment on lines
+43
to
+44
There was a problem hiding this comment. Is |
||||||||
| } else { | ||||||||
| g.PathSysfs = defaultHostSys | ||||||||
| } | ||||||||
| } | ||||||||
|
Comment on lines
+42
to
+48
There was a problem hiding this comment. Move this to an |
||||||||
|
|
||||||||
| cpus, err := filepath.Glob(path.Join(g.PathSysfs, "devices/system/cpu/cpu[0-9]*")) | ||||||||
| if err != nil { | ||||||||
| acc.AddError(err) | ||||||||
|
There was a problem hiding this comment.
|
||||||||
| } | ||||||||
|
|
||||||||
| var value uint64 | ||||||||
| // cpu loop | ||||||||
| for _, cpu := range cpus { | ||||||||
| fileds := make(map[string]interface{}) | ||||||||
| tags := make(map[string]string) | ||||||||
|
|
||||||||
| _, cpuName := filepath.Split(cpu) | ||||||||
| cpuNum := strings.TrimPrefix(cpuName, "cpu") | ||||||||
|
|
||||||||
| tags["cpu"] = cpuNum | ||||||||
|
|
||||||||
| // sysfs cpufreq values are kHz, thus multiply by 1000 to export base units (hz). | ||||||||
| if _, err := os.Stat(filepath.Join(cpu, "cpufreq")); os.IsNotExist(err) { | ||||||||
| acc.AddError(err) | ||||||||
| } else { | ||||||||
|
Comment on lines
+68
to
+69
There was a problem hiding this comment. Put a `continue here and remove the else saving one indentation level. |
||||||||
| if value, err = readUintFromFile(filepath.Join(cpu, "cpufreq", "scaling_cur_freq")); err != nil { | ||||||||
| acc.AddError(err) | ||||||||
| continue | ||||||||
| } else { | ||||||||
|
|
||||||||
| fileds["cur_freq"] = uint64(value) * 1000 | ||||||||
|
|
||||||||
| } | ||||||||
| if value, err = readUintFromFile(filepath.Join(cpu, "cpufreq", "scaling_min_freq")); err != nil { | ||||||||
| acc.AddError(err) | ||||||||
| } else { | ||||||||
|
There was a problem hiding this comment. Use |
||||||||
| fileds["min_freq"] = uint64(value) * 1000 | ||||||||
| } | ||||||||
| if value, err = readUintFromFile(filepath.Join(cpu, "cpufreq", "scaling_max_freq")); err != nil { | ||||||||
| acc.AddError(err) | ||||||||
| } else { | ||||||||
| fileds["max_freq"] = uint64(value) * 1000 | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| if g.GatherThrottles { | ||||||||
| if value, err := readUintFromFile(filepath.Join(cpu, "thermal_throttle", "core_throttle_count")); err != nil { | ||||||||
| acc.AddError(err) | ||||||||
| } else { | ||||||||
| fileds["throttle_count"] = uint64(value) | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| acc.AddFields("cpufreq", fileds, tags) | ||||||||
| } | ||||||||
|
|
||||||||
| return nil | ||||||||
| } | ||||||||
|
|
||||||||
| func init() { | ||||||||
| inputs.Add("cpufreq", func() telegraf.Input { return &CPUFreq{} }) | ||||||||
| } | ||||||||
|
|
||||||||
| func readUintFromFile(path string) (uint64, error) { | ||||||||
| data, err := ioutil.ReadFile(path) | ||||||||
| if err != nil { | ||||||||
| return 0, err | ||||||||
| } | ||||||||
| value, err := strconv.ParseUint(strings.TrimSpace(string(data)), 10, 64) | ||||||||
| if err != nil { | ||||||||
| return 0, err | ||||||||
| } | ||||||||
| return value, nil | ||||||||
| } | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| package cpufreq | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/influxdata/telegraf/testutil" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestCPUFreq_NoThrottles(t *testing.T) { | ||
| var acc testutil.Accumulator | ||
| var cpufreq = &CPUFreq{ | ||
| PathSysfs: "testdata", | ||
| } | ||
|
|
||
| err := acc.GatherError(cpufreq.Gather) | ||
| require.NoError(t, err) | ||
|
|
||
| // CPU 0 Core 0 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597101000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "0", | ||
| }, | ||
| ) | ||
| // CPU 1 Core 0 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597027000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "1", | ||
| }, | ||
| ) | ||
| // CPU 0 Core 1 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597328000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "2", | ||
| }, | ||
| ) | ||
| // CPU 1 Core 1 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597176000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "3", | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func TestCPUFreq_WithThrottles(t *testing.T) { | ||
| var acc testutil.Accumulator | ||
| var cpufreq = &CPUFreq{ | ||
| PathSysfs: "testdata", | ||
| GatherThrottles: true, | ||
| } | ||
|
|
||
| err := acc.GatherError(cpufreq.Gather) | ||
| require.NoError(t, err) | ||
|
|
||
| // CPU 0 Core 0 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597101000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| "throttle_count": uint64(0), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "0", | ||
| }, | ||
| ) | ||
| // CPU 1 Core 0 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597027000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| "throttle_count": uint64(0), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "1", | ||
| }, | ||
| ) | ||
| // CPU 0 Core 1 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597328000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| "throttle_count": uint64(0), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "2", | ||
| }, | ||
| ) | ||
| // CPU 1 Core 1 | ||
| acc.AssertContainsTaggedFields(t, | ||
| "cpufreq", | ||
| map[string]interface{}{ | ||
| "cur_freq": uint64(2597176000), | ||
| "max_freq": uint64(3400000000), | ||
| "min_freq": uint64(1200000000), | ||
| "throttle_count": uint64(100), | ||
| }, | ||
| map[string]string{ | ||
| "cpu": "3", | ||
| }, | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 2597101 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3400000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1200000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 2597027 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3400000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1200000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 2597328 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3400000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1200000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 2597176 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3400000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1200000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 100 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Could you please add a Metric section describing the fields similar to #8342!?