docs: add Traceroute monitor documentation#428
Merged
Conversation
Add overview, configuration, and CLI construct docs for Traceroute monitors. Config sourced from the webapp builder, CLI construct, and go-runner executor. Nav entries added to docs.json. Screenshots TODO.
…private locations Remove incorrect statement that private locations are unsupported; update the Scheduling & Locations bullet to match ICMP/TCP docs.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…back) - construct port default: document as 443 for all non-ICMP protocols (not 443/33434 split); 33434 is only the webapp UI pre-fill, not the CLI/API default; recommend explicit port: 33434 for UDP/SCTP - UDP/SCTP destination detection: broaden from "Port Unreachable only" to any ICMP Destination Unreachable from the target (admin-prohibited, host-unreachable, etc.); SCTP also detected via ABORT/INIT-ACK - JSON port field: always present (no omitempty), 0 for ICMP; not omitted - JSON finalHopLatency: whole object is omitted (omitempty pointer), not present with null fields, when destination is not reached
…-283) Traceroute monitors floor at 30s; EVERY_10S/EVERY_20S are not available.
…itemap Bring the branch up to date with main (it was ~1485 commits behind, predating the sitemap tooling + frontmatter check), add the required canonical URLs to the three Traceroute monitor pages, and regenerate sitemap.xml to include them. Fixes the static-docs-checks failure. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013AYwkvoaANQTH5dGStbBj2
Contributor
Author
|
Accuracy fixes after checking the pages against
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Traceroute monitor documentation — three new pages plus navigation:
detect/uptime-monitoring/traceroute-monitors/overview.mdx— what Traceroute monitors do and how they work, probe protocol reference (TCP / UDP / ICMP / SCTP with protocol-dependent default ports and how destination reach is detected per protocol), results breakdown, and troubleshooting accordions (incl.CAP_NET_RAWfor self-hosted agents)detect/uptime-monitoring/traceroute-monitors/configuration.mdx— all request fields with defaults/ranges, assertions (Latency / Hop Count / Packet Loss), response-time limits, the JSON response schema, frequency (30s floor, SIM-283), scheduling & locationsconstructs/traceroute-monitor.mdx— CLI construct reference:TracerouteMonitor,TracerouteRequest, andTracerouteAssertionBuilderwith basic + advanced examples and full parameter tablesdocs.json— nav entries for the Traceroute Monitors group (after ICMP Monitors) andconstructs/traceroute-monitor; canonical URLs added andsitemap.xmlregeneratedAll content is verified against
mainof the monorepo (go-runner executor, webapp builder & model defaults, public-API schema) and of checkly-cli (construct sources) — including the protocol-dependent port defaults from SIM-311 (443 TCP / 33434 UDP+SCTP) and theresponseTime('avg'|'min'|'max'|'stdDev')assertion-builder signature.Test plan
Before GA