checks: Add Interval and Timeout to API response (#10717)

hashicorp · Aug 18, 2021 · 06d2140 · 06d2140
1 parent 9cb722b
commit 06d2140
Show file tree

Hide file tree

Showing 10 changed files with 207 additions and 72 deletions.
diff --git a/.changelog/10717.txt b/.changelog/10717.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+checks: Add Interval and Timeout to API response.
+```
diff --git a/agent/agent_endpoint_test.go b/agent/agent_endpoint_test.go
@@ -678,10 +678,12 @@ func TestAgent_Checks(t *testing.T) {
 
 	testrpc.WaitForTestAgent(t, a.RPC, "dc1")
 	chk1 := &structs.HealthCheck{
-		Node:    a.Config.NodeName,
-		CheckID: "mysql",
-		Name:    "mysql",
-		Status:  api.HealthPassing,
+		Node:     a.Config.NodeName,
+		CheckID:  "mysql",
+		Name:     "mysql",
+		Interval: "30s",
+		Timeout:  "5s",
+		Status:   api.HealthPassing,
 	}
 	a.State.AddCheck(chk1, "")
 
@@ -697,6 +699,15 @@ func TestAgent_Checks(t *testing.T) {
 	if val["mysql"].Status != api.HealthPassing {
 		t.Fatalf("bad check: %v", obj)
 	}
+	if val["mysql"].Node != chk1.Node {
+		t.Fatalf("bad check: %v", obj)
+	}
+	if val["mysql"].Interval != chk1.Interval {
+		t.Fatalf("bad check: %v", obj)
+	}
+	if val["mysql"].Timeout != chk1.Timeout {
+		t.Fatalf("bad check: %v", obj)
+	}
 }
 
 func TestAgent_ChecksWithFilter(t *testing.T) {

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -2631,6 +2631,7 @@ func TestAgent_PurgeCheckOnDuplicate(t *testing.T) {
 			notes = "my cool notes"
 			args = ["/bin/check-redis.py"]
 			interval = "30s"
+			timeout = "5s"
 		}
 	`})
 	defer a2.Shutdown()
@@ -2647,6 +2648,8 @@ func TestAgent_PurgeCheckOnDuplicate(t *testing.T) {
 		Name:           "memory check",
 		Status:         api.HealthCritical,
 		Notes:          "my cool notes",
+		Interval:       "30s",
+		Timeout:        "5s",
 		EnterpriseMeta: *structs.DefaultEnterpriseMeta(),
 	}
 	require.Equal(t, expected, result)

diff --git a/agent/structs/check_definition.go b/agent/structs/check_definition.go
@@ -156,6 +156,8 @@ func (c *CheckDefinition) HealthCheck(node string) *HealthCheck {
 		Status:         api.HealthCritical,
 		Notes:          c.Notes,
 		ServiceID:      c.ServiceID,
+		Interval:       c.Interval.String(),
+		Timeout:        c.Timeout.String(),
 		EnterpriseMeta: c.EnterpriseMeta,
 	}
 	if c.Status != "" {

diff --git a/agent/structs/structs.go b/agent/structs/structs.go
@@ -1430,6 +1430,9 @@ type HealthCheck struct {
 	ServiceTags []string      // optional service tags
 	Type        string        // Check type: http/ttl/tcp/etc
 
+	Interval string // from definition
+	Timeout  string // from definition
+
 	// ExposedPort is the port of the exposed Envoy listener representing the
 	// HTTP or GRPC health check of the service.
 	ExposedPort int

diff --git a/agent/structs/structs_filtering_test.go b/agent/structs/structs_filtering_test.go
@@ -550,6 +550,19 @@ var expectedFieldConfigHealthCheck bexpr.FieldConfigurations = bexpr.FieldConfig
 		SupportedOperations: []bexpr.MatchOperator{bexpr.MatchEqual, bexpr.MatchNotEqual, bexpr.MatchIn, bexpr.MatchNotIn, bexpr.MatchMatches, bexpr.MatchNotMatches},
 		StructFieldName:     "Type",
 	},
+
+	"Interval": &bexpr.FieldConfiguration{
+		CoerceFn:            bexpr.CoerceString,
+		SupportedOperations: []bexpr.MatchOperator{bexpr.MatchEqual, bexpr.MatchNotEqual, bexpr.MatchIn, bexpr.MatchNotIn, bexpr.MatchMatches, bexpr.MatchNotMatches},
+		StructFieldName:     "Interval",
+	},
+
+	"Timeout": &bexpr.FieldConfiguration{
+		CoerceFn:            bexpr.CoerceString,
+		SupportedOperations: []bexpr.MatchOperator{bexpr.MatchEqual, bexpr.MatchNotEqual, bexpr.MatchIn, bexpr.MatchNotIn, bexpr.MatchMatches, bexpr.MatchNotMatches},
+		StructFieldName:     "Timeout",
+	},
+
 	"ExposedPort": &bexpr.FieldConfiguration{
 		CoerceFn:            bexpr.CoerceInt,
 		SupportedOperations: []bexpr.MatchOperator{bexpr.MatchEqual, bexpr.MatchNotEqual},

diff --git a/proto/pbservice/healthcheck.gen.go b/proto/pbservice/healthcheck.gen.go
diff --git a/proto/pbservice/healthcheck.pb.go b/proto/pbservice/healthcheck.pb.go
diff --git a/proto/pbservice/healthcheck.proto b/proto/pbservice/healthcheck.proto
@@ -44,6 +44,9 @@ message HealthCheck {
 
     // mog: func-to=int func-from=int32
     int32 ExposedPort = 14;
+
+    string Interval = 15;
+    string Timeout = 16;
 }
 
 message HeaderValue {

diff --git a/website/content/api-docs/agent/check.mdx b/website/content/api-docs/agent/check.mdx
@@ -67,6 +67,8 @@ $ curl \
     "ServiceID": "redis",
     "ServiceName": "redis",
     "ServiceTags": ["primary"],
+    "Interval": "10s",
+    "Timeout": "1s"
     "Type": "tcp",
     "ExposedPort": 0,
     "Definition": {},