docs: add Traceroute monitor documentation#428
Open
danielpaulus wants to merge 4 commits into
Open
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.
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
1 participant
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
detect/uptime-monitoring/traceroute-monitors/overview.mdx— what Traceroute monitors do, how they work (DNS resolution → probe execution → hop collection → assertion evaluation), protocol reference table (TCP/UDP/ICMP/SCTP with default ports), results breakdown, and troubleshooting accordionsdetect/uptime-monitoring/traceroute-monitors/configuration.mdx— all config fields (hostname, protocol, port, IP family, maxHops, maxUnknownHops, ptrLookup, timeout), assertions (Latency/Hop Count/Packet Loss), response-time limits, JSON response schema, frequency, scheduling/locations, and additional settingsconstructs/traceroute-monitor.mdx— CLI construct reference with basic and advanced examples, full parameter tables forTracerouteMonitorandTracerouteRequest,TracerouteAssertionBuilderexamples, and general monitor optionsdocs.jsonto add nav entries for the Traceroute Monitors group (under Uptime Monitoring, after ICMP Monitors) andconstructs/traceroute-monitor(afterconstructs/icmp-monitor)Config sourced from
apps/webapp/src/pages/checks/traceroute/TracerouteRequestSettings.vueandTracerouteMonitorBuilder.vueapps/webapp/src/data/models/checks/traceroute-monitor/TracerouteMonitor.tsandtypes.tspackages/cli/src/constructs/traceroute-monitor.ts,traceroute-request.ts,traceroute-assertion.tsapps/go-runner/check/traceroute/executor.go(defaults, response schema, assertion evaluation)apps/webapp/src/components/checks/components/assertions/types.tsTest plan
constructs/traceroute-monitorlink in the Tip on overview/configuration pages resolves/detect/uptime-monitoring/traceroute-monitors/overview#probe-protocolsanchor resolve on the configuration pageImages TODO
No screenshots are included in this first version. The following images should be added before GA:
images/traceroute-monitor-overview-light.png/...-dark.png— dashboard overviewimages/traceroute-request-configuration.png— request settings panelimages/traceroute-monitor-results-page.png— results detail page