Utilize timeout in net_response plugin.

Also changing the net_response and http_response plugins to only accept
duration strings for their timeout parameters. This is a breaking config
file change.

closes #1214

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Release Notes
 
+- **Breaking Change**: net_response and http_response plugins timeouts will
+now only be accepted as duration strings. ie, "2s" or "500ms".
 - Input plugin Gathers will no longer be logged by default, but a Gather for
 _each_ plugin will be logged in Debug mode.
 - Debug mode will no longer print every point added to the accumulator. This
@@ -24,6 +26,7 @@ to "stdout".
 - [#1228](https://github.com/influxdata/telegraf/pull/1228): Fix service plugin host tag overwrite.
 - [#1198](https://github.com/influxdata/telegraf/pull/1198): http_response: override request Host header properly
 - [#1230](https://github.com/influxdata/telegraf/issues/1230): Fix Telegraf process hangup due to a single plugin hanging.
+- [#1214](https://github.com/influxdata/telegraf/issues/1214): Use TCP timeout argument in net_response plugin.
 
 ## v0.13 [2016-05-11]
 

agent/agent.go

@@ -137,16 +137,15 @@ func (a *Agent) gatherer(
 		}
 
 		gatherWithTimeout(shutdown, input, acc, interval)
-
 		elapsed := time.Since(start)
-		if a.Config.Agent.Debug {
-			log.Printf("Input [%s] gathered metrics, (%s interval) in %s\n",
-				input.Name, interval, elapsed)
-		}
 
 		if outerr != nil {
 			return outerr
 		}
+		if a.Config.Agent.Debug {
+			log.Printf("Input [%s] gathered metrics, (%s interval) in %s\n",
+				input.Name, interval, elapsed)
+		}
 
 		select {
 		case <-shutdown:

etc/telegraf.conf

@@ -680,7 +680,7 @@
 #   ## Server address (default http://localhost)
 #   address = "http://github.com"
 #   ## Set response_timeout (default 5 seconds)
-#   response_timeout = 5
+#   response_timeout = "5s"
 #   ## HTTP Request Method
 #   method = "GET"
 #   ## Whether to follow redirects from the server (defaults to false)
@@ -946,14 +946,15 @@
 #   protocol = "tcp"
 #   ## Server address (default localhost)
 #   address = "github.com:80"
-#   ## Set timeout (default 1.0 seconds)
-#   timeout = 1.0
-#   ## Set read timeout (default 1.0 seconds)
-#   read_timeout = 1.0
+#   ## 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"
 
 
 # # Read TCP metrics such as established, time wait and sockets counts.
@@ -1144,6 +1145,9 @@
 #   ## user as argument for pgrep (ie, pgrep -u <user>)
 #   # user = "nginx"
 # 
+#   ## override for process_name
+#   ## This is optional; default is sourced from /proc/<pid>/status
+#   # process_name = "bar"
 #   ## Field name prefix
 #   prefix = ""
 #   ## comment this out if you want raw cpu_time stats

plugins/inputs/http_response/README.md

@@ -5,23 +5,23 @@ This input plugin will test HTTP/HTTPS connections.
 ### Configuration:
 
 ```
-# List of UDP/TCP connections you want to check
+# HTTP/HTTPS request given an address a method and a timeout
 [[inputs.http_response]]
   ## Server address (default http://localhost)
   address = "http://github.com"
   ## Set response_timeout (default 5 seconds)
-  response_timeout = 5
+  response_timeout = "5s"
   ## HTTP Request Method
   method = "GET"
-  ## HTTP Request Headers
-  [inputs.http_response.headers]
-      Host = github.com
   ## Whether to follow redirects from the server (defaults to false)
   follow_redirects = true
+  ## HTTP Request Headers (all values must be strings)
+  # [inputs.http_response.headers]
+  #   Host = "github.com"
   ## Optional HTTP Request Body
-  body = '''
-  {'fake':'data'}
-  '''
+  # body = '''
+  # {'fake':'data'}
+  # '''
 ```
 
 ### Measurements & Fields:

plugins/inputs/http_response/http_response.go

@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/internal"
 	"github.com/influxdata/telegraf/plugins/inputs"
 )
 
@@ -17,7 +18,7 @@ type HTTPResponse struct {
 	Address         string
 	Body            string
 	Method          string
-	ResponseTimeout int
+	ResponseTimeout internal.Duration
 	Headers         map[string]string
 	FollowRedirects bool
 }
@@ -31,7 +32,7 @@ var sampleConfig = `
   ## Server address (default http://localhost)
   address = "http://github.com"
   ## Set response_timeout (default 5 seconds)
-  response_timeout = 5
+  response_timeout = "5s"
   ## HTTP Request Method
   method = "GET"
   ## Whether to follow redirects from the server (defaults to false)
@@ -57,7 +58,7 @@ var ErrRedirectAttempted = errors.New("redirect")
 // timeout period and can follow redirects if specified
 func CreateHttpClient(followRedirects bool, ResponseTimeout time.Duration) *http.Client {
 	client := &http.Client{
-		Timeout: time.Second * ResponseTimeout,
+		Timeout: ResponseTimeout,
 	}
 
 	if followRedirects == false {
@@ -73,7 +74,7 @@ func (h *HTTPResponse) HTTPGather() (map[string]interface{}, error) {
 	// Prepare fields
 	fields := make(map[string]interface{})
 
-	client := CreateHttpClient(h.FollowRedirects, time.Duration(h.ResponseTimeout))
+	client := CreateHttpClient(h.FollowRedirects, h.ResponseTimeout.Duration)
 
 	var body io.Reader
 	if h.Body != "" {
@@ -113,8 +114,8 @@ func (h *HTTPResponse) HTTPGather() (map[string]interface{}, error) {
 // Gather gets all metric fields and tags and returns any errors it encounters
 func (h *HTTPResponse) Gather(acc telegraf.Accumulator) error {
 	// Set default values
-	if h.ResponseTimeout < 1 {
-		h.ResponseTimeout = 5
+	if h.ResponseTimeout.Duration < time.Second {
+		h.ResponseTimeout.Duration = time.Second * 5
 	}
 	// Check send and expected string
 	if h.Method == "" {

plugins/inputs/http_response/http_response_test.go

@@ -2,13 +2,16 @@ package http_response
 
 import (
 	"fmt"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 	"time"
+
+	"github.com/influxdata/telegraf/internal"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func setUpTestMux() http.Handler {
@@ -61,7 +64,7 @@ func TestHeaders(t *testing.T) {
 	h := &HTTPResponse{
 		Address:         ts.URL,
 		Method:          "GET",
-		ResponseTimeout: 2,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 2},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 			"Host":         "Hello",
@@ -85,7 +88,7 @@ func TestFields(t *testing.T) {
 		Address:         ts.URL + "/good",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -109,7 +112,7 @@ func TestRedirects(t *testing.T) {
 		Address:         ts.URL + "/redirect",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -126,7 +129,7 @@ func TestRedirects(t *testing.T) {
 		Address:         ts.URL + "/badredirect",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -145,7 +148,7 @@ func TestMethod(t *testing.T) {
 		Address:         ts.URL + "/mustbepostmethod",
 		Body:            "{ 'test': 'data'}",
 		Method:          "POST",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -162,7 +165,7 @@ func TestMethod(t *testing.T) {
 		Address:         ts.URL + "/mustbepostmethod",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -180,7 +183,7 @@ func TestMethod(t *testing.T) {
 		Address:         ts.URL + "/mustbepostmethod",
 		Body:            "{ 'test': 'data'}",
 		Method:          "head",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -203,7 +206,7 @@ func TestBody(t *testing.T) {
 		Address:         ts.URL + "/musthaveabody",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -219,7 +222,7 @@ func TestBody(t *testing.T) {
 	h = &HTTPResponse{
 		Address:         ts.URL + "/musthaveabody",
 		Method:          "GET",
-		ResponseTimeout: 20,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 20},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},
@@ -242,7 +245,7 @@ func TestTimeout(t *testing.T) {
 		Address:         ts.URL + "/twosecondnap",
 		Body:            "{ 'test': 'data'}",
 		Method:          "GET",
-		ResponseTimeout: 1,
+		ResponseTimeout: internal.Duration{Duration: time.Second * 1},
 		Headers: map[string]string{
 			"Content-Type": "application/json",
 		},

plugins/inputs/net_response/README.md

@@ -6,41 +6,30 @@ It can also check response text.
 ### Configuration:
 
 ```
-# List of UDP/TCP connections you want to check
-[[inputs.net_response]]
-  protocol = "tcp"
-  # Server address (default IP localhost)
-  address = "github.com:80"
-  # Set timeout (default 1.0)
-  timeout = 1.0
-  # Set read timeout (default 1.0)
-  read_timeout = 1.0
-  # String sent to the server
-  send = "ssh"
-  # 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 = "udp"
-  # Server address (default IP localhost)
+  ## Protocol, must be "tcp" or "udp"
+  protocol = "tcp"
+  ## Server address (default localhost)
   address = "github.com:80"
-  # Set timeout (default 1.0)
-  timeout = 1.0
-  # Set read timeout (default 1.0)
-  read_timeout = 1.0
-  # String sent to the server
+  ## Set timeout
+  timeout = "1s"
+
+  ## Optional string sent to the server
   send = "ssh"
-  # Expected string in answer
+  ## 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 = 2.0
+  timeout = "2s"
 ```
 
 ### Measurements & Fields: