-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First draft for TCP check docs page (#1140)
* First draft for TCP check docs page * Removed pricing * Commented non exitent docs out * Updated TCP checks pricing and results references * Consistent capitalization * Updated formatting and punctuation * fix: Comment out tab sections in TCP checks documentation * feat: bump up TCP checks in resources menu * feat: add TCP checks and add corresponding icon in doc landing * feat: enhance description of monitoring capabilities in documentation * Update site/content/docs/monitoring/check-pricing.md Co-authored-by: Paula Mallol <[email protected]> * Update site/content/docs/monitoring/check-results.md Co-authored-by: Paula Mallol <[email protected]> * Update site/content/docs/monitoring/check-results.md Co-authored-by: Paula Mallol <[email protected]> * Update site/content/docs/tcp-checks/_index.md Co-authored-by: Paula Mallol <[email protected]> * Update _index.md * Added "Early access" info note Add * Updates pricing reference * Updated preview page * Commented out pricing section * Removed pricing * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Remove tabs, add UI only note --------- Co-authored-by: Paula Mallol <[email protected]> Co-authored-by: Paula Mallol <[email protected]>
- Loading branch information
1 parent
3c66862
commit 1e1c3ff
Showing
5 changed files
with
81 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: Monitoring your services with TCP checks - Checkly Docs | ||
displayTitle: Monitoring your services with TCP checks | ||
weight: 7 | ||
menu: | ||
resources: | ||
parent: "TCP checks" | ||
navTitle: Overview | ||
slug: / | ||
cli: true | ||
--- | ||
|
||
> **Early Access Feature:** | ||
> 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! | ||
## Overview | ||
|
||
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. | ||
|
||
## Create a TCP check | ||
|
||
* **Create a check:** Click the `+` icon on the sidebar and select **TCP check** from the list. This will open the check creation page. | ||
|
||
* **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. | ||
|
||
* **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). | ||
|
||
* **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). | ||
|
||
* **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. | ||
|
||
* **Scheduling:** Schedule your checks to run at intervals between 10 seconds (minimum) and 24 hours (maximum). | ||
|
||
* **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. | ||
|
||
## Update or delete a TCP check | ||
|
||
* **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. | ||
|
||
* **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. | ||
|
||
## TCP check reporting | ||
|
||
Learn more about analyzing your TCP check run results in our [check results documentation](/docs/monitoring/check-results#tcp-check-results). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.