Skip to content
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.

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

Expanded on TCP check docs #1200

Merged
merged 9 commits into from
Jan 30, 2025
Merged

Expanded on TCP check docs #1200

merged 9 commits into from
Jan 30, 2025

Conversation

sujaya-sys
Copy link
Contributor

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

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!

Copy link

vercel bot commented Jan 28, 2025

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


* **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.

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.

Copy link
Contributor

@pmallol pmallol left a comment

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
Copy link
Contributor Author

sujaya-sys commented Jan 28, 2025

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 :)

@sujaya-sys sujaya-sys merged commit a6fbba8 into main Jan 30, 2025
6 checks passed
@sujaya-sys sujaya-sys deleted the tcp-docs-updates branch January 30, 2025 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants