Skip to content

Commit 9b7931e

Browse files
authored
Merge pull request #41 from checkly/fix/file-renaming-and-links
add network debugging docs
2 parents 8bd80a7 + f904fbb commit 9b7931e

File tree

4 files changed

+74
-8
lines changed

4 files changed

+74
-8
lines changed

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@
114114
]
115115
},
116116
"platform/allowlisting-traffic",
117-
"platform/troubleshooting"
117+
"platform/network-diagnostic-tools",
118+
"platform/managing-false-positives"
118119
]
119120
},
120121
{

platform/troubleshooting.mdx renamed to platform/managing-false-positives.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: 'Troubleshooting'
3-
description: 'Troubleshooting Checkly'
4-
sidebarTitle: 'Troubleshooting'
2+
title: 'Managing False Positives'
3+
description: 'Managing False Positives in Checkly'
4+
sidebarTitle: 'Managing False Positives'
55
---
66

77
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
2222
- **Infrastructure Issues:** Temporary issues like routing errors, server load spikes, or scheduled maintenance can also impact performance.
2323
- **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.
2424

25-
While these factors are generally well-managed, they cant be completely avoided. However, you can take steps to make your monitoring setup more resilient.
25+
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.
2626

2727
## Best Practices to Minimize False Positives
2828

@@ -60,6 +60,6 @@ To prevent this, we recommend reviewing your security settings to ensure that Ch
6060

6161
You can find Checkly’s current IP ranges here: [Allowlisting & filtering traffic](https://www.checklyhq.com/docs/monitoring/allowlisting/#ip-range-allowlisting).
6262

63-
## Need Help?
63+
## If Issues Persist
6464

65-
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 [email protected].
65+
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 [[email protected]](mailto:[email protected]), and our team will help investigate further.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: 'Network Diagnostic Tools'
3+
description: 'Network Diagnostic Tools in Checkly'
4+
sidebarTitle: 'Network Diagnostic Tools'
5+
---
6+
7+
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.
8+
9+
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.
10+
11+
Checkly provides:
12+
13+
- **TCP Dumps:** capture network traffic to inspect packet-level behavior
14+
- **MTR (My Trace Route):** trace the path your request takes across the internet
15+
<!-- - **Ping (ICMP):** test basic reachability and measure latency to a target host -->
16+
17+
Whether you're debugging a slow response or tracing a connection failure, these tools help you get to the root of the problem.
18+
19+
## TCP Dumps
20+
21+
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:
22+
23+
- Did the TCP handshake complete?
24+
- Was the TLS handshake successful?
25+
- Were packets dropped, delayed, or malformed?
26+
- Did DNS resolution succeed?
27+
28+
This level of visibility is especially helpful for diagnosing flaky networking behavior.
29+
30+
### How to access
31+
32+
<Note>
33+
TCP dumps are currently only available for API checks.
34+
</Note>
35+
36+
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.
37+
38+
You can open this file using tools like Wireshark to inspect each packet in detail.
39+
40+
## MTR (My Trace Route)
41+
42+
MTR shows the path your request takes across the network and how each hop behaves. A report typically includes:
43+
44+
- The sequence of network hops between Checkly and your target
45+
- Packet loss percentage per hop
46+
- Latency statistics (last, average, best, worst, standard deviation)
47+
48+
This makes it especially useful for diagnosing:
49+
50+
- Where along the route packets are being dropped
51+
- Which hops introduce unusual latency or instability
52+
53+
### How to access
54+
55+
<Note>
56+
MTR is currently only available for API checks.
57+
</Note>
58+
59+
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.
60+
61+
<!-- ### Ping (ICMP)
62+
63+
[coming in Q4 2025] -->
64+

sitemap-crawl.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ This file contains all valid URLs extracted from docs.json organized by director
2626
- /platform/secrets
2727
- /platform/variables
2828
- /platform/allowlisting-traffic
29-
- /platform/troubleshooting
29+
- /platform/network-diagnostic-tools
30+
- /platform/managing-false-positives
3031

3132
### Platform - Private Locations
3233
- /platform/private-locations/overview

0 commit comments

Comments
 (0)