Skip to content

docs: add gRPC monitor documentation#429

Open
danielpaulus wants to merge 2 commits into
mainfrom
docs/grpc-monitors
Open

docs: add gRPC monitor documentation#429
danielpaulus wants to merge 2 commits into
mainfrom
docs/grpc-monitors

Conversation

@danielpaulus

Copy link
Copy Markdown

Summary

  • Adds detect/uptime-monitoring/grpc-monitors/overview.mdx — what gRPC monitors are, BEHAVIOR vs HEALTH modes, how the runner works, result structure, and troubleshooting accordions
  • Adds detect/uptime-monitoring/grpc-monitors/configuration.mdx — full configuration reference: host/port/TLS/skipSSL, BEHAVIOR mode (method, serviceDefinition, proto file, message, metadata), HEALTH mode (service), all assertion sources, response time limits, scheduling, and additional settings
  • Adds constructs/grpc-monitor.mdx — CLI construct reference with GrpcMonitor and GrpcAssertionBuilder, complete parameter tables, assertion examples, and three working code examples (HEALTH mode, BEHAVIOR with proto file, authenticated with metadata)
  • Updates detect/uptime-monitoring/overview.mdx to add a gRPC Monitors card alongside the other monitor types
  • Updates docs.json to add the gRPC Monitors nav group under uptime-monitoring (after ICMP) and constructs/grpc-monitor in the DETECT constructs section

Config sourced from

  • CLI construct: packages/cli/src/constructs/grpc-monitor.ts, grpc-request.ts, grpc-assertion.ts
  • Runner behavior: apps/go-runner/check/grpc/executor.go

Images TODO

No screenshots are included in this first version — <Frame><img> blocks are intentionally omitted until real UI screenshots are available.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 8, 2026, 1:46 PM

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

…thod name

- healthCheckStatus() target must be numeric: UNKNOWN=0, SERVING=1,
  NOT_SERVING=2, SERVICE_UNKNOWN=3. The go-runner evaluator calls
  strconv.Atoi on the target and rejects non-numeric values. All
  .equals('SERVING') calls replaced with .equals(1) and a comment.
- .isNotEmpty() does not exist on the assertion builder; corrected to
  .notEmpty() throughout.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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