Skip to content

docs(canary-checker): refresh check reference coverage#521

Merged
adityathebe merged 3 commits into
mainfrom
codex/canary-checker-docs-revamp
Jul 7, 2026
Merged

docs(canary-checker): refresh check reference coverage#521
adityathebe merged 3 commits into
mainfrom
codex/canary-checker-docs-revamp

Conversation

@adityathebe

Copy link
Copy Markdown
Member

Canary Checker is preparing a new release, and the docs had drifted from the current checker registry.

This refresh aligns reference pages with active runtime checks, adds missing Dynatrace and OpenSearch docs, documents legacy fields that now route to removed checkers, and updates fixture-backed examples and Mission Control cross-links.

The shared field components now reflect current common check fields and connection behavior, and the canary-checker submodule points at the README accuracy update.

Align the Canary Checker docs with the current checker registry before the next release.

Add missing active check references for Dynatrace and OpenSearch, document removed legacy check fields, replace inline YAML examples with fixture imports where fixtures exist, and update cross-links from Mission Control.

Update shared field components and the canary-checker submodule pointer so rendered reference tables and embedded source docs match the current API and runtime behavior.
@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jul 6, 2026 3:10pm

Request Review

@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Deploy Preview for canarychecker failed. Why did it fail? →

Name Link
🔨 Latest commit b457156
🔍 Latest deploy log https://app.netlify.com/projects/canarychecker/deploys/6a4bc50a3ee0d50008a5b777

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@adityathebe, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5b18bea6-b3a7-46f2-b065-f118ff0ecf09

📥 Commits

Reviewing files that changed from the base of the PR and between 881587d and b457156.

📒 Files selected for processing (50)
  • canary-checker/docs/comparisons/blackbox-exporter.md
  • canary-checker/docs/concepts/_connections.md
  • canary-checker/docs/concepts/expressions/health-evaluation.md
  • canary-checker/docs/concepts/expressions/transforms.mdx
  • canary-checker/docs/concepts/secret-management.md
  • canary-checker/docs/examples/sftp.mdx
  • canary-checker/docs/examples/smb.mdx
  • canary-checker/docs/health-checks.canary.mdx
  • canary-checker/docs/index.mdx
  • canary-checker/docs/reference/1-alert-manager.mdx
  • canary-checker/docs/reference/1-aws-config-rule.mdx
  • canary-checker/docs/reference/1-aws-config.mdx
  • canary-checker/docs/reference/1-azure-devops.mdx
  • canary-checker/docs/reference/1-catalog.mdx
  • canary-checker/docs/reference/1-dns.mdx
  • canary-checker/docs/reference/1-dynatrace.mdx
  • canary-checker/docs/reference/1-elasticsearch.mdx
  • canary-checker/docs/reference/1-exec.mdx
  • canary-checker/docs/reference/1-folder.mdx
  • canary-checker/docs/reference/1-http.mdx
  • canary-checker/docs/reference/1-icmp.mdx
  • canary-checker/docs/reference/1-junit.mdx
  • canary-checker/docs/reference/1-kubernetes-resource.mdx
  • canary-checker/docs/reference/1-kubernetes.mdx
  • canary-checker/docs/reference/1-ldap.mdx
  • canary-checker/docs/reference/1-mongo.mdx
  • canary-checker/docs/reference/1-opensearch.mdx
  • canary-checker/docs/reference/1-prometheus.mdx
  • canary-checker/docs/reference/1-pubsub.mdx
  • canary-checker/docs/reference/1-redis.mdx
  • canary-checker/docs/reference/1-s3-protocol.mdx
  • canary-checker/docs/reference/1-sql.mdx
  • canary-checker/docs/reference/1-tcp.mdx
  • canary-checker/docs/reference/1-webhook.mdx
  • canary-checker/docs/reference/3-gcs-database-backup.mdx
  • canary-checker/docs/reference/3-restic.mdx
  • canary-checker/docs/reference/_canary-spec.mdx
  • canary-checker/docs/reference/_connections.mdx
  • canary-checker/docs/reference/_dynatrace.mdx
  • canary-checker/docs/reference/jmeter.mdx
  • canary-checker/docs/scripting/_functions.md
  • common/src/components/Fields.jsx
  • common/src/components/HealthCheck.jsx
  • mission-control/blog/canary-checker-v1.2.md
  • mission-control/docs/guide/config-db/scrapers/azure.md
  • mission-control/docs/integrations/kubernetes/index.mdx
  • mission-control/docs/integrations/ldap.mdx
  • mission-control/docs/reference/canary-checker/index.mdx
  • modules/canary-checker
  • styles/ignore/words-with-suggestions.txt
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/canary-checker-docs-revamp
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch codex/canary-checker-docs-revamp

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@adityathebe adityathebe marked this pull request as ready for review July 6, 2026 15:08
@adityathebe adityathebe merged commit 86ee01f into main Jul 7, 2026
11 of 15 checks passed
@adityathebe adityathebe deleted the codex/canary-checker-docs-revamp branch July 7, 2026 08:12
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.

1 participant