dom/telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

nstat plugin cleanups and formatting

Browse Source 
closes #1104
closes #1138
This commit is contained in:
Cameron Sparr
2016-05-17 17:00:46 +01:00
parent 7557056a31
commit dc89f029ad
4 changed files with 36 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
plugins/inputs/nstat/README.md
View File

@@ -1,27 +1,28 @@
## Nstat input plugin
## Nstat input plugin
Plugin collects network metrics from ```/proc/net/netstat```, ```/proc/net/snmp``` and ```/proc/net/snmp6``` files
Plugin collects network metrics from `/proc/net/netstat`, `/proc/net/snmp` and `/proc/net/snmp6` files
### Configuration
The plugin firstly tries to read file paths from config values
if it is empty, then it reads from env variables.
* ```PROC_NET_NETSTAT```
* ```PROC_NET_SNMP```
* ```PROC_NET_SNMP6```
* `PROC_NET_NETSTAT`
* `PROC_NET_SNMP`
* `PROC_NET_SNMP6`
If these variables are also not set,
then it tries to read the proc root from env - ```PROC_ROOT```,
and sets ```/proc``` as a root path if ```PROC_ROOT``` is also empty.
then it tries to read the proc root from env - `PROC_ROOT`,
and sets `/proc` as a root path if `PROC_ROOT` is also empty.
Then appends default file paths:
* ```/net/netstat```
* ```/net/snmp```
* ```/net/snmp6```
* `/net/netstat`
* `/net/snmp`
* `/net/snmp6`
So if nothing is given, no paths in config and in env vars, the plugin takes the default paths.
* ```/proc/net/netstat```
* ```/proc/net/snmp```
* ```/proc/net/snmp6```
* `/proc/net/netstat`
* `/proc/net/snmp`
* `/proc/net/snmp6`
The sample config file
```toml

17
plugins/inputs/nstat/nstat.go
View File

@@ -40,17 +40,18 @@ type Nstat struct {
}
var sampleConfig = `
# file paths
# e.g: /proc/net/netstat, /proc/net/snmp, /proc/net/snmp6
proc_net_netstat = ""
proc_net_snmp = ""
proc_net_snmp6 = ""
# dump metrics with 0 values too
dump_zeros = true
## file paths for proc files. If empty default paths will be used:
## /proc/net/netstat, /proc/net/snmp, /proc/net/snmp6
## These can also be overridden with env variables, see README.
proc_net_netstat = ""
proc_net_snmp = ""
proc_net_snmp6 = ""
## dump metrics with 0 values too
dump_zeros = true
`
func (ns *Nstat) Description() string {
return "Collect network metrics from '/proc/net/netstat', '/proc/net/snmp' & '/proc/net/snmp6' files"
return "Collect kernel snmp counters and network interface statistics"
}
func (ns *Nstat) SampleConfig() string {