telegraf/plugins/inputs/filestat
Zack Zatkin-Gold 61be19b1f0 Fix telegraf example arguments (#2788)
Many of the examples provided within documentation are using a single
dash for the command line arguments, but the telegraf executable
explicitly has two dashes.

There are also some inconsistencies with the ordering of the command
line argument examples.  I've ordered them so that the examples will
show: config, config-directory, input-filter, test
2017-05-12 15:22:29 -07:00
..
testdata
README.md Fix telegraf example arguments (#2788) 2017-05-12 15:22:29 -07:00
filestat.go use AddError everywhere (#2372) 2017-04-24 11:13:26 -07:00
filestat_test.go use AddError everywhere (#2372) 2017-04-24 11:13:26 -07:00

README.md

filestat Input Plugin

The filestat plugin gathers metrics about file existence, size, and other stats.

Configuration:

# Read stats about given file(s)
[[inputs.filestat]]
  ## Files to gather stats about.
  ## These accept standard unix glob matching rules, but with the addition of
  ## ** as a "super asterisk". See https://github.com/gobwas/glob.
  files = ["/etc/telegraf/telegraf.conf", "/var/log/**.log"]
  ## If true, read the entire file and calculate an md5 checksum.
  md5 = false

Measurements & Fields:

  • filestat
    • exists (int, 0 | 1)
    • size_bytes (int, bytes)
    • md5 (optional, string)

Tags:

  • All measurements have the following tags:
    • file (the path the to file, as specified in the config)

Example Output:

$ 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