fix(check): Failing checks and default location (#18)

* fix(check): Set MaxResponseTime correctly

Previously we've been setting MaxResponseTime as the Frequency,
MaxResponseTime is supposed to be in miliseconds, thus setting Frequency
to 5, would make MaxResponseTime 5 miliseconds, the checklyhq backend
didn't know what to do with this number so it was empty, created checks
failed immediately.

This fixes #17.

* fix(check): Do not set location for checks

Checks are tied to group, each group has location settings, we shouldn't
set the default location to eu-west-1 anymore

* test(debug): Add debug script for checkly checks

Author: akosveres

.dockerignore

@@ -2,6 +2,7 @@
 # Ignore build and test binaries.
 bin/
 testbin/
+hack/
 
 # direnv
 .envrc

apis/checkly/v1alpha1/apicheck_types.go

@@ -34,9 +34,6 @@ type ApiCheckSpec struct {
 	// Muted determines if the created alert is muted or not, default false
 	Muted bool `json:"muted,omitempty"`
 
-	// Locations determines the locations where the checks are run from, see https://www.checklyhq.com/docs/monitoring/global-locations/ for a list, use AWS Region codes, ex. eu-west-1 for Ireland
-	Locations []string `json:"locations,omitempty"`
-
 	// Endpoint determines which URL to monitor, ex. https://foo.bar/baz
 	Endpoint string `json:"endpoint"`
 

apis/checkly/v1alpha1/zz_generated.deepcopy.go

@@ -64,13 +64,6 @@ spec:
                 description: Group determines in which group does the check belong
                   to
                 type: string
-              locations:
-                description: Locations determines the locations where the checks are
-                  run from, see https://www.checklyhq.com/docs/monitoring/global-locations/
-                  for a list, use AWS Region codes, ex. eu-west-1 for Ireland
-                items:
-                  type: string
-                type: array
               maxresponsetime:
                 description: MaxResponseTime determines what the maximum number of
                   miliseconds can pass before the check fails, default 15000

config/crd/bases/k8s.checklyhq.com_apichecks.yaml

@@ -9,6 +9,3 @@ spec:
   frequency: 10 # Default 5
   muted: true # Default "false"
   group: "group-sample"
-  # locations: # Default eu-west-1
-  #   - eu-west-1
-  #   - ap-northeast-2

config/samples/checkly_v1alpha1_apicheck.yaml

@@ -139,8 +139,7 @@ func (r *ApiCheckReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		Name:            apiCheck.Name,
 		Namespace:       apiCheck.Namespace,
 		Frequency:       apiCheck.Spec.Frequency,
-		MaxResponseTime: apiCheck.Spec.Frequency,
-		Locations:       apiCheck.Spec.Locations,
+		MaxResponseTime: apiCheck.Spec.MaxResponseTime,
 		Endpoint:        apiCheck.Spec.Endpoint,
 		SuccessCode:     apiCheck.Spec.Success,
 		ID:              apiCheck.Status.ID,

controllers/checkly/apicheck_controller.go

@@ -30,7 +30,6 @@ type Check struct {
 	Namespace       string
 	Frequency       int
 	MaxResponseTime int
-	Locations       []string
 	Endpoint        string
 	SuccessCode     string
 	GroupID         int64
@@ -70,7 +69,7 @@ func checklyCheck(apiCheck Check) (check checkly.Check) {
 		SSLCheck:             false,
 		LocalSetupScript:     "",
 		LocalTearDownScript:  "",
-		Locations:            checkValueArray(apiCheck.Locations, []string{"eu-west-1"}),
+		Locations:            []string{},
 		Tags: []string{
 			apiCheck.Namespace,
 			"checkly-operator",

external/checkly/check.go

@@ -31,7 +31,6 @@ func TestChecklyCheck(t *testing.T) {
 		Namespace:       "bar",
 		Frequency:       15,
 		MaxResponseTime: 2000,
-		Locations:       []string{"basement"},
 		Endpoint:        "https://foo.bar/baz",
 		SuccessCode:     "200",
 		Muted:           true,
@@ -84,7 +83,6 @@ func TestChecklyCheckActions(t *testing.T) {
 		Namespace:       "bar",
 		Frequency:       15,
 		MaxResponseTime: 2000,
-		Locations:       []string{"basement"},
 		Endpoint:        "https://foo.bar/baz",
 		SuccessCode:     "200",
 		ID:              "",

external/checkly/check_test.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"flag"
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/checkly/checkly-go-sdk"
+	ctrl "sigs.k8s.io/controller-runtime"
+)
+
+// The script returns the data for a specific checkly check from the checklyhq API,
+// it's meant to be used as a debug tool for issues with checks created.
+
+func main() {
+
+	setupLog := ctrl.Log.WithName("setup")
+
+	var checklyID string
+
+	flag.StringVar(&checklyID, "c", "", "Specify the checkly check ID")
+	flag.Parse()
+
+	if checklyID == "" {
+		setupLog.Error(errors.New("ChecklyID is empty"), "exiting due to missing information")
+		os.Exit(1)
+	}
+
+	baseUrl := "https://api.checklyhq.com"
+	apiKey := os.Getenv("CHECKLY_API_KEY")
+	if apiKey == "" {
+		setupLog.Error(errors.New("checklyhq.com API key environment variable is undefined"), "checklyhq.com credentials missing")
+		os.Exit(1)
+	}
+
+	accountId := os.Getenv("CHECKLY_ACCOUNT_ID")
+	if accountId == "" {
+		setupLog.Error(errors.New("checklyhq.com Account ID environment variable is undefined"), "checklyhq.com credentials missing")
+		os.Exit(1)
+	}
+
+	client := checkly.NewClient(
+		baseUrl,
+		apiKey,
+		nil, //custom http client, defaults to http.DefaultClient
+		nil, //io.Writer to output debug messages
+	)
+
+	client.SetAccountId(accountId)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
+	defer cancel()
+
+	returnedCheck, err := client.Get(ctx, checklyID)
+	if err != nil {
+		setupLog.Error(err, "failed to get check")
+		os.Exit(1)
+	}
+
+	fmt.Printf("%+v", returnedCheck)
+
+}