feat: add minutes to heartbeat resource, update docs [sc-18336] (#281)

Co-authored-by: Maxi <[email protected]>
checkly · Dec 15, 2023 · c594e3a · c594e3a
1 parent 0c19cdd
commit c594e3a
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/checkly/resource_heartbeat.go b/checkly/resource_heartbeat.go
@@ -156,14 +156,15 @@ func resourceHeartbeat() *schema.Resource {
 						"period": {
 							Type:     schema.TypeInt,
 							Required: true,
+							Description: "How often you expect a ping to the ping URL.",
 						},
 						"period_unit": {
 							Type:     schema.TypeString,
 							Required: true,
 							ValidateFunc: func(value interface{}, key string) (warns []string, errs []error) {
 								v := value.(string)
 								isValid := false
-								options := []string{"seconds", "minutes", "days"}
+								options := []string{"seconds", "minutes", "hours", "days"}
 								for _, option := range options {
 									if v == option {
 										isValid = true
@@ -174,18 +175,20 @@ func resourceHeartbeat() *schema.Resource {
 								}
 								return warns, errs
 							},
+							Description: "Possible values `seconds`, `minutes`, `hours` and `days`.",
 						},
 						"grace": {
 							Type:     schema.TypeInt,
 							Required: true,
+							Description: "How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.",
 						},
 						"grace_unit": {
 							Type:     schema.TypeString,
 							Required: true,
 							ValidateFunc: func(value interface{}, key string) (warns []string, errs []error) {
 								v := value.(string)
 								isValid := false
-								options := []string{"seconds", "minutes", "days"}
+								options := []string{"seconds", "minutes", "hours", "days"}
 								for _, option := range options {
 									if v == option {
 										isValid = true
@@ -196,11 +199,13 @@ func resourceHeartbeat() *schema.Resource {
 								}
 								return warns, errs
 							},
+							Description: "Possible values `seconds`, `minutes`, `hours` and `days`.",
 						},
 						"ping_token": {
 							Type:     schema.TypeString,
 							Optional: true,
 							Computed: true,
+							Description: "Custom token to generate your ping URL. Checkly will expect a ping to `https://ping.checklyhq.com/[PING_TOKEN]`.",
 						},
 					},
 				},

diff --git a/checkly/resource_heartbeat_test.go b/checkly/resource_heartbeat_test.go
@@ -132,7 +132,7 @@ func TestAccHeartbeatCheckInvalidPeriodUnit(t *testing.T) {
 	accTestCase(t, []resource.TestStep{
 		{
 			Config:      config,
-			ExpectError: regexp.MustCompile(`"heartbeat\.0\.period_unit" must be one of \[seconds minutes days\], got lightyear`),
+			ExpectError: regexp.MustCompile(`"heartbeat\.0\.period_unit" must be one of \[seconds minutes hours days\], got lightyear`),
 		},
 	})
 }
@@ -151,7 +151,7 @@ func TestAccHeartbeatCheckInvalidGraceUnit(t *testing.T) {
 	accTestCase(t, []resource.TestStep{
 		{
 			Config:      config,
-			ExpectError: regexp.MustCompile(`"heartbeat\.0\.grace_unit" must be one of \[seconds minutes days\], got lightyear`),
+			ExpectError: regexp.MustCompile(`"heartbeat\.0\.grace_unit" must be one of \[seconds minutes hours days\], got lightyear`),
 		},
 	})
 }

diff --git a/docs/resources/heartbeat.md b/docs/resources/heartbeat.md
@@ -38,14 +38,14 @@ Heartbeats allows you to monitor your cron jobs and set up alerting, so you get
 
 Required:
 
-- `grace` (Number)
-- `grace_unit` (String)
-- `period` (Number)
-- `period_unit` (String)
+- `grace` (Number) How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
+- `grace_unit` (String) Possible values `seconds`, `minutes`, `hours` and `days`.
+- `period` (Number) How often you expect a ping to the ping URL.
+- `period_unit` (String) Possible values `seconds`, `minutes`, `hours` and `days`.
 
 Optional:
 
-- `ping_token` (String)
+- `ping_token` (String) Custom token to generate your ping URL. Checkly will expect a ping to `https://ping.checklyhq.com/[PING_TOKEN]`.
 
 
 <a id="nestedblock--alert_channel_subscription"></a>