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.

Sign up for GitHub

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

Jump to bottom

add modification_time field to filestat input plugin #3305

Merged
merged 8 commits into from
Nov 7, 2017
Merged

add modification_time field to filestat input plugin #3305

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a2bb092
added modification_time field
puckpuck Oct 4, 2017
31a9392
use UnixNano() for mod time
puckpuck Oct 5, 2017
fff8aff
updated readme to show nanoseconds
puckpuck Oct 5, 2017
8b25cad
updated all tests
puckpuck Oct 8, 2017
ba6c7ab
updated test to use acc.HasPoint
puckpuck Oct 10, 2017
2bf4c12
go fmt
puckpuck Oct 10, 2017
f6211ad
Merge branch 'master' into filestat-modtime
puckpuck Nov 6, 2017
9dce627
go fmt
puckpuck Nov 6, 2017
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: 2 additions & 1 deletion plugins/inputs/filestat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The filestat plugin gathers metrics about file existence, size, and other stats.
- filestat
- exists (int, 0 | 1)
- size_bytes (int, bytes)
- modification_time (int, unixtime)
- md5 (optional, string)

### Tags:
Expand All @@ -33,5 +34,5 @@ The filestat plugin gathers metrics about file existence, size, and other stats.
$ telegraf --config /etc/telegraf/telegraf.conf --input-filter filestat --test
* Plugin: filestat, Collection 1
> filestat,file=/tmp/foo/bar,host=tyrion exists=0i 1461203374493128216
> filestat,file=/Users/sparrc/ws/telegraf.conf,host=tyrion exists=1i,size=47894i 1461203374493199335
> filestat,file=/Users/sparrc/ws/telegraf.conf,host=tyrion exists=1i,size=47894i,modification_time=1470234221i 1461203374493199335
```
1 change: 1 addition & 0 deletions plugins/inputs/filestat/filestat.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ func (f *FileStat) Gather(acc telegraf.Accumulator) error {
fileName)
} else {
fields["size_bytes"] = fileInfo.Size()
fields["modification_time"] = fileInfo.ModTime().Unix()
}

if f.Md5 {
Expand Down
90 changes: 65 additions & 25 deletions plugins/inputs/filestat/filestat_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"strings"
"testing"

"github.com/influxdata/telegraf/internal/globpath"
"github.com/influxdata/telegraf/testutil"
"github.com/stretchr/testify/assert"
)
Expand All @@ -25,17 +26,19 @@ func TestGatherNoMd5(t *testing.T) {
"file": dir + "log1.log",
}
fields1 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags1["file"])),
Copy link
Contributor

Choose a reason for hiding this comment

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

Just use acc.HasInt64Field( to assert that the field is set, then you can remove the getModificationTime function. This will be good enough for now in my opinion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was hoping you wouldn't ask for something like that 😉

means I need to modify each test case to assert all fields individually, because acc.AssertContainsTaggedFields(...) will fail now. Hence why I did the getModificationTime function... required fewer changes to implement.

}
acc.AssertContainsTaggedFields(t, "filestat", fields1, tags1)

tags2 := map[string]string{
"file": dir + "log2.log",
}
fields2 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags2["file"])),
}
acc.AssertContainsTaggedFields(t, "filestat", fields2, tags2)

Expand Down Expand Up @@ -65,19 +68,21 @@ func TestGatherExplicitFiles(t *testing.T) {
"file": dir + "log1.log",
}
fields1 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags1["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields1, tags1)

tags2 := map[string]string{
"file": dir + "log2.log",
}
fields2 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags2["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields2, tags2)

Expand Down Expand Up @@ -105,19 +110,21 @@ func TestGatherGlob(t *testing.T) {
"file": dir + "log1.log",
}
fields1 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags1["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields1, tags1)

tags2 := map[string]string{
"file": dir + "log2.log",
}
fields2 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags2["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields2, tags2)
}
Expand All @@ -137,29 +144,32 @@ func TestGatherSuperAsterisk(t *testing.T) {
"file": dir + "log1.log",
}
fields1 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags1["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields1, tags1)

tags2 := map[string]string{
"file": dir + "log2.log",
}
fields2 := map[string]interface{}{
"size_bytes": int64(0),
"exists": int64(1),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
"size_bytes": int64(0),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags2["file"])),
"md5_sum": "d41d8cd98f00b204e9800998ecf8427e",
}
acc.AssertContainsTaggedFields(t, "filestat", fields2, tags2)

tags3 := map[string]string{
"file": dir + "test.conf",
}
fields3 := map[string]interface{}{
"size_bytes": int64(104),
"exists": int64(1),
"md5_sum": "5a7e9b77fa25e7bb411dbd17cf403c1f",
"size_bytes": int64(104),
"exists": int64(1),
"modification_time": int64(getModificationTime(fs, tags3["file"])),
"md5_sum": "5a7e9b77fa25e7bb411dbd17cf403c1f",
}
acc.AssertContainsTaggedFields(t, "filestat", fields3, tags3)
}
Expand All @@ -174,6 +184,36 @@ func TestGetMd5(t *testing.T) {
assert.Error(t, err)
}

func getModificationTime(f *FileStat, filepath string) int64 {
// This function is a near copy from the main code,
// however since the modification time of test files will change based on code pull this seems the only way to solve unit tests
// All unit tests should call this function for expected value of modification_time

var err error
g, ok := f.globs[filepath]
if !ok {
if g, err = globpath.Compile(filepath); err != nil {
return 0
}
f.globs[filepath] = g
}

files := g.Match()
if len(files) == 0 {
return 0
}

for _, fileInfo := range files {
if fileInfo == nil {
return 0
} else {
return fileInfo.ModTime().Unix()
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 providing precision greater than 1s?

}
}

return 0
}

func getTestdataDir() string {
_, filename, _, _ := runtime.Caller(1)
return strings.Replace(filename, "filestat_test.go", "testdata/", 1)
Expand Down