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

Use result and result_code in net_response

Browse Source
This commit is contained in:
Daniel Nelson
2018-05-08 16:04:28 -07:00
parent 54a0532604
commit 078eb47265
3 changed files with 101 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
plugins/inputs/net_response/README.md
View File

@@ -1,11 +1,12 @@
# Network Response Input Plugin
The input plugin test UDP/TCP connections response time.
It can also check response text.
The input plugin test UDP/TCP connections response time and can optional
verify text in the response.
### Configuration:
```
```toml
# Collect response time of a TCP or UDP connection
[[inputs.net_response]]
## Protocol, must be "tcp" or "udp"
## NOTE: because the "udp" protocol does not respond to requests, it requires
@@ -13,11 +14,12 @@ It can also check response text.
protocol = "tcp"
## Server address (default localhost)
address = "localhost:80"
## Set timeout
timeout = "1s"
# timeout = "1s"
## Set read timeout (only used if expecting a response)
read_timeout = "1s"
# read_timeout = "1s"
## The following options are required for UDP checks. For TCP, they are
## optional. The plugin will send the given string to the server and then
@@ -27,59 +29,29 @@ It can also check response text.
## expected string in answer
# expect = "ssh"
[[inputs.net_response]]
protocol = "tcp"
address = ":80"
# TCP or UDP 'ping' given url and collect response time in seconds
[[inputs.net_response]]
## Protocol, must be "tcp" or "udp"
protocol = "tcp"
## Server address (default localhost)
address = "github.com:80"
## Set timeout
timeout = "1s"
## Optional string sent to the server
send = "ssh"
## Optional expected string in answer
expect = "ssh"
## Set read timeout (only used if expecting a response)
read_timeout = "1s"
[[inputs.net_response]]
protocol = "udp"
address = "localhost:161"
timeout = "2s"
send = "hello server"
expect = "hello client"
## Uncomment to remove deprecated fields; recommended for new deploys
# fieldexclude = ["result_type", "string_found"]
```
### Measurements & Fields:
### Metrics:
- net_response
- response_time (float, seconds)
- success (int) # success 0, failure 1
- result_code (int) # success = 0, Failure = 1
- [**DEPRECATED**] result_type (string) # success, timeout, connection_failed, read_failed, string_mismatch
- [**DEPRECATED**] string_found (boolean)
### Tags:
- All measurements have the following tags:
- tags:
- server
- port
- protocol
- result_text (string) # This will contain the text from the now deprecated result_type
- result
- fields:
- response_time (float, seconds)
- success (int) # success 0, failure 1
- result_code (int, success = 0, timeout = 1, connection_failed = 2, read_failed = 3, string_mismatch = 4)
- result_type (string) **DEPRECATED in 1.7; use result tag**
- string_found (boolean) **DEPRECATED in 1.4; use result tag**
### Example Output:
```
net_response,server=influxdata.com,port=8080,protocol=tcp,host=localhost,result_text="timeout" result_code=1i,result_type="timeout" 1499310361000000000
net_response,server=influxdata.com,port=443,protocol=tcp,host=localhost,result_text="success" result_code=0i,result_type="success",response_time=0.088703864 1499310361000000000
net_response,protocol=tcp,host=localhost,server=this.domain.does.not.exist,port=443,result_text="connection_failed" result_code=1i,result_type="connection_failed" 1499310361000000000
net_response,protocol=udp,host=localhost,server=influxdata.com,port=8080,result_text="read_failed" result_code=1i,result_type="read_failed" 1499310362000000000
net_response,port=31338,protocol=udp,host=localhost,server=localhost,result_text="string_mismatch" result_code=1i,result_type="string_mismatch",string_found=false,response_time=0.00242682 1499310362000000000
net_response,protocol=udp,host=localhost,server=localhost,port=31338,result_text="success" response_time=0.001128598,result_code=0i,result_type="success",string_found=true 1499310362000000000
net_response,server=this.domain.does.not.exist,port=443,protocol=udp,host=localhost,result_text="connection_failed" result_code=1i,result_type="connection_failed" 1499310362000000000
net_response,port=8086,protocol=tcp,result=success,server=localhost response_time=0.000092948,result_code=0i,result_type="success" 1525820185000000000
net_response,port=8080,protocol=tcp,result=connection_failed,server=localhost result_code=2i,result_type="connection_failed" 1525820088000000000
net_response,port=8080,protocol=udp,result=read_failed,server=localhost result_code=3i,result_type="read_failed",string_found=false 1525820088000000000
```