Skip to content

Add ops cheat sheet and smoke/uptime monitoring scripts#96

Open
alastairong1 wants to merge 1 commit intoalastair/health-detailed-endpointfrom
alastair/ops-tooling
Open

Add ops cheat sheet and smoke/uptime monitoring scripts#96
alastairong1 wants to merge 1 commit intoalastair/health-detailed-endpointfrom
alastair/ops-tooling

Conversation

@alastairong1
Copy link
Copy Markdown
Contributor

Summary

  • New docs/ops.md — journalctl + curl recipes for the deployed service, cache_warmer status interpretation, smoke-test usage
  • New scripts/smoke.sh — end-to-end correctness + latency probe; asserts on response shape (not just status), reports per-check latency, exits non-zero on FAIL
  • New scripts/uptimerobot-setup.sh — one-shot creation of the 3 baseline UptimeRobot monitors (liveness, /health/detailed status=ok, cache_warmer running=true)

Why

Ops knowledge for the preview environment was living outside the repo. This pulls it inline so:

  • New team members can debug the live service from journalctl recipes
  • Smoke tests can run post-deploy or on a cron
  • UptimeRobot setup is reproducible per-environment via one script

Forward-looking note

Test plan

  • bash -n scripts/smoke.sh (syntax check)
  • Run ./scripts/smoke.sh against preview once detailed-health lands; expect PASS on liveness + 401 checks
  • Read docs/ops.md end-to-end

Part of the deployed-state split tracked in #94.

@alastairong1 alastairong1 requested a review from findolor April 28, 2026 20:02
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 363ddb71-f62c-4a02-9793-9ac22cfb2d37

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch alastair/ops-tooling

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 and usage tips.

@findolor findolor changed the base branch from main to graphite-base/96 April 30, 2026 11:48
@findolor findolor force-pushed the alastair/ops-tooling branch from 9a6514a to 8ff4b51 Compare April 30, 2026 11:48
@findolor findolor changed the base branch from graphite-base/96 to alastair/health-detailed-endpoint April 30, 2026 11:48
Copy link
Copy Markdown
Collaborator

findolor commented Apr 30, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add the label add-to-gt-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@findolor findolor changed the base branch from alastair/health-detailed-endpoint to graphite-base/96 May 1, 2026 06:59
@findolor findolor force-pushed the alastair/ops-tooling branch from 8ff4b51 to abee3da Compare May 4, 2026 07:40
@findolor findolor force-pushed the graphite-base/96 branch from 8b055a6 to dc10129 Compare May 4, 2026 07:40
@findolor findolor changed the base branch from graphite-base/96 to alastair/health-detailed-endpoint May 4, 2026 07:40
- docs/ops.md: journalctl + curl recipes for the deployed service,
  cache_warmer status interpretation, smoke-test usage
- scripts/smoke.sh: end-to-end correctness + latency probe against
  the API, asserts on response shape (not just status), reports
  per-check latency
- scripts/uptimerobot-setup.sh: one-shot creation of the 3 baseline
  UptimeRobot monitors (liveness, /health/detailed status=ok,
  cache_warmer running=true)

Notes:
- The smoke + UptimeRobot scripts reference /health/detailed.cache_warmer
  which only lights up once the detailed-health (#95) and cache-warmer
  PRs land. They will return FAIL/keyword-miss against current main.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@findolor findolor force-pushed the alastair/ops-tooling branch from abee3da to 26859c3 Compare May 4, 2026 10:47
@findolor findolor force-pushed the alastair/health-detailed-endpoint branch from dc10129 to 6e0d829 Compare May 4, 2026 10:47
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