diff --git a/docs.json b/docs.json index 395104b..abcb3d0 100644 --- a/docs.json +++ b/docs.json @@ -114,7 +114,8 @@ ] }, "platform/allowlisting-traffic", - "platform/troubleshooting" + "platform/network-diagnostic-tools", + "platform/managing-false-positives" ] }, { diff --git a/platform/troubleshooting.mdx b/platform/managing-false-positives.mdx similarity index 88% rename from platform/troubleshooting.mdx rename to platform/managing-false-positives.mdx index 570dcb8..02cd041 100644 --- a/platform/troubleshooting.mdx +++ b/platform/managing-false-positives.mdx @@ -1,7 +1,7 @@ --- -title: 'Troubleshooting' -description: 'Troubleshooting Checkly' -sidebarTitle: 'Troubleshooting' +title: 'Managing False Positives' +description: 'Managing False Positives in Checkly' +sidebarTitle: 'Managing False Positives' --- Reliable monitoring depends on delivering accurate alerts, ensuring that you're notified—and if it comes to it, woken up in the middle of the night—only when there’s a real issue. However, false positives can happen for various reasons. In this guide, we focus on one of the most common causes: unpredictable network behavior. @@ -22,7 +22,7 @@ When setting up your monitoring strategy, it's important to consider a few commo - **Infrastructure Issues:** Temporary issues like routing errors, server load spikes, or scheduled maintenance can also impact performance. - **Security-Related Blockages:** Firewalls, DDoS protection, or other security measures might prevent Checkly’s monitoring traffic from reaching your servers if flagged as suspicious. This can disrupt checks and result in false positives. -While these factors are generally well-managed, they can’t be completely avoided. However, you can take steps to make your monitoring setup more resilient. +While these factors are generally well-managed, they can't be completely avoided. However, you can take steps to make your monitoring setup more resilient. ## Best Practices to Minimize False Positives @@ -60,6 +60,6 @@ To prevent this, we recommend reviewing your security settings to ensure that Ch You can find Checkly’s current IP ranges here: [Allowlisting & filtering traffic](https://www.checklyhq.com/docs/monitoring/allowlisting/#ip-range-allowlisting). -## Need Help? +## If Issues Persist -If you’re not sure what’s going on or if an issue keeps popping up without a clear reason, don’t hesitate to reach out. Our support team is here to help you troubleshoot any unusual check performance. You can contact us at support@checklyhq.com. +Use [Checkly's Network Diagnostic Tools](./network-diagnostic-tools) to inspect failed checks for issues like DNS errors, dropped packets, or failed handshakes. If that doesn't reveal the root cause, don't hesitate to reach out to [support@checklyhq.com](mailto:support@checklyhq.com), and our team will help investigate further. \ No newline at end of file diff --git a/platform/network-diagnostic-tools.mdx b/platform/network-diagnostic-tools.mdx new file mode 100644 index 0000000..fa163ad --- /dev/null +++ b/platform/network-diagnostic-tools.mdx @@ -0,0 +1,64 @@ +--- +title: 'Network Diagnostic Tools' +description: 'Network Diagnostic Tools in Checkly' +sidebarTitle: 'Network Diagnostic Tools' +--- + +When troubleshooting network issues like DNS resolution failures, dropped packets, or broken TCP handshakes you often require low-level visibility into what's happening on the network. + +That's where network diagnostic tools come in. They help you understand how data moves through a network and where things might be breaking down. + +Checkly provides: + +- **TCP Dumps:** capture network traffic to inspect packet-level behavior +- **MTR (My Trace Route):** trace the path your request takes across the internet + + +Whether you're debugging a slow response or tracing a connection failure, these tools help you get to the root of the problem. + +## TCP Dumps + +TCP dumps give you a detailed look at what's happening at the packet level when a request fails. They capture the packets exchanged between Checkly and your target, letting you analyze things like: + +- Did the TCP handshake complete? +- Was the TLS handshake successful? +- Were packets dropped, delayed, or malformed? +- Did DNS resolution succeed? + +This level of visibility is especially helpful for diagnosing flaky networking behavior. + +### How to access + + +TCP dumps are currently only available for API checks. + + +On failed checks, you'll find a Download PCAP button in the *Network Diagnostics* section of the check results page. This gives you a `.pcap` file with the raw packet data from that request. + +You can open this file using tools like Wireshark to inspect each packet in detail. + +## MTR (My Trace Route) + +MTR shows the path your request takes across the network and how each hop behaves. A report typically includes: + +- The sequence of network hops between Checkly and your target +- Packet loss percentage per hop +- Latency statistics (last, average, best, worst, standard deviation) + +This makes it especially useful for diagnosing: + +- Where along the route packets are being dropped +- Which hops introduce unusual latency or instability + +### How to access + + +MTR is currently only available for API checks. + + +On failed checks, an MTR report is displayed directly in the Network Diagnostics section of the check results page. The table shows each hop, its IP or hostname, along with metrics such as packet loss, latency, and jitter. + + + diff --git a/sitemap-crawl.md b/sitemap-crawl.md index 65eb9fe..de97a82 100644 --- a/sitemap-crawl.md +++ b/sitemap-crawl.md @@ -26,7 +26,8 @@ This file contains all valid URLs extracted from docs.json organized by director - /platform/secrets - /platform/variables - /platform/allowlisting-traffic -- /platform/troubleshooting +- /platform/network-diagnostic-tools +- /platform/managing-false-positives ### Platform - Private Locations - /platform/private-locations/overview