Skip to content

Commit e2bf45d

Browse files
Merge branch 'main' into SEOlearn
2 parents 4c1612d + 1e1c3ff commit e2bf45d

File tree

6 files changed

+84
-14
lines changed

6 files changed

+84
-14
lines changed

site/config.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,20 @@ disqusShortname = "checkly"
8080
url = "/docs/multistep-checks/"
8181
weight = 40
8282

83+
[[menu.resources]]
84+
name = "TCP checks"
85+
url = "/docs/tcp-checks/"
86+
weight = 45
87+
8388
[[menu.resources]]
8489
name = "Groups"
8590
url = "/docs/groups/"
86-
weight = 45
91+
weight = 50
8792

8893
[[menu.resources]]
8994
name = "Alerting & retries"
9095
url = "/docs/alerting/"
91-
weight = 50
96+
weight = 55
9297

9398
[[menu.resources]]
9499
name = "Maintenance windows"

site/content/docs/_index.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ aliases:
66
- /docs/
77
---
88

9-
Checkly gives you code-first synthetic monitoring for modern DevOps. Monitor your APIs and apps at a fraction of the
10-
price of legacy providers. Powered by Monitoring as Code and Playwright.
9+
Checkly gives you code-first synthetic monitoring for modern DevOps. Monitor your APIs, service connectivity and apps at a fraction of the price of legacy providers. Powered by Monitoring as Code and Playwright.
1110

1211
## Get started with monitoring as code
1312

@@ -71,21 +70,29 @@ monitoring in minutes.
7170
{{< doc-card
7271
class="two-column-card"
7372
headerTag="h3"
74-
title="Create a Heartbeat check"
75-
img="/docs/images/icons/heartbeats-check-stroked.svg"
76-
description="Monitor your backup jobs, data imports, and other recurring jobs or scripts by pinging Checkly at a regular interval."
77-
link="/docs/heartbeat-checks/"
73+
title="Create a TCP check"
74+
img="/docs/images/icons/tcp.svg"
75+
description="Monitor the availability and performance of your TCP services by establishing TCP connections and verifying the response."
76+
link="/docs/tcp-checks/"
7877
>}}
7978
</div>
8079
8180
<div class="cards-list">
8281
{{< doc-card
83-
class="full-width-card"
84-
headerTag="h3"
85-
title="Set up alert channels"
86-
img="/docs/images/icons/alerting.svg"
87-
description="Get notified about outages, broken transactions or slow downs in your webapps and APIs. Connect to one of our many integrations like Slack, Pagerduty and Discord."
88-
link="/docs/alerting"
82+
class="two-column-card"
83+
headerTag="h3"
84+
title="Create a Heartbeat check"
85+
img="/docs/images/icons/heartbeats-check-stroked.svg"
86+
description="Monitor your backup jobs, data imports, and other recurring jobs or scripts by pinging Checkly at a regular interval."
87+
link="/docs/heartbeat-checks/"
88+
>}}
89+
{{< doc-card
90+
class="two-column-card"
91+
headerTag="h3"
92+
title="Set up alert channels"
93+
img="/docs/images/icons/alerting.svg"
94+
description="Get notified about outages, broken transactions or slow downs in your webapps and APIs. Connect to one of our many integrations like Slack, Pagerduty and Discord."
95+
link="/docs/alerting"
8996
>}}
9097
</div>
9198

site/content/docs/integrations/slack.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ You have the option to customize the default channel you've set in Slack by sett
1919

2020
By customizing the channel name, alerting options & checks for that alert channel, you can use a single Incoming WebHook URL for multiple scenarios.
2121

22+
>[!WARNING]
23+
> If you’re using a free Slack workspace, be aware of [message limits](https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces). Exceeding these limits may prevent new alerts from being delivered.
24+
2225
## Example Failed Slack Alert
2326

2427
We provide a lot of information in the initial Slack message including links to the check and check result as well as the whole response body.

