Skip to content

Commit 9ce3044

Browse files
authored
Adjusted should fail docs (#1280)
* Adjusted should fail docs * wording changes * minor wording change
1 parent 699ffcf commit 9ce3044

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

site/content/docs/api-checks/request-settings.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,12 @@ An API check starts with creating an HTTP request including a HTTP verb (GET, PO
2525
- Available methods are `GET, POST, PUT, HEAD, DELETE, PATCH`
2626
- URL's are checked for correctness and must start with either `http://` or `https://`
2727

28-
Checking the **"This request should fail"** box allows you to treat HTTP error codes (4xx and 5xx) as correct responses. This comes
29-
in handy when testing 404 pages or 500 error handling.
28+
Checking the **"This request should fail"** checkbox allows you to treat HTTP error codes (4xx and 5xx) as correct responses. This comes in handy when testing 404 pages or 500 error handling.
3029

30+
When enabled:
31+
* ✅ Failed responses (4xx, 5xx) → check passes
32+
* ✅ Successful responses → check passes
33+
* ❌ Failed assertions → check fails
3134

3235
## Body
3336

site/content/docs/tcp-checks/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For example, use these checks to verify that:
1616

1717
* Your mail server is online and responds to IMAPS requests quickly.
1818
* Your FTP server responds correctly to commands.
19-
* Your firewall blocks access to certain ports.
19+
* Your custom TCP-based service returns the expected response when sent a health check message.
2020

2121
![Screenshot of the TCP check overview page](/docs/images/tcp-checks/tcp-check-overview.png)
2222

@@ -30,7 +30,7 @@ The main part of your check is the TCP request, which defines the endpoint to mo
3030

3131
* **Target:** The TCP endpoint to monitor, as defined by a hostname or IP address (e.g. `tcpbin.com` or `192.168.1.1`) and a port (e.g. `4242`).
3232
* **IP family:** The default is IPv4. If needed, change the [IP family](/docs/monitoring/ip-info/#ipv4-and-ipv6-support) setting to IPv6.
33-
* **This request should fail:** Enable this option to mark failed connections as passed. Please note that failing assertions will still cause the check to fail.
33+
* **This request should fail:** Enable this option to treat connection failures (e.g. timeouts or refused ports) as passed. Please note that successful connections will continue to pass. Only failed assertions will cause the check to fail.
3434
* **Data to send:** The content included in the TCP request. For example, this could be text or protocol-specific commands expected by the target service.
3535

3636
To validate the response, you can set:

0 commit comments

Comments
 (0)