Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Expanded on TCP check docs - #1200

Merged
sujaya-sys merged 9 commits into
mainfrom
tcp-docs-updates
Jan 30, 2025
Merged

Expanded on TCP check docs#1200
sujaya-sys merged 9 commits into
mainfrom
tcp-docs-updates

Conversation

@sujaya-sys

@sujaya-sys sujaya-sys commented Jan 28, 2025

Copy link
Copy Markdown
Contributor

Sanity check on the new examples needed - I oriented towards customer use cases however relied on Google & ChatGPT to expand them. Would be great to get some feedback on whether these make sense from a more technical POV. Thank you!

@vercel

vercel Bot commented Jan 28, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
checklyhq-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2025 5:59pm

Comment thread site/content/docs/tcp-checks/_index.md Outdated
* Mail servers (e.g. `mail.example.org:993`): Use TCP checks to ensure your mail server is online and processing requests efficiently. For example, set an assertion on the response time to confirm the server accepts IMAPS connections without delays. This helps you spot slowdowns and provide reliable email services for your users.

* **Databases** (e.g. `database.example.org:3306`): Verify that your database server is online and able to accept connections.
* Databases (e.g. `database.example.org:3306`): Check that your database is online and accepting connections. To ensure that queries are processed as expected, you can additionally send a simple query like `SELECT 1` as part of the request and confirm the response matches what you’d expect via assertions.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be able to send the SELECT 1 to the server, the customer would need to implement the MySQL line protocol within the payload. I don't think that's a feasible example at the moment.

@pmallol pmallol left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be useful to add TCP subpages (similar to API):

  1. TCP Assertions, such as https://www.checklyhq.com/docs/api-checks/assertions/
  2. Response time limits, https://www.checklyhq.com/docs/api-checks/limits/
  3. Timeout and timing, https://www.checklyhq.com/docs/api-checks/timeouts-timing/

I can help with this if needed!

@sujaya-sys

sujaya-sys commented Jan 28, 2025

Copy link
Copy Markdown
Contributor Author

Might be useful to add TCP subpages (similar to API):

  1. TCP Assertions, such as https://www.checklyhq.com/docs/api-checks/assertions/
  2. Response time limits, https://www.checklyhq.com/docs/api-checks/limits/
  3. Timeout and timing, https://www.checklyhq.com/docs/api-checks/timeouts-timing/

I can help with this if needed!

Great point, added as a to do here: https://www.notion.so/checkly/TCP-Check-Release-Checklist-149ec050b06e80a9b8f7caa96425bc61?pvs=4#15cec050b06e80aca58ec402af95abd1 - you're more than welcome to start drafting the sub pages if you have some spare time :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants