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

Document response_string_match field in http_response (#5251)

This commit is contained in:
hydrandt 2019-01-08 03:25:08 +08:00 committed by Daniel Nelson
parent 39022cd2f4
commit 9dc9bd653a
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
plugins/inputs/http_response/README.md
View File

@ -27,7 +27,7 @@ This input plugin checks HTTP/HTTPS connections.
# {'fake':'data'} # {'fake':'data'}
# ''' # '''
## Optional substring or regex match in body of the response ## Optional substring or regex match in body of the response (case sensitive)
# response_string_match = "\"service_status\": \"up\"" # response_string_match = "\"service_status\": \"up\""
# response_string_match = "ok" # response_string_match = "ok"
# response_string_match = "\".*_status\".?:.?\"up\"" # response_string_match = "\".*_status\".?:.?\"up\""
@ -54,6 +54,7 @@ This input plugin checks HTTP/HTTPS connections.
- result ([see below](#result--result_code)) - result ([see below](#result--result_code))
- fields: - fields:
- response_time (float, seconds) - response_time (float, seconds)
- response_string_match (int, 0 = mismatch / body read error, 1 = match)
- http_response_code (int, response status code) - http_response_code (int, response status code)
- result_type (string, deprecated in 1.6: use `result` tag and `result_code` field) - result_type (string, deprecated in 1.6: use `result` tag and `result_code` field)
- result_code (int, [see below](#result--result_code)) - result_code (int, [see below](#result--result_code))
@ -67,7 +68,7 @@ This tag is used to expose network and plugin errors. HTTP errors are considered
|Tag value |Corresponding field value|Description| |Tag value |Corresponding field value|Description|
--------------------------|-------------------------|-----------| --------------------------|-------------------------|-----------|
|success | 0 |The HTTP request completed, even if the HTTP code represents an error| |success | 0 |The HTTP request completed, even if the HTTP code represents an error|
|response_string_mismatch | 1 |The option `response_string_match` was used, and the body of the response didn't match the regex| |response_string_mismatch | 1 |The option `response_string_match` was used, and the body of the response didn't match the regex. HTTP errors with content in their body (like 4xx, 5xx) will trigger this error|
|body_read_error | 2 |The option `response_string_match` was used, but the plugin wans't able to read the body of the response. Responses with empty bodies (like 3xx, HEAD, etc) will trigger this error| |body_read_error | 2 |The option `response_string_match` was used, but the plugin wans't able to read the body of the response. Responses with empty bodies (like 3xx, HEAD, etc) will trigger this error|
|connection_failed | 3 |Catch all for any network error not specifically handled by the plugin| |connection_failed | 3 |Catch all for any network error not specifically handled by the plugin|
|timeout | 4 |The plugin timed out while awaiting the HTTP connection to complete| |timeout | 4 |The plugin timed out while awaiting the HTTP connection to complete|