Close #18: Support monitoring TCP services

README.md

@@ -29,6 +29,9 @@ core applications: https://status.twinnation.org/
 - [Using in Production](#using-in-production)
 - [FAQ](#faq)
   - [Sending a GraphQL request](#sending-a-graphql-request)
+  - [Recommended interval](#recommended-interval)
+  - [Default timeouts](#default-timeouts)
+  - [Monitoring a TCP service](#monitoring-a-tcp-service)
 
 
 ## Features
@@ -122,6 +125,7 @@ Here are some examples of conditions you can use:
 | `[STATUS] < 300`             | Status must lower than 300                              | 200, 201, 299              | 301, 302, ...  |
 | `[STATUS] <= 299`            | Status must be less than or equal to 299                | 200, 201, 299              | 301, 302, ...  |
 | `[STATUS] > 400`             | Status must be greater than 400                         | 401, 402, 403, 404         | 400, 200, ...  |
+| `[CONNECTED] == true`        | Connection to host must've been successful              | true, false                |  |
 | `[RESPONSE_TIME] < 500`      | Response time must be below 500ms                       | 100ms, 200ms, 300ms        | 500ms, 501ms   |
 | `[IP] == 127.0.0.1`          | Target IP must be 127.0.0.1                             | 127.0.0.1                  | 0.0.0.0        |
 | `[BODY] == 1`                | The body must be equal to 1                             | 1                          | `{}`, `2`, ... |
@@ -135,12 +139,13 @@ Here are some examples of conditions you can use:
 
 #### Placeholders
 
-| Placeholder                  | Description                                             | Example of resolved value  |
+| Placeholder             | Description                                             | Example of resolved value |
-|:---------------------------- |:------------------------------------------------------- |:-------------------------- |
+|:----------------------- |:------------------------------------------------------- |:------------------------- |
-| `[STATUS]`                   | Resolves into the HTTP status of the request            | 404
+| `[STATUS]`              | Resolves into the HTTP status of the request            | 404
-| `[RESPONSE_TIME]`            | Resolves into the response time the request took, in ms | 10
+| `[RESPONSE_TIME]`       | Resolves into the response time the request took, in ms | 10
-| `[IP]`                       | Resolves into the IP of the target host                 | 192.168.0.232
+| `[IP]`                  | Resolves into the IP of the target host                 | 192.168.0.232
-| `[BODY]`                     | Resolves into the response body. Supports JSONPath.     | `{"name":"john.doe"}`
+| `[BODY]`                | Resolves into the response body. Supports JSONPath.     | `{"name":"john.doe"}`
+| `[CONNECTED]`           | Resolves into whether a connection could be established | `true`
 
 
 #### Functions
@@ -346,3 +351,60 @@ will send a `POST` request to `http://localhost:8080/playground` with the follow
 ```json
 {"query":"      {\n        user(gender: \"female\") {\n          id\n          name\n          gender\n          avatar\n        }\n      }"}
 ```
+
+
+### Recommended interval
+
+To ensure that Gatus provides reliable and accurate results (i.e. response time), Gatus only evaluates one service at a time. 
+In other words, even if you have multiple services with the exact same interval, they will not execute at the same time.
+
+You can test this yourself by running Gatus with several services configured with a very short, unrealistic interval, 
+such as 1ms. You'll notice that the response time does not fluctuate - that is because while services are evaluated on
+different goroutines, there's a global lock that prevents multiple services from running at the same time.
+
+Unfortunately, there is a drawback. If you have a lot of services, including some that are very slow or prone to time out (the default
+time out is 10s for HTTP and 5s for TCP), then it means that for the entire duration of the request, no other services can be evaluated.
+
+**This does mean that Gatus will be unable to evaluate the health of other services**. 
+The interval does not include the duration of the request itself, which means that if a service has an interval of 30s 
+and the request takes 2s to complete, the timestamp between two evaluations will be 32s, not 30s. 
+
+While this does not prevent Gatus' from performing health checks on all other services, it may cause Gatus to be unable 
+to respect the configured interval, for instance:
+- Service A has an interval of 5s, and times out after 10s to complete 
+- Service B has an interval of 5s, and takes 1ms to complete
+- Service B will be unable to run every 5s, because service A's health evaluation takes longer than its interval
+
+To sum it up, while Gatus can really handle any interval you throw at it, you're better off having slow requests with 
+higher interval.
+
+As a rule of the thumb, I personally set interval for more complex health checks to `5m` (5 minutes) and 
+simple health checks used for alerting (PagerDuty/Twilio) to `30s`.
+
+
+### Default timeouts
+
+| Protocol | Timeout |
+|:-------- |:------- |
+| HTTP     | 10s
+| TCP      | 5s
+
+
+### Monitoring a TCP service
+
+By prefixing `services[].url` with `tcp:\\`, you can monitor TCP services at a very basic level:
+
+```yaml
+  - name: redis
+    url: "tcp://127.0.0.1:6379"
+    interval: 30s
+    conditions:
+      - "[CONNECTED] == true"
+```
+
+Placeholders `[STATUS]` and `[BODY]` as well as the fields `services[].body`, `services[].insecure`, 
+`services[].headers`, `services[].method` and `services[].graphql` are not supported for TCP services.
+
+**NOTE**: `[CONNECTED] == true` does not guarantee that the service itself is healthy - it only guarantees that there's 
+something at the given address listening to the given port, and that a connection to that address was successfully 
+established.

client/client.go

@@ -2,6 +2,7 @@ package client
 
 import (
 	"crypto/tls"
+	"net"
 	"net/http"
 	"time"
 )
@@ -33,3 +34,12 @@ func GetHttpClient(insecure bool) *http.Client {
 		return secureHttpClient
 	}
 }
+
+func CanCreateConnectionToTcpService(address string) bool {
+	conn, err := net.DialTimeout("tcp", address, 5*time.Second)
+	if err != nil {
+		return false
+	}
+	_ = conn.Close()
+	return true
+}

client/client_test.go

@@ -1,6 +1,8 @@
 package client
 
-import "testing"
+import (
+	"testing"
+)
 
 func TestGetHttpClient(t *testing.T) {
 	if secureHttpClient != nil {

core/condition_test.go

@@ -265,3 +265,21 @@ func TestCondition_evaluateWithStatusPatternFailure(t *testing.T) {
 		t.Errorf("Condition '%s' should have been a failure", condition)
 	}
 }
+
+func TestCondition_evaluateWithConnected(t *testing.T) {
+	condition := Condition("[CONNECTED] == true")
+	result := &Result{Connected: true}
+	condition.evaluate(result)
+	if !result.ConditionResults[0].Success {
+		t.Errorf("Condition '%s' should have been a success", condition)
+	}
+}
+
+func TestCondition_evaluateWithConnectedFailure(t *testing.T) {
+	condition := Condition("[CONNECTED] == true")
+	result := &Result{Connected: false}
+	condition.evaluate(result)
+	if result.ConditionResults[0].Success {
+		t.Errorf("Condition '%s' should have been a failure", condition)
+	}
+}

core/service.go

@@ -9,6 +9,7 @@ import (
 	"net"
 	"net/http"
 	"net/url"
+	"strings"
 	"time"
 )
 
@@ -136,19 +137,30 @@ func (service *Service) getIp(result *Result) {
 }
 
 func (service *Service) call(result *Result) {
-	request := service.buildRequest()
+	isServiceTcp := strings.HasPrefix(service.Url, "tcp://")
-	startTime := time.Now()
+	var request *http.Request
-	response, err := client.GetHttpClient(service.Insecure).Do(request)
+	var response *http.Response
-	if err != nil {
+	var err error
-		result.Duration = time.Since(startTime)
+	if !isServiceTcp {
-		result.Errors = append(result.Errors, err.Error())
+		request = service.buildRequest()
-		return
 	}
-	result.Duration = time.Since(startTime)
+	startTime := time.Now()
-	result.HttpStatus = response.StatusCode
+	if isServiceTcp {
-	result.Body, err = ioutil.ReadAll(response.Body)
+		result.Connected = client.CanCreateConnectionToTcpService(strings.TrimPrefix(service.Url, "tcp://"))
-	if err != nil {
+		result.Duration = time.Since(startTime)
-		result.Errors = append(result.Errors, err.Error())
+	} else {
+		response, err = client.GetHttpClient(service.Insecure).Do(request)
+		result.Duration = time.Since(startTime)
+		if err != nil {
+			result.Errors = append(result.Errors, err.Error())
+			return
+		}
+		result.HttpStatus = response.StatusCode
+		result.Connected = response.StatusCode > 0
+		result.Body, err = ioutil.ReadAll(response.Body)
+		if err != nil {
+			result.Errors = append(result.Errors, err.Error())
+		}
 	}
 }
 

core/types.go

@@ -9,16 +9,37 @@ type HealthStatus struct {
 	Message string `json:"message,omitempty"`
 }
 
+// Result of the evaluation of a Service
 type Result struct {
-	HttpStatus       int                `json:"status"`
+	// HttpStatus is the HTTP response status code
-	Body             []byte             `json:"-"`
+	HttpStatus int `json:"status"`
-	Hostname         string             `json:"hostname"`
+
-	Ip               string             `json:"-"`
+	// Body is the response body
-	Duration         time.Duration      `json:"duration"`
+	Body []byte `json:"-"`
-	Errors           []string           `json:"errors"`
+
+	// Hostname extracted from the Service Url
+	Hostname string `json:"hostname"`
+
+	// Ip resolved from the Service Url
+	Ip string `json:"-"`
+
+	// Connected whether a connection to the host was established successfully
+	Connected bool `json:"-"`
+
+	// Duration time that the request took
+	Duration time.Duration `json:"duration"`
+
+	// Errors encountered during the evaluation of the service's health
+	Errors []string `json:"errors"`
+
+	// ConditionResults results of the service's conditions
 	ConditionResults []*ConditionResult `json:"condition-results"`
-	Success          bool               `json:"success"`
+
-	Timestamp        time.Time          `json:"timestamp"`
+	// Success whether the result signifies a success or not
+	Success bool `json:"success"`
+
+	// Timestamp when the request was sent
+	Timestamp time.Time `json:"timestamp"`
 }
 
 type ConditionResult struct {

core/util.go

@@ -12,6 +12,7 @@ const (
 	IPPlaceHolder           = "[IP]"
 	ResponseTimePlaceHolder = "[RESPONSE_TIME]"
 	BodyPlaceHolder         = "[BODY]"
+	ConnectedPlaceHolder    = "[CONNECTED]"
 
 	LengthFunctionPrefix  = "len("
 	PatternFunctionPrefix = "pat("
@@ -35,6 +36,8 @@ func sanitizeAndResolve(list []string, result *Result) []string {
 			element = strconv.Itoa(int(result.Duration.Milliseconds()))
 		case BodyPlaceHolder:
 			element = body
+		case ConnectedPlaceHolder:
+			element = strconv.FormatBool(result.Connected)
 		default:
 			// if contains the BodyPlaceHolder, then evaluate json path
 			if strings.Contains(element, BodyPlaceHolder) {