site/content/docs/monitoring/check-results.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,17 @@ In the request details you will also find the result of any assertion done as pa
140140

141141
<video alt="Using the Multistep check results view" autoplay loop muted src="/docs/images/monitoring/check-results-multistep.mp4"></video>
142142

143+
## TCP check results
143144

145+
On the [check results overview page](/docs/monitoring/check-results/#check-results-overview), select a specific check run to review its results:
146+
147+
* **Summary:** Displays the check target (URL and port), the check state (`success` for passed and degraded runs, or `error` for failed runs), the request status code and the total check run duration.
148+
149+
* **Error details:** If the check failed, the error status code and message log will be shown.
150+
151+
* **Timing phases:** For each request, we capture the following timing metrics:
152+
* DNS: Time taken to resolve the hostname to an IP address (if a hostname was provided)
153+
* Connect: Time taken to establish the TCP connection (SYN, SYN-ACK, ACK)
144154

145155
## Check results with retries
146156

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Monitoring your services with TCP checks - Checkly Docs
3+
displayTitle: Monitoring your services with TCP checks
4+
weight: 7
5+
menu:
6+
resources:
7+
parent: "TCP checks"
8+
navTitle: Overview
9+
slug: /
10+
cli: true
11+
---
12+
13+
> **Early Access Feature:**
14+
> This feature is available in early access and is currently **UI-only**. To enable it, please reach out to our [support team](mailto:[email protected]) or connect with us via the [Checkly community Slack](https://www.checklyhq.com/slack). We’d love to hear your feedback!
15+
16+
## Overview
17+
18+
A TCP check establishes a connection to a specified hostname or IP address and port to verify that the service is responsive. These checks are ideal for monitoring non-HTTP services, such as databases, message queues, and custom applications that rely on TCP connectivity.
19+
20+
## Create a TCP check
21+
22+
* **Create a check:** Click the `+` icon on the sidebar and select **TCP check** from the list. This will open the check creation page.
23+
24+
* **Name & tags:** On the check creation page, choose a meaningful name for the check to easily identify it. Optionally, add one or more tags to further categorize or group the check.
25+
26+
* **The TCP request:** Configure the TCP endpoint to monitor by specifying a **hostname or IP address** (e.g., tcpbin.com or 192.168.1.1) and a **port** (e.g., 4242).
27+
28+
* **Set response time limits:** Define thresholds for marking the check as degraded or failed. This allows you to specify when requests should be considered slow (degraded) or entirely unreachable (failed).
29+
30+
* **Scheduling strategy & locations:** Choose a [scheduling strategy](/docs/monitoring/global-locations#scheduling-strategies) and which [location](/docs/monitoring/global-locations) you would like to run your TCP check from. Please note that [private locations](/docs/private-locations) are not yet supported for TCP checks but will be available soon.
31+
32+
* **Scheduling:** Schedule your checks to run at intervals between 10 seconds (minimum) and 24 hours (maximum).
33+
34+
* **Retries & alerting:** Configure [retries & alerts](/docs/alerting-and-retries) by choosing from Checkly's retry strategies and alert channels, ensuring you’re notified through your preferred methods when an issue arises with one of your TCP checks.
35+
36+
## Update or delete a TCP check
37+
38+
* **Update a TCP check:** To update a TCP check, click the kebab menu (three dots) next to the check on your [main dashboard](https://app.checklyhq.com) and select `Edit`, or click `Edit` in the top-right corner of the check's Reporting page.
39+
40+
* **Delete a TCP check:** To delete a TCP check, use the kebab menu (three dots) on the [main dashboard](https://app.checklyhq.com) and select `Delete`. Alternatively click `Edit` in the top-right corner of the check's Reporting page, scroll to the bottom section, and click the `Delete` button.
41+
42+
## TCP check reporting
43+
44+
Learn more about analyzing your TCP check run results in our [check results documentation](/docs/monitoring/check-results#tcp-check-results).

site/static/docs/images/icons/tcp.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)