Repository navigation
docs: retry strategies uptime monitors can use per plan - #814
Conversation
Add "Retries on uptime monitors" to the retries page: None and Single on Hobby, Starter and Team, all strategies on Enterprise, the 402 message and what "unlimited" means, monitors that already use a strategy the plan lacks, group overrides and project-level defaults. Point the uptime monitor configuration pages, the groups page and the retry strategy construct to it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Add a Trial row to the uptime monitor retry table, what the Terraform provider prints for a strategy the plan doesn't include, and that monitors keeping such a strategy still retry with it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
hlenke
left a comment
There was a problem hiding this comment.
Ready to merge · The per-plan retry limits, the error message and the UI labels all match the entitlement and webapp source. What's left is optional wording and consistency.
CI passes, it's mergeable, and main hasn't changed any of the 10 files since the merge base. The new ### Retries on uptime monitors section sits at the end of "Check retry strategies", after "Network retries". That placement works.
Overlap: #812 also edits platform/groups.mdx, but in a different hunk (it adds a Warning under "Retries & Alerting"; this PR adds a paragraph to "Mixing Checks and Monitors in a Group"). They don't conflict and can land in either order.
Optional consistency items (not on diff lines):
- Trials: the new table says trials are limited to None and Single (correct: the trial plan gets the Team feature set). Every other new mention says only "the Hobby, Starter and Team plans": the six
configuration.mdxbullets, the URL monitor Note,retries.mdx:112, theconstructs/retry-strategy.mdxNote andplatform/groups.mdx. A trial user reading one of those could assume the limit doesn't apply to them. Consider "the Hobby, Starter and Team plans and trials" in those places. - Missed siblings:
detect/uptime-monitoring/tcp-monitors/quickstart.mdx:71anddetect/uptime-monitoring/url-monitors/quickstart.mdx:67still have the old "Which retry strategies you can use depends on your plan." bullet that this PR updates on the configuration pages. Give them the same sentence and link. - Construct Note length: the
<Note>onconstructs/retry-strategy.mdx(lines 77–96) holds a paragraph, a list and a code block. The editing rules keep callouts short. A#### Retry strategies for monitorssubsection under "Default retry strategy" would carry the same content without the callout box.
Inline: 0 blockers, 0 important, 2 wording (optional).
What I checked
- Read the whole diff from merge base
e0e0277f, all 10 files. Readcommunicate/alerts/retries.mdxandconstructs/retry-strategy.mdxin full at the PR head, including their heading outlines. gh pr checks 814: all pass.gh pr view: MERGEABLE / CLEAN.git log e0e0277f..origin/main: nothing new onmain.- Siblings: all six uptime-monitor
configuration.mdxbullets (DNS, gRPC, ICMP, SSL, TCP, traceroute) get the same sentence, and the URL monitor Note is reworded to match.git grepacross*.mdxfound the two quickstart bullets listed above still on the old wording. No construct page for a monitor states plan limits for retries. - Plan matrix: monorepo
origin/main@84921d2637,apps/backend/api/src/common/services/entitlements/. The Hobby override grants uptime no-retry and single-retry only. Starter and Team products (billing-ng/products/starter-plan.ts,team-plan.ts) list the same two. The trial override takes the Team product's features. The multiple-retries entitlement is granted only by the Contract (Enterprise) override and is listed as Enterprise-only inlib/product-catalog.ts. API-check retry entitlements for Fixed, Linear and Exponential are granted on Hobby, Starter and Team. This matches the table and line 93. - Error message: the enforcement rule for uptime retry strategies (
enforcement-engine/rules/110-uptime-retry-strategy.ts) skips heartbeat monitors. It treats any strategy other than none and single as the multiple-retries entitlement, whatevermaxRetriesis, which matches line 95 and line 106. It builds the message from the note inlib/plan-limits/notes.tsplus "Your plan supports no retries (retryStrategy: null) or a single retry (SINGLE_RETRY)." The quoted block on line 103 is exact. - UI strings:
apps/webapp/src/components/retries/ResourceRetrySettings.i18n.tshas "This retry strategy is not available on your current plan. Adjust setting or upgrade.", the group validation message quoted on line 114, and the option labels None, Single, Fixed, Linear and Exponential. "Group override for retries" isOverrideByGroupCheckboxwith section title "Retries". - Construct snippet:
checkly-cliorigin/main@a655b42f,packages/cli/src/constructs/retry-strategy.ts.singleRetry()acceptsbaseBackoffSeconds, andnoRetries()exists.UrlMonitortakesrequest.url. pr_impact.py: only info notes that/communicate/alerts/retriesand/constructs/retry-strategyare hub pages. The PR changes no slugs or anchors.- Anchors resolve:
#retries-on-uptime-monitors,/constructs/retry-strategy#default-retry-strategyand/platform/groups#mixing-checks-and-monitors-in-a-group. - Could not verify from source: which web app monitor forms grey out the options (the PR names five types and leaves out SSL and traceroute); that an update which only renames or deactivates a monitor is rejected; that monitors keep retrying with an existing multi-retry strategy after a downgrade; and the Terraform output. The PR author reports testing each of these end to end. I found nothing in source that contradicts them.
- Local app unavailable (BUSY), so I verified against source.
What changed and why
People ask why a retry strategy is rejected for URL, TCP, DNS or ICMP monitors, which strategies their plan allows, and why the error says "unlimited" when they only set one retry. The docs only said that some strategies "aren't available on every plan".
communicate/alerts/retries.mdx: new section "Retries on uptime monitors":npx checkly deploy --previewreports it;checks.retryStrategyinteract with uptime monitors, and how to fix it.constructs/retry-strategy.mdx: a note under "Default retry strategy" with the same limits for constructs (project default,CheckGroupV2precedence), plus aUrlMonitorexample withsingleRetry().platform/groups.mdx: in "Mixing checks and monitors in a group", one paragraph with retries as the example, linking to the new section.Existing text isn't restyled. The new heading is sentence case (#774 restyles headings on these pages and doesn't touch these lines).
How each claim was verified
Tested on a local stack from monorepo
main(e086a77755): real public API, web app and Checkly CLI 10.0.0 (checkly deployagainst the local API). The plan fixture accounts came from the black-box seed: Hobby, Starter, Team, and Enterprise (CONTRACTplan type, shown as "Enterprise" in the app).Plan setup:
handle-entitlement-update.ts). Locally I wrote each product'sFEATURESlist (billing-ng/products/starter-plan.ts,team-plan.ts) to the fixture accounts the same way.plan-overrides.ts).maxRetries: 1, linear and exponential. None/Single → 201/200; the rest → 402 on every planretryStrategyisnull(DB)FIXEDwithmaxRetries: 1→ 402402 Payment RequiredFIXEDset in SQL on a Team account: the scheduler daemon still scheduled its runs ("SchedulerDaemon: scheduling check")retryStrategyin the body) → 402; PUT with onlyactivated: false→ 402; PUT withSINGLE_RETRY→ 200npx checkly deployfails with the message;--previewreports itdeploy --previewanddeployboth print[logical-id] <message>; a monitor withsingleRetry()deploysFIXED→ 402 "CheckGroup update failed due to: …" with the monitor invalidationErrors. Update toSINGLE_RETRY,nullorFALLBACK→ 200. A group with only an API check →FIXED200. Web app: group "Retries & Alerting" tab shows the quoted message and it clears on SingleFIXED→ 402 (also with the monitor's own SINGLE/none); move a URL monitor into aFIXEDgroup → 402; API check in that group → 201checks.retryStrategyapplies to monitors without their ownretryStrategy→ deploy fails; same withsingleRetry()on the monitor → deploysretryStrategytakes precedence over the monitor's;noRetries()/singleRetry()on the group workCheckGroupV2withlinearStrategy+ monitor withsingleRetry()→ deploy fails; group withsingleRetry()ornoRetries()→ deploystrial-02, its features): URL, TCP, DNS, ICMP with none/single → 201, fixed, fixed withmaxRetries: 1, linear, exponential → 402 with the same message; API check: all 201terraform applyfails withunexpected response status 402:and the API body;terraform plandoesn't report itcheckly_url_monitorwithFIXED→ plan OK, applyError: API error 1: unexpected response status 402: "{…\"message\":\"The unlimited retry strategy isn’t supported on your plan. …\"}"; changing an existing monitor fromSINGLE_RETRYtoFIXED→Error: API error 3: Couldn't update check, Error: unexpected response status 402: …FIXED(2 retries, 10 s) on the Enterprise fixture, then the account moved to Hobby (planhobby-01; a newFIXEDmonitor now → 402). Target returning 500, real runs through scheduler → go-runner → results daemon: before and after the move, each failing run made 3 attempts (2ATTEMPT+ 1FINALresults, about 11 s apart)npm run check:snippetspassesDocs checks (
frontmatter,anchors,links,redirects,sitemap,mint broken-links) pass. I rendered the changed sections withmint dev.Not tested or left out
🤖 Generated with Claude Code