remove cgo dependeny with forking sensors command

closes #1414
closes #649

CHANGELOG.md

@@ -80,6 +80,7 @@ consistent with the behavior of `collection_jitter`.
 - [#1296](https://github.com/influxdata/telegraf/issues/1296): Refactor of flush_jitter argument.
 - [#1213](https://github.com/influxdata/telegraf/issues/1213): Add inactive & active memory to mem plugin.
 - [#1543](https://github.com/influxdata/telegraf/pull/1543): Official Windows service.
+- [#1414](https://github.com/influxdata/telegraf/pull/1414): Forking sensors command to remove C package dependency.
 
 ### Bugfixes
 

README.md

@@ -188,7 +188,7 @@ Currently implemented sources:
 * [redis](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/redis)
 * [rethinkdb](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/rethinkdb)
 * [riak](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/riak)
-* [sensors ](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sensors) (only available if built from source)
+* [sensors](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sensors)
 * [snmp](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp)
 * [sql server](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sqlserver) (microsoft)
 * [twemproxy](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/twemproxy)

plugins/inputs/sensors/README.md

@@ -0,0 +1,47 @@
+# sensors Input Plugin
+
+Collect [lm-sensors](https://en.wikipedia.org/wiki/Lm_sensors) metrics - requires the lm-sensors
+package installed.
+
+This plugin collects sensor metrics with the `sensors` executable from the lm-sensor package.
+
+### Configuration:
+```
+# Monitor sensors, requires lm-sensors package
+[[inputs.sensors]]
+  ## Remove numbers from field names.
+  ## If true, a field name like 'temp1_input' will be changed to 'temp_input'.
+  # remove_numbers = true
+```
+
+### Measurements & Fields:
+Fields are created dynamicaly depending on the sensors. All fields are float.
+
+### Tags:
+
+- All measurements have the following tags:
+    - chip
+    - feature
+
+### Example Output:
+
+#### Default
+```
+$ telegraf -config telegraf.conf -input-filter sensors -test
+* Plugin: sensors, Collection 1
+> sensors,chip=power_meter-acpi-0,feature=power1 power_average=0,power_average_interval=300 1466751326000000000
+> sensors,chip=k10temp-pci-00c3,feature=temp1 temp_crit=70,temp_crit_hyst=65,temp_input=29,temp_max=70 1466751326000000000
+> sensors,chip=k10temp-pci-00cb,feature=temp1 temp_input=29,temp_max=70 1466751326000000000
+> sensors,chip=k10temp-pci-00d3,feature=temp1 temp_input=27.5,temp_max=70 1466751326000000000
+> sensors,chip=k10temp-pci-00db,feature=temp1 temp_crit=70,temp_crit_hyst=65,temp_input=29.5,temp_max=70 1466751326000000000
+```
+
+#### With remove_numbers=false
+```
+* Plugin: sensors, Collection 1
+> sensors,chip=power_meter-acpi-0,feature=power1 power1_average=0,power1_average_interval=300 1466753424000000000
+> sensors,chip=k10temp-pci-00c3,feature=temp1 temp1_crit=70,temp1_crit_hyst=65,temp1_input=29.125,temp1_max=70 1466753424000000000
+> sensors,chip=k10temp-pci-00cb,feature=temp1 temp1_input=29,temp1_max=70 1466753424000000000
+> sensors,chip=k10temp-pci-00d3,feature=temp1 temp1_input=29.5,temp1_max=70 1466753424000000000
+> sensors,chip=k10temp-pci-00db,feature=temp1 temp1_crit=70,temp1_crit_hyst=65,temp1_input=30,temp1_max=70 1466753424000000000
+```

plugins/inputs/sensors/sensors.go

@@ -1,91 +1,118 @@
-// +build linux,sensors
+// +build linux
 
 package sensors
 
 import (
+	"errors"
+	"fmt"
+	"os/exec"
+	"regexp"
+	"strconv"
 	"strings"
-
+	"time"
-	"github.com/md14454/gosensors"
 
 	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/internal"
 	"github.com/influxdata/telegraf/plugins/inputs"
 )
 
+var (
+	execCommand = exec.Command // execCommand is used to mock commands in tests.
+	numberRegp  = regexp.MustCompile("[0-9]+")
+)
+
 type Sensors struct {
-	Sensors []string
+	RemoveNumbers bool `toml:"remove_numbers"`
+	path          string
 }
 
-func (_ *Sensors) Description() string {
+func (*Sensors) Description() string {
-	return "Monitor sensors using lm-sensors package"
+	return "Monitor sensors, requires lm-sensors package"
 }
 
-var sensorsSampleConfig = `
+func (*Sensors) SampleConfig() string {
-  ## By default, telegraf gathers stats from all sensors detected by the
+	return `
-  ## lm-sensors module.
+  ## Remove numbers from field names.
-  ##
+  ## If true, a field name like 'temp1_input' will be changed to 'temp_input'.
-  ## Only collect stats from the selected sensors. Sensors are listed as
+  # remove_numbers = true
-  ## <chip name>:<feature name>. This information can be found by running the
-  ## sensors command, e.g. sensors -u
-  ##
-  ## A * as the feature name will return all features of the chip
-  ##
-  # sensors = ["coretemp-isa-0000:Core 0", "coretemp-isa-0001:*"]
 `
 
-func (_ *Sensors) SampleConfig() string {
-	return sensorsSampleConfig
 }
 
 func (s *Sensors) Gather(acc telegraf.Accumulator) error {
-	gosensors.Init()
+	if len(s.path) == 0 {
-	defer gosensors.Cleanup()
+		return errors.New("sensors not found: verify that lm-sensors package is installed and that sensors is in your PATH")
-
-	for _, chip := range gosensors.GetDetectedChips() {
-		for _, feature := range chip.GetFeatures() {
-			chipName := chip.String()
-			featureLabel := feature.GetLabel()
-
-			if len(s.Sensors) != 0 {
-				var found bool
-
-				for _, sensor := range s.Sensors {
-					parts := strings.SplitN(sensor, ":", 2)
-
-					if parts[0] == chipName {
-						if parts[1] == "*" || parts[1] == featureLabel {
-							found = true
-							break
-						}
-					}
 	}
 
-				if !found {
+	return s.parse(acc)
+}
+
+// parse forks the command:
+//     sensors -u -A
+// and parses the output to add it to the telegraf.Accumulator.
+func (s *Sensors) parse(acc telegraf.Accumulator) error {
+	tags := map[string]string{}
+	fields := map[string]interface{}{}
+	chip := ""
+	cmd := execCommand(s.path, "-A", "-u")
+	out, err := internal.CombinedOutputTimeout(cmd, time.Second*5)
+	if err != nil {
+		return fmt.Errorf("failed to run command %s: %s - %s", strings.Join(cmd.Args, " "), err, string(out))
+	}
+	lines := strings.Split(strings.TrimSpace(string(out)), "\n")
+	for _, line := range lines {
+		if len(line) == 0 {
+			acc.AddFields("sensors", fields, tags)
+			chip = ""
+			tags = map[string]string{}
+			fields = map[string]interface{}{}
 			continue
 		}
+		if len(chip) == 0 {
+			chip = line
+			tags["chip"] = chip
+			continue
 		}
-
+		if !strings.HasPrefix(line, " ") {
-			tags := map[string]string{
+			if len(tags) > 1 {
-				"chip":          chipName,
-				"adapter":       chip.AdapterName(),
-				"feature-name":  feature.Name,
-				"feature-label": featureLabel,
-			}
-
-			fieldName := chipName + ":" + featureLabel
-
-			fields := map[string]interface{}{
-				fieldName: feature.GetValue(),
-			}
-
 				acc.AddFields("sensors", fields, tags)
 			}
+			fields = map[string]interface{}{}
+			tags = map[string]string{
+				"chip":    chip,
+				"feature": strings.TrimRight(snake(line), ":"),
 			}
-
+		} else {
+			splitted := strings.Split(line, ":")
+			fieldName := strings.TrimSpace(splitted[0])
+			if s.RemoveNumbers {
+				fieldName = numberRegp.ReplaceAllString(fieldName, "")
+			}
+			fieldValue, err := strconv.ParseFloat(strings.TrimSpace(splitted[1]), 64)
+			if err != nil {
+				return err
+			}
+			fields[fieldName] = fieldValue
+		}
+	}
+	acc.AddFields("sensors", fields, tags)
 	return nil
 }
 
 func init() {
+	s := Sensors{
+		RemoveNumbers: true,
+	}
+	path, _ := exec.LookPath("sensors")
+	if len(path) > 0 {
+		s.path = path
+	}
 	inputs.Add("sensors", func() telegraf.Input {
-		return &Sensors{}
+		return &s
 	})
 }
+
+// snake converts string to snake case
+func snake(input string) string {
+	return strings.ToLower(strings.Replace(input, " ", "_", -1))
+}

plugins/inputs/sensors/sensors_nocompile.go

@@ -1,3 +0,0 @@
-// +build !linux !sensors
-
-package sensors

plugins/inputs/sensors/sensors_notlinux.go

@@ -0,0 +1,3 @@
+// +build !linux
+
+package sensors

plugins/inputs/sensors/sensors_test.go

@@ -0,0 +1,328 @@
+// +build linux
+
+package sensors
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"testing"
+
+	"github.com/influxdata/telegraf/testutil"
+)
+
+func TestGatherDefault(t *testing.T) {
+	s := Sensors{
+		RemoveNumbers: true,
+		path:          "sensors",
+	}
+	// overwriting exec commands with mock commands
+	execCommand = fakeExecCommand
+	defer func() { execCommand = exec.Command }()
+	var acc testutil.Accumulator
+
+	err := s.Gather(&acc)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var tests = []struct {
+		tags   map[string]string
+		fields map[string]interface{}
+	}{
+		{
+			map[string]string{
+				"chip":    "acpitz-virtual-0",
+				"feature": "temp1",
+			},
+			map[string]interface{}{
+				"temp_input": 8.3,
+				"temp_crit":  31.3,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "power_meter-acpi-0",
+				"feature": "power1",
+			},
+			map[string]interface{}{
+				"power_average":          0.0,
+				"power_average_interval": 300.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "physical_id_0",
+			},
+			map[string]interface{}{
+				"temp_input":      77.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "core_0",
+			},
+			map[string]interface{}{
+				"temp_input":      75.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "core_1",
+			},
+			map[string]interface{}{
+				"temp_input":      77.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "physical_id_1",
+			},
+			map[string]interface{}{
+				"temp_input":      70.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "core_0",
+			},
+			map[string]interface{}{
+				"temp_input":      66.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "core_1",
+			},
+			map[string]interface{}{
+				"temp_input":      70.0,
+				"temp_max":        82.0,
+				"temp_crit":       92.0,
+				"temp_crit_alarm": 0.0,
+			},
+		},
+	}
+
+	for _, test := range tests {
+		acc.AssertContainsTaggedFields(t, "sensors", test.fields, test.tags)
+	}
+}
+
+func TestGatherNotRemoveNumbers(t *testing.T) {
+	s := Sensors{
+		RemoveNumbers: false,
+		path:          "sensors",
+	}
+	// overwriting exec commands with mock commands
+	execCommand = fakeExecCommand
+	defer func() { execCommand = exec.Command }()
+	var acc testutil.Accumulator
+
+	err := s.Gather(&acc)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var tests = []struct {
+		tags   map[string]string
+		fields map[string]interface{}
+	}{
+		{
+			map[string]string{
+				"chip":    "acpitz-virtual-0",
+				"feature": "temp1",
+			},
+			map[string]interface{}{
+				"temp1_input": 8.3,
+				"temp1_crit":  31.3,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "power_meter-acpi-0",
+				"feature": "power1",
+			},
+			map[string]interface{}{
+				"power1_average":          0.0,
+				"power1_average_interval": 300.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "physical_id_0",
+			},
+			map[string]interface{}{
+				"temp1_input":      77.0,
+				"temp1_max":        82.0,
+				"temp1_crit":       92.0,
+				"temp1_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "core_0",
+			},
+			map[string]interface{}{
+				"temp2_input":      75.0,
+				"temp2_max":        82.0,
+				"temp2_crit":       92.0,
+				"temp2_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0000",
+				"feature": "core_1",
+			},
+			map[string]interface{}{
+				"temp3_input":      77.0,
+				"temp3_max":        82.0,
+				"temp3_crit":       92.0,
+				"temp3_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "physical_id_1",
+			},
+			map[string]interface{}{
+				"temp1_input":      70.0,
+				"temp1_max":        82.0,
+				"temp1_crit":       92.0,
+				"temp1_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "core_0",
+			},
+			map[string]interface{}{
+				"temp2_input":      66.0,
+				"temp2_max":        82.0,
+				"temp2_crit":       92.0,
+				"temp2_crit_alarm": 0.0,
+			},
+		},
+		{
+			map[string]string{
+				"chip":    "coretemp-isa-0001",
+				"feature": "core_1",
+			},
+			map[string]interface{}{
+				"temp3_input":      70.0,
+				"temp3_max":        82.0,
+				"temp3_crit":       92.0,
+				"temp3_crit_alarm": 0.0,
+			},
+		},
+	}
+
+	for _, test := range tests {
+		acc.AssertContainsTaggedFields(t, "sensors", test.fields, test.tags)
+	}
+}
+
+// fackeExecCommand is a helper function that mock
+// the exec.Command call (and call the test binary)
+func fakeExecCommand(command string, args ...string) *exec.Cmd {
+	cs := []string{"-test.run=TestHelperProcess", "--", command}
+	cs = append(cs, args...)
+	cmd := exec.Command(os.Args[0], cs...)
+	cmd.Env = []string{"GO_WANT_HELPER_PROCESS=1"}
+	return cmd
+}
+
+// TestHelperProcess isn't a real test. It's used to mock exec.Command
+// For example, if you run:
+// GO_WANT_HELPER_PROCESS=1 go test -test.run=TestHelperProcess -- chrony tracking
+// it returns below mockData.
+func TestHelperProcess(t *testing.T) {
+	if os.Getenv("GO_WANT_HELPER_PROCESS") != "1" {
+		return
+	}
+
+	mockData := `acpitz-virtual-0
+temp1:
+  temp1_input: 8.300
+  temp1_crit: 31.300
+
+power_meter-acpi-0
+power1:
+  power1_average: 0.000
+  power1_average_interval: 300.000
+
+coretemp-isa-0000
+Physical id 0:
+  temp1_input: 77.000
+  temp1_max: 82.000
+  temp1_crit: 92.000
+  temp1_crit_alarm: 0.000
+Core 0:
+  temp2_input: 75.000
+  temp2_max: 82.000
+  temp2_crit: 92.000
+  temp2_crit_alarm: 0.000
+Core 1:
+  temp3_input: 77.000
+  temp3_max: 82.000
+  temp3_crit: 92.000
+  temp3_crit_alarm: 0.000
+
+coretemp-isa-0001
+Physical id 1:
+  temp1_input: 70.000
+  temp1_max: 82.000
+  temp1_crit: 92.000
+  temp1_crit_alarm: 0.000
+Core 0:
+  temp2_input: 66.000
+  temp2_max: 82.000
+  temp2_crit: 92.000
+  temp2_crit_alarm: 0.000
+Core 1:
+  temp3_input: 70.000
+  temp3_max: 82.000
+  temp3_crit: 92.000
+  temp3_crit_alarm: 0.000
+`
+
+	args := os.Args
+
+	// Previous arguments are tests stuff, that looks like :
+	// /tmp/go-build970079519/…/_test/integration.test -test.run=TestHelperProcess --
+	cmd, args := args[3], args[4:]
+
+	if cmd == "sensors" {
+		fmt.Fprint(os.Stdout, mockData)
+	} else {
+		fmt.Fprint(os.Stdout, "command not found")
+		os.Exit(1)
+
+	}
+	os.Exit(0)
+}