Skip to content

docs: update traceroute monitor default thresholds to 500 and 1000 ms [RED-974] - #789

Merged
carinaluise merged 5 commits into
mainfrom
carina/red-974-traceroute-defaults
Nov 17, 2026
Merged

carinaluise merged 5 commits into
mainfrom
carina/red-974-traceroute-defaults

Conversation

@carinaluise

@carinaluise carinaluise commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Affected Components

  • Docs

Notes for the Reviewer

Traceroute monitor docs now list 500 ms degraded and 1000 ms failed as the defaults, for both the construct and the UI. They also note that a single limit conflicting with the other's default is rejected.

Merge after checkly/monorepo#6018 and checkly/monorepo#6019 are deployed and checkly/checkly-cli#1595 is released.

Part of RED-974.

Testing

  • npm run check:snippets passes
  • Mintlify link check (link-rot) and preview deploy pass

@mintlify

mintlify Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 16, 2026, 5:24 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to merge · Every changed claim matches the API, the web app, the runner, and the CLI change; hold the merge until checkly/checkly-cli#1595 is released, as the description says.

Merge readiness

  • Release gate. checkly/monorepo#6018 and checkly/monorepo#6019 are merged (2026-11-13). I could not verify that they are deployed. checkly/checkly-cli#1595 is still open and waiting for review, and the latest CLI release is 10.1.0, so the gate in the description is not met yet.
  • CI is green (6 checks). No conflicts. main changed both files since the merge base (#793, #814), outside the lines this PR touches.
  • Overlap. No other open PR touches these two files.
  • API reference. api-reference/openapi.json on main still lists 10000 and 20000 as the defaults of degradedResponseTime and maxResponseTime in ChecksV1TracerouteMonitorCreate, so the "Create a Traceroute monitor" API page will disagree with these two pages until the spec is synced. I did not check whether the open spec update (#778) already carries the new values. Not a reason to hold this PR.
  • This PR also resolves a known conflict on main: the configuration page said 3,000/5,000 ms and the construct page said 10000/20000. Both now say 500/1000.

Inline comments: 0 blockers, 0 important, 2 wording (both optional, both with a suggestion).

What I checked

Read the whole diff from merge base e905ff08 to 150157f5 (2 files, 3 commits), and both pages in full at the head.

Claims, all confirmed from source:

  • Defaults 500 and 1000, maximum 30,000. monorepo origin/main@974cfe7904: packages/api-contract/src/resources/checks/v1.ts and apps/backend/api/src/common/schemas/response-time-limit-schema.ts (API and CLI deploy), apps/webapp/src/data/models/checks/constants.ts (web app). CLI: packages/cli/src/constructs/traceroute-monitor.ts at f08328ab (head of checkly/checkly-cli#1595), JSDoc @defaultValue 500 and 1000.
  • "at or above", 0 turns a limit off, no degraded state when both limits are equal. apps/go-runner/check/traceroute/result.go: a limit applies only when it is above 0, the comparison is greater-than-or-equal, and the failed limit is checked first.
  • Only one limit set: degradedResponseTime above 1,000 or maxResponseTime from 1 to 499 is rejected; maxResponseTime: 0 is accepted. packages/cli/src/constructs/internal/common-diagnostics.ts at f08328ab, and the same order rule in the API schemas above, which also run on checkly deploy. So the released CLI gets the same rejection from the API at deploy time.
  • Monitors without explicit limits move to 500/1000 on the next checkly deploy. The construct in #1595 sends both limits and fills an unset one with its default. CLI 10.1.0 (origin/main@92382bf2) leaves unset limits out and the deploy schema fills in the new defaults.
  • Monitors managed in the web app or through the API keep their limits. checkly/monorepo#6018 changes defaults and validation only; its file list has no data migration, and update requests do not apply defaults.
  • Web app: the validation messages in apps/webapp/src/pages/checks/traceroute/TracerouteMonitor.i18n.ts match "Set a limit to 0 to turn it off" and the order rule.
  • Code samples. The three changed snippets pass the new CLI validation by reading it: 200/400 together, degradedResponseTime: 300 alone, maxResponseTime: 800 alone. The comments match the at-or-above behavior.

Scripts: pr_impact.py (no findings), spec_lookup.py schema ChecksV1TracerouteMonitorCreate, gh pr checks, gh pr list --json number,files.

Not done: no end-to-end test. The local Checkly app did not start within the time limit of this run, so everything above is from source, not from a run. Could not verify: whether the monorepo changes are deployed to production.

Comment thread constructs/traceroute-monitor.mdx Resolved
carinaluise and others added 2 commits November 16, 2026 18:24
Co-authored-by: Hannes Lenke <hannes@lenke.at>
Co-authored-by: Hannes Lenke <hannes@lenke.at>

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to merge · Both wording suggestions from the last review are applied and the text still matches the merged CLI; merge once checkly/checkly-cli#1595 ships in a CLI release, as the description says.

This review covers the two commits since 150157f5 (57308fd, 6537c8f). Both apply the suggestions from my previous review word for word; nothing else changed.

Merge readiness

  • Release gate. checkly/checkly-cli#1595 was merged on 2026-11-16, but the latest CLI release is still 10.1.0 (2026-10-29), so the gate in the description is not met yet. I still could not verify that checkly/monorepo#6018 and checkly/monorepo#6019 are deployed.
  • CI is green (6 checks). Mergeable, no conflicts. main changed neither file since my last review (only #793 and #814, outside the touched lines). No other open PR touches these files.
  • API reference. api-reference/openapi.json on main still lists 10000 and 20000 as the defaults in ChecksV1TracerouteMonitorCreate, so the "Create a Traceroute monitor" API page disagrees with these pages until the spec is synced. Not a reason to hold this PR.

Inline comments: none.

What I checked
  • Read git diff 150157f5 6537c8fa (2 commits, 2 changed lines) and the full diff from merge base e905ff08 to the head. No main merges in the new commits.
  • The new Note sentence ("If you set only one limit, it is checked against the default of the other …") and the configuration-page sentence ("unless the failed limit is 0") against the merged CLI at checkly-cli origin/main@e8111988: packages/cli/src/constructs/traceroute-monitor.ts has defaults 500 and 1000 and sends both limits on deploy; packages/cli/src/constructs/internal/common-diagnostics.ts checks a single limit against the other's default and exempts a maxResponseTime of 0 from the order rule. Both sentences match.
  • gh pr checks 789, gh pr view 789 --json mergeable,mergeStateStatus, gh pr view 1595 --repo checkly/checkly-cli, gh release list --repo checkly/checkly-cli, gh pr list --json number,files, pr_impact.py (no findings), spec_lookup.py schema ChecksV1TracerouteMonitorCreate.
  • The claims unchanged since the last review (defaults, maximum, at-or-above behavior, 0 turns a limit off, web app and API monitors keep their limits) were verified from source then and are not repeated here.

Not done: no end-to-end test against local Checkly. The new commits change wording only, and the CLI with the new defaults is not released, so a local run with the published CLI would not show the new behavior. Could not verify: whether the monorepo changes are deployed to production.

@carinaluise
carinaluise merged commit 76be40b into main Nov 17, 2026
6 checks passed
@carinaluise
carinaluise deleted the carina/red-974-traceroute-defaults branch November 17, 2026 09:14

This branch was successfully deployed

1 active deployment
staging — 6537c8fa Deployed Nov 16, 2026 by mintlify[bot]
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.

2 participants