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

Add dmcache input plugin #1667

Merged
merged 19 commits into from
Apr 7, 2017
Merged
Show file tree
Hide file tree
Changes from 4 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
1 change: 1 addition & 0 deletions plugins/inputs/all/all.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
_ "github.com/influxdata/telegraf/plugins/inputs/couchbase"
_ "github.com/influxdata/telegraf/plugins/inputs/couchdb"
_ "github.com/influxdata/telegraf/plugins/inputs/disque"
_ "github.com/influxdata/telegraf/plugins/inputs/dmcache"
_ "github.com/influxdata/telegraf/plugins/inputs/dns_query"
_ "github.com/influxdata/telegraf/plugins/inputs/docker"
_ "github.com/influxdata/telegraf/plugins/inputs/dovecot"
Expand Down
15 changes: 15 additions & 0 deletions plugins/inputs/dmcache/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DMCache Input Plugin

This plugin provide a native collection for dmsetup based statistics for dm-cache.

This plugin requires sudo, that is why you should setup and be sure that the telegraf is able to execute sudo without a password.

`sudo /sbin/dmsetup status --target cache` is the full command that telegraf will run for debugging purposes.

## Configuration

```
[[inputs.dmcache]]
## Whether to report per-device stats or not
per_device = true
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Make sure you document the tags/fields and stick to the format of the example as closely as possible (for instance little things such as three #'s for Configuration.)

https://raw.githubusercontent.com/influxdata/telegraf/master/plugins/inputs/EXAMPLE_README.md

How did you go about naming the fields? Can you link to any documentation you may have used?

Copy link
Contributor

Choose a reason for hiding this comment

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

All of the fields are basically taken from the output of the dmsetup status --target=cache output for the given disks. In this case, we want to split all the data into multiple lines per disk we set up.

Copy link
Contributor

Choose a reason for hiding this comment

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

So the output of that command, based on the test cases, is more or less a table of values. Where did you find out what each column represents?

51 changes: 51 additions & 0 deletions plugins/inputs/dmcache/dmcache.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package dmcache

import (
"os/exec"
"strings"

"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/plugins/inputs"
)

type DMCache struct {
PerDevice bool `toml:"per_device"`
getCurrentStatus func() ([]string, error)
}

var sampleConfig = `
## Whether to report per-device stats or not
per_device = true
`

func (c *DMCache) SampleConfig() string {
return sampleConfig
}

func (c *DMCache) Description() string {
return "Provide a native collection for dmsetup based statistics for dm-cache"
}

func dmSetupStatus() ([]string, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should go into dmcache_linux since it is linux specific.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is fine, how does one accomplish this on Windows (not a Windows user/fan).

out, err := exec.Command("/bin/sh", "-c", "sudo /sbin/dmsetup status --target cache").Output()
if err != nil {
return nil, err
}
if string(out) == "No devices found\n" {
return []string{}, nil
}

outString := strings.TrimRight(string(out), "\n")
status := strings.Split(outString, "\n")

return status, nil
}

func init() {
inputs.Add("dmcache", func() telegraf.Input {
return &DMCache{
PerDevice: true,
getCurrentStatus: dmSetupStatus,
}
})
}
131 changes: 131 additions & 0 deletions plugins/inputs/dmcache/dmcache_linux.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
// +build linux

package dmcache

import (
"strconv"
"strings"

"errors"

"github.com/influxdata/telegraf"
)

const metricName = "dmcache"

func (c *DMCache) Gather(acc telegraf.Accumulator) error {
outputLines, err := c.getCurrentStatus()
if err != nil {
return err
}

total := make(map[string]interface{})

for _, s := range outputLines {
fields, err := parseDMSetupStatus(s)
if err != nil {
return err
}

if c.PerDevice {
Copy link
Contributor

Choose a reason for hiding this comment

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

this if-statement doesn't seem correct to me.

If the user sets per_device = true, then it should report the per-device stats AND total stats.

Is there a reason users would not want total stats? If so it should be a separate config option.

tags := map[string]string{"device": fields["device"].(string)}
acc.AddFields(metricName, fields, tags)
}
aggregateStats(total, fields)
Copy link
Contributor

Choose a reason for hiding this comment

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

Switch to fields at the last moment. Overall flow should be get the cacheStatus, aggregate, then convert to fields and emit as needed.

}

acc.AddFields(metricName, total, map[string]string{"device": "all"})

return nil
}

func parseDMSetupStatus(line string) (map[string]interface{}, error) {
var err error
parseError := errors.New("Output from dmsetup could not be parsed")
status := make(map[string]interface{})
Copy link
Contributor

Choose a reason for hiding this comment

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

You should define a struct for these values, that way less casting is needed later

Copy link
Contributor Author

@vlasad vlasad Apr 3, 2017

Choose a reason for hiding this comment

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

But, in this case, function "calculateSize" will require to use reflection to get value by key.

values := strings.Fields(line)
if len(values) < 15 {
return nil, parseError
}

status["device"] = strings.TrimRight(values[0], ":")
Copy link
Contributor

Choose a reason for hiding this comment

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

Still want these in a struct, this separates the responsibilities. Call it something appropriate that represents the data, maybe CacheStatus. I get why you did this but I think it will clear up some weirdness in the code, such as taking device from fields to add to tags. You won't need to do type conversions and summing will be more explicit. This open PR does a good job. #2031

status["length"], err = strconv.Atoi(values[2])
if err != nil {
return nil, err
}
status["target"] = values[3]
status["metadata_blocksize"], err = strconv.Atoi(values[4])
if err != nil {
return nil, err
}
metadata := strings.Split(values[5], "/")
if len(metadata) != 2 {
return nil, parseError
}
status["metadata_used"], err = strconv.Atoi(metadata[0])
if err != nil {
return nil, err
}
status["metadata_total"], err = strconv.Atoi(metadata[1])
if err != nil {
return nil, err
}
status["cache_blocksize"], err = strconv.Atoi(values[6])
if err != nil {
return nil, err
}
cache := strings.Split(values[7], "/")
if len(cache) != 2 {
return nil, parseError
}
status["cache_used"], err = strconv.Atoi(cache[0])
if err != nil {
return nil, err
}
status["cache_total"], err = strconv.Atoi(cache[1])
if err != nil {
return nil, err
}
status["read_hits"], err = strconv.Atoi(values[8])
if err != nil {
return nil, err
}
status["read_misses"], err = strconv.Atoi(values[9])
if err != nil {
return nil, err
}
status["write_hits"], err = strconv.Atoi(values[10])
if err != nil {
return nil, err
}
status["write_misses"], err = strconv.Atoi(values[11])
if err != nil {
return nil, err
}
status["demotions"], err = strconv.Atoi(values[12])
if err != nil {
return nil, err
}
status["promotions"], err = strconv.Atoi(values[13])
if err != nil {
return nil, err
}
status["dirty"], err = strconv.Atoi(values[14])
if err != nil {
return nil, err
}

Copy link
Contributor

Choose a reason for hiding this comment

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

What about the values after dirty, why do we not collect them?

Copy link
Contributor

Choose a reason for hiding this comment

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

What about the values after dirty, do we need to collect them?

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what you're asking here, are you questioning why we're collecting the "dirty" blocks?

Copy link
Contributor

Choose a reason for hiding this comment

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

I noticed in the sample output included in the tests that there are more values after the column containing "dirty". Are these metrics important, should we be collecting them, and why?

return status, nil
}

func aggregateStats(total, fields map[string]interface{}) {
for key, value := range fields {
if _, ok := value.(int); ok {
if _, ok := total[key]; ok {
total[key] = total[key].(int) + value.(int)
} else {
total[key] = value.(int)
}
}
}
}
11 changes: 11 additions & 0 deletions plugins/inputs/dmcache/dmcache_notlinux.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// +build !linux

package dmcache

import (
"github.com/influxdata/telegraf"
)

func (c *DMCache) Gather(acc telegraf.Accumulator) error {
return nil
}
Loading