Repository navigation
docs(readme): feature health monitoring & alerts with screenshots - #39
Conversation
…I shots Real captures from pve (PVE 9.2.20): pman --health, --check WARN -> RESOLVED, status health line, ntfy web app and the alert e-mail (sender redacted). Demo pushes used a throwaway ntfy topic and an isolated state directory. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- screenshot gallery with health view, check, ntfy and e-mail - health/alerts first in the feature table, 'alerts in 3 steps' quick start - architecture diagram shows --health/--check, pvesh and notifications - reference section illustrated; postfix relay hint for e-mail - README is markdownlint-clean; tables are exempt from MD013 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ce787111e3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| touch /etc/pmanrc && chmod 600 /etc/pmanrc | ||
| cat >>/etc/pmanrc <<'EOF' | ||
| NTFY_URL="https://ntfy.sh/pman-alerts-CHANGE-ME" # hard-to-guess topic name | ||
| HEALTH_MAIL_TO="admin@example.com" # optional, needs sendmail |
There was a problem hiding this comment.
When a user copies this quick-start verbatim to configure ntfy, this active line also configures e-mail, so every test and subsequent alert is sent to admin@example.com. Because _notify_all reports success when ntfy succeeds even if mail fails, the setup can appear healthy while Postfix repeatedly queues or bounces mail to the placeholder address. Comment this line out or present ntfy and e-mail as separate alternatives.
Useful? React with 👍 / 👎.
| <img src="docs/screenshots/screenshot-check.png" | ||
| alt="pman --check: three memory warnings, RESOLVED minutes later" |
There was a problem hiding this comment.
The screenshot linked here shows warnings at 89%, 83%, and 87% against an 80% threshold, then claims the same unchanged percentages are “back to normal” and “back below the threshold.” This was produced by raising the threshold rather than by the guests recovering, so the prominent example presents internally contradictory health-check behavior. Regenerate it with values that actually fall below the displayed threshold, or clearly label it as a threshold-configuration change.
Useful? React with 👍 / 👎.
Formatting only, no wording changes: blank line after each section heading, wrapped at 80 columns. MD024 gets siblings_only so the repeated Added/Changed/ Fixed headings of Keep a Changelog are allowed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 participant
Summary
--check, ntfy, e-mail), health/alerts first in the feature table and a new Quick start: alerts in 3 steps (pmanrc →--test-notify→ cron).--health/--check,pveshand notifications; "no config files" corrected..markdownlint.yamlexempts tables from MD013 (table rows cannot be wrapped).How the screenshots were made
script), ANSI → HTML → Playwright,optipng -o2./etc/pmanrcand/var/lib/pmanwere not used or changed); thresholdHEALTH_MEM_WARN=80to trigger real WARN, raised again 7 minutes later for RESOLVED.Test plan
markdownlint-cli2 README.md→ 0 errors🤖 Generated with Claude Code