Skip to content
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

Include DEVLINKS in available diskio udev properties #5116

Merged
merged 19 commits into from
Dec 13, 2018
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions plugins/inputs/diskio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ The diskio input plugin gathers metrics about disk traffic and timing.
## Currently only Linux is supported via udev properties. You can view
## available properties for a device by running:
## 'udevadm info -q property -n /dev/sda'
## Note: Most, but not all, udev properties can be accessed this way. Properties
## that are currently accessible include the "IS_*" series and the "DEVLINKS"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be able to access any of the E: values, so that would be at least ID* and DM* and probably others. Might be easier to document fields that cannot be looked up: DEVTYPE, DEVNAME, DEVPATH.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense.

## property. For more info see https://github.com/influxdata/telegraf/issues/3663
# device_tags = ["ID_FS_TYPE", "ID_FS_USAGE"]
#
## Using the same metadata source as device_tags, you can also customize the
Expand Down
16 changes: 15 additions & 1 deletion plugins/inputs/diskio/diskio_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,17 @@ func (s *DiskIO) diskInfo(devName string) (map[string]string, error) {
defer f.Close()

scnr := bufio.NewScanner(f)
var devlinks []string
for scnr.Scan() {
l := scnr.Text()
if len(l) < 4 || l[:2] != "E:" {
if len(l) < 4 {
continue
}
if l[:2] == "S:" {
devlinks = append(devlinks, l[2:])
continue
}
if l[:2] != "E:" {
continue
}
kv := strings.SplitN(l[2:], "=", 2)
Expand All @@ -64,5 +72,11 @@ func (s *DiskIO) diskInfo(devName string) (map[string]string, error) {
di[kv[0]] = kv[1]
}

var devlink_str string
if len(devlinks) > 0 {
devlink_str = strings.Join(devlinks, " ")
di["DEVLINKS"] = devlink_str
}

return di, nil
}
3 changes: 3 additions & 0 deletions plugins/inputs/diskio/diskio_linux_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
var nullDiskInfo = []byte(`
E:MY_PARAM_1=myval1
E:MY_PARAM_2=myval2
S:foo/bar/devlink foo/bar/devlink1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be multiple lines like:

S:foo/bar/devlink
S:foo/bar/devlink1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, my mistake. I will update accordingly.

`)

// setupNullDisk sets up fake udev info as if /dev/null were a disk.
Expand Down Expand Up @@ -47,6 +48,7 @@ func TestDiskInfo(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, "myval1", di["MY_PARAM_1"])
assert.Equal(t, "myval2", di["MY_PARAM_2"])
assert.Equal(t, "foo/bar/devlink foo/bar/devlink1", di["DEVLINKS"])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on running udevadm we should prepend "/dev/" to the links: /dev/foo/bar/devlink /dev/foo/bar/devlink1. I'm not sure if there are situations where the prefix would be something other than /dev, maybe in docker, but I think we could assume it for now unless we have a way to determine this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point (although it really demands a change to the function itself). I may try to check docker just to see, but otherwise I will definitely do this.


// test that data is cached
err = clean()
Expand All @@ -56,6 +58,7 @@ func TestDiskInfo(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, "myval1", di["MY_PARAM_1"])
assert.Equal(t, "myval2", di["MY_PARAM_2"])
assert.Equal(t, "foo/bar/devlink foo/bar/devlink1", di["DEVLINKS"])

// unfortunately we can't adjust mtime on /dev/null to test cache invalidation
}
Expand Down