Skip to content

Add timeout to statuscake endpointmonitor #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinderooij-rl merged 6 commits into from
Sep 4, 2025
Merged

Add timeout to statuscake endpointmonitor #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dd440e
Add timeout to statuscake endpointmonitor
robinderooij-rl Aug 29, 2025
5b5f743
Update pkg/monitors/statuscake/statuscake-monitor_test.go
robinderooij-rl Sep 1, 2025
8508efb
Add seconds to clarify
robinderooij-rl Sep 1, 2025
16039c8
Update api/v1alpha1/endpointmonitor_types.go
robinderooij-rl Sep 1, 2025
bbc1604
Update config/crd/bases/endpointmonitor.stakater.com_endpointmonitors…
robinderooij-rl Sep 4, 2025
7d93ede
Update docs/statuscake-configuration.md
robinderooij-rl Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions api/v1alpha1/endpointmonitor_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,12 @@ type StatusCakeConfig struct {
// UserAgent is used to set a user agent string.
// +optional
UserAgent string `json:"userAgent,omitempty"`

// Timeout is used to set a user agent string.
// +kubebuilder:validation:Maximum=75
// +kubebuilder:validation:Minimum=1
// +optional
Timeout int `json:"timeout,omitempty"`
}

// PingdomConfig defines the configuration for Pingdom Monitor Provider
Expand Down
5 changes: 5 additions & 0 deletions config/crd/bases/endpointmonitor.stakater.com_endpointmonitors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,11 @@ spec:
testType:
description: Set Test type - HTTP, TCP, PING
type: string
timeout:
description: Timeout is used to set a user agent string.
maximum: 75
minimum: 1
type: integer
triggerRate:
description: Minutes to wait before sending an alert
type: integer
Expand Down
35 changes: 18 additions & 17 deletions docs/statuscake-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,24 @@ The following properties need to be configured for Statuscake, in addition to th

Currently additional Statuscake configurations can be added through these fields:

| Fields | Description |
|:--------------------------------------------------------:|:------------------------------------------------:|
| CheckRate | Set Check Rate for the monitor (default: 300) |
| TestType | Set Test type - HTTP, TCP, PING (default: HTTP) |
| Paused | Pause the service |
| PingURL | Webhook for alerts |
| FollowRedirect | Enable ingress redirects |
| Port | TCP Port |
| TriggerRate | Minutes to wait before sending an alert |
| ContactGroup | Contact Group to be alerted. |
| TestTags | Comma separated list of tags |
| FindString | String to look for within the response |
| BasicAuthUser | Required for [basic-authenticationchecks](#basic-auth-checks) |
| BasicAuthSecret | Allows for an alternate method of adding basic-auth to checks |
| Regions | Regions to execute the check from |
| RawPostData | Add data to change the request to a POST |
| UserAgent | Add a user agent string to the request |
| Fields | Description |
|:---------------:|:---------------------------------------------------------------:|
| CheckRate | Set Check Rate for the monitor (default: 300) |
| TestType | Set Test type - HTTP, TCP, PING (default: HTTP) |
| Paused | Pause the service |
| PingURL | Webhook for alerts |
| FollowRedirect | Enable ingress redirects |
| Port | TCP Port |
| TriggerRate | Minutes to wait before sending an alert |
| ContactGroup | Contact Group to be alerted. |
| TestTags | Comma separated list of tags |
| FindString | String to look for within the response |
| BasicAuthUser | Required for [basic-authenticationchecks](#basic-auth-checks) |
| BasicAuthSecret | Allows for an alternate method of adding basic-auth to checks |
| Regions | Regions to execute the check from |
| RawPostData | Add data to change the request to a POST |
| UserAgent | Add a user agent string to the request |
| Timeout | Timeout for the check in seconds (minimum of 1 and maximum of 75|


### Basic Auth checks
Expand Down
3 changes: 3 additions & 0 deletions pkg/monitors/statuscake/statuscake-monitor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,9 @@ func buildUpsertForm(m models.Monitor, cgroup string) url.Values {
if providerConfig != nil && len(providerConfig.UserAgent) > 0 {
f.Add("user_agent", providerConfig.UserAgent)
}
if providerConfig != nil && providerConfig.Timeout > 0 {
f.Add("timeout", strconv.Itoa(providerConfig.Timeout))
}
return f
}

Expand Down
2 changes: 2 additions & 0 deletions pkg/monitors/statuscake/statuscake-monitor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ func TestBuildUpsertForm(t *testing.T) {
Confirmation: 2,
EnableSSLAlert: true,
FindString: "",
Timeout: 30,

// changed to string array type on statuscake api
// TODO: release new apiVersion to cater new type in apiVersion struct
Expand Down Expand Up @@ -143,4 +144,5 @@ func TestBuildUpsertForm(t *testing.T) {
assert.Equal(t, "test,testrun,uptime", convertUrlValuesToString(vals, "tags[]"))
assert.Equal(t, "TCP", vals.Get("test_type"))
assert.Equal(t, "1", vals.Get("trigger_rate"))
assert.Equal(t, "30", vals.Get("timeout"))
}
Loading