gitea-mirror/Pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-02-18 00:17:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for BYOK Patrol and Pro auto-fix

Browse Source
This commit is contained in:
rcourtman
2026-02-01 14:47:02 +00:00
parent 78e9086a19
commit 724dee0b36
5 changed files with 25 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -32,9 +32,9 @@ Designed for homelabs, sysadmins, and MSPs who need a "single pane of glass" wit
- **Backup Explorer**: Visualize backup jobs and storage usage
### AI-Powered
- **Chat Assistant**: Ask questions about your infrastructure in natural language
- **Patrol**: Background health checks that generate findings on a schedule
- **Alert Analysis**: Optional AI analysis when alerts fire
- **Chat Assistant (BYOK)**: Ask questions about your infrastructure in natural language
- **Patrol (BYOK)**: Background health checks that generate findings on a schedule
- **Alert Analysis (Pro)**: Optional AI analysis when alerts fire
- **Cost Tracking**: Track usage and costs per provider/model
### Multi-Platform
@@ -91,15 +91,14 @@ Community-maintained integrations and addons:
## 🚀 Pulse Pro
**[Pulse Pro](https://pulserelay.pro)** unlocks **LLM-backed AI Patrol** — automated background monitoring that catches issues before they become outages.
**[Pulse Pro](https://pulserelay.pro)** unlocks **Auto-Fix and advanced AI analysis** — **Pulse Patrol is available to everyone with BYOK**.
| Feature | Free | Pro |
|---------|------|-----|
| Real-time dashboard | ✅ | ✅ |
| Threshold alerts | ✅ | ✅ |
| AI Chat (BYOK) | ✅ | ✅ |
| Heuristic Patrol (local rules) | ✅ | ✅ |
| **LLM-backed AI Patrol** | — | ✅ |
| **Pulse Patrol (BYOK)** | ✅ | ✅ |
| Alert-triggered AI analysis | — | ✅ |
| Kubernetes AI analysis | — | ✅ |
| Auto-fix + autonomous mode | — | ✅ |
@@ -108,16 +107,18 @@ Community-maintained integrations and addons:
| **Audit Webhooks (SIEM integration)** | — | ✅ |
| Priority support | — | ✅ |
AI Patrol runs on your schedule (every 10 minutes to every 7 days, default 6 hours) and finds:
Pulse Patrol runs on your schedule (every 10 minutes to every 7 days, default 6 hours) and finds:
- ZFS pools approaching capacity
- Backup jobs that silently failed
- VMs stuck in restart loops
- Clock drift across cluster nodes
- Container health check failures
Pulse Patrol uses your configured provider (BYOK) and runs entirely on your server.
Technical highlights:
- Cross-system context (nodes, VMs, backups, containers, and metrics history)
- LLM analysis for high-impact findings + alert-triggered deep dives
- LLM analysis with your provider + alert-triggered deep dives (Pro)
- Optional auto-fix with command safety policies and audit trail
- Centralized agent profiles for consistent fleet settings

14
docs/AI.md
View File

@@ -1,6 +1,6 @@
# Pulse AI
Pulse Pro unlocks **AI Patrol** for continuous, automated health checks. Learn more at <https://pulserelay.pro> or see the technical overview in [PULSE_PRO.md](PULSE_PRO.md).
Pulse Patrol is available to everyone with BYOK (your own AI provider). Pulse Pro unlocks auto-fix and advanced analysis. Learn more at <https://pulserelay.pro> or see the technical overview in [PULSE_PRO.md](PULSE_PRO.md).
## What Patrol Actually Does (Technical)
@@ -20,7 +20,7 @@ Patrol is a scheduled analysis pipeline that builds a rich, system-wide snapshot
**Outputs:**
- Findings with severity, category, and remediation hints.
- Summary stats for coverage and risk level.
- Optional AI analysis on the highest impact issues (Pro).
- Optional auto-fix and remediation workflows (Pro).
## Why Patrol Is Different From Traditional Alerts
@@ -41,11 +41,11 @@ Alerts are threshold-based and narrow. Patrol is context-based and cross-system.
- **Schedule**: from 10 minutes to 7 days (default 6 hours).
- **Scope**: only configured resources and connected agents.
- **Safety**: command execution remains disabled by default.
- **Cost control**: Pro uses model selection and rate limits; free tier uses heuristic-only Patrol.
- **Cost control**: BYOK only — use provider limits and budgets to control spend.
## Privacy
Patrol runs on your server and only sends the minimal context needed for analysis to the configured provider (when Pro is enabled). No telemetry is sent to Pulse by default.
Patrol runs on your server and only sends the minimal context needed for analysis to the configured provider (when AI is enabled). No telemetry is sent to Pulse by default.
Pulse AI adds an optional assistant for troubleshooting and proactive monitoring. It is **off by default** and can be enabled per instance.
@@ -211,11 +211,11 @@ scripts/eval/run_model_matrix.sh
- Test provider connectivity: `POST /api/ai/test` and `POST /api/ai/test/{provider}`
- List available models: `GET /api/ai/models`
## Patrol Service (Pro Feature)
## Patrol Service (BYOK)
Patrol runs automated health checks on a configurable schedule (default: every 6 hours). It passes comprehensive infrastructure context to the LLM (see "Context Patrol Receives" above) and generates findings when issues are detected.
Pulse Pro users get full LLM-powered analysis. Free users still benefit from **Heuristic Patrol**, which uses local rule-based logic to detect common issues (offline nodes, disk exhaustion, etc.) without requiring an external AI provider. Free users also get full access to the AI Chat assistant (BYOK).
Patrol runs with your configured provider (BYOK). Auto-fix and assisted/full autonomy require Pulse Pro.
### Finding Severity
@@ -239,7 +239,7 @@ Dismissed and resolved findings persist across Pulse restarts.
When chatting with AI about a patrol finding, the AI can:
- Run diagnostic commands on connected agents
- Propose fixes with explanations
- Automatically resolve findings after successful remediation
- Automatically resolve findings after successful remediation (Pro auto-fix)
## Safety Controls

2
docs/FAQ.md
View File

@@ -39,7 +39,7 @@ If a setting is disabled with an amber warning, it's being overridden by an envi
## 🔍 Monitoring & Metrics
### What is Pulse Pro, and what does it actually do?
Pulse Pro unlocks **AI Patrol** — scheduled, cross-system analysis that correlates real-time state, recent metrics history, and diagnostics to surface actionable findings.
Pulse Pro unlocks **Auto-Fix and advanced AI analysis**. Pulse Patrol is available to everyone with BYOK and provides scheduled, cross-system analysis that correlates real-time state, recent metrics history, and diagnostics to surface actionable findings.
Example output includes trend-based capacity warnings, backup regressions, Kubernetes AI cluster analysis, and correlated container failures that simple threshold alerts miss.
See [AI Patrol](AI.md), [Pulse Pro technical overview](PULSE_PRO.md), and <https://pulserelay.pro>.

14
docs/PULSE_PRO.md
View File

@@ -1,6 +1,6 @@
# 🚀 Pulse Pro (Technical Overview)
Pulse Pro unlocks advanced AI automation features on top of the free Pulse platform. It keeps the same self-hosted model while adding continuous, context-aware analysis and remediation workflows.
Pulse Pro unlocks advanced AI automation features on top of the free Pulse platform. Pulse Patrol is available to all users with BYOK, while Pro adds auto-fix, autonomy, and deeper analysis.
## What You Get
@@ -25,7 +25,7 @@ Pulse Pro unlocks advanced AI automation features on top of the free Pulse platf
- Customizable time ranges and metric aggregation.
- Access via **Settings → System → Reporting**.
### AI Patrol (LLM-Backed)
### Pulse Patrol (BYOK)
Scheduled background analysis that correlates live state + metrics history to produce actionable findings.
**Inputs:**
@@ -39,7 +39,6 @@ Scheduled background analysis that correlates live state + metrics history to pr
- Cross-system correlation (e.g., backups failing because a datastore is full).
### Pro-Only Automations
- **LLM-backed patrol analysis**: full AI analysis instead of heuristic-only findings.
- **Alert-triggered analysis**: on-demand deep analysis when alerts fire.
- **Autonomous mode**: optional diagnostic/fix commands through connected agents.
- **Auto-fix**: guarded remediations when enabled.
@@ -49,7 +48,7 @@ Scheduled background analysis that correlates live state + metrics history to pr
- **Agent Profiles**: centralized configuration profiles for fleets of agents.
### What Free Users Still Get
- **Heuristic Patrol**: local rule-based checks that surface common issues without any external AI provider.
- **Pulse Patrol (BYOK)**: background findings with your own provider.
- **AI Chat (BYOK)**: interactive troubleshooting with your own API keys.
- **Update alerts**: container/package update signals remain available in the free tier.
@@ -63,7 +62,6 @@ Scheduled background analysis that correlates live state + metrics history to pr
Pulse Pro licenses enable specific server-side features. These are enforced at the API layer and in the UI:
- `ai_patrol`: LLM-backed patrol findings and live patrol stream.
- `ai_alerts`: alert-triggered analysis runs.
- `ai_autofix`: autonomous mode and auto-fix workflows.
- `kubernetes_ai`: AI analysis for Kubernetes clusters (not basic monitoring).
@@ -105,7 +103,7 @@ You can inspect license feature gates via:
- `GET /api/license/features` (authenticated)
This returns a feature map like `ai_patrol`, `ai_alerts`, `ai_autofix`, and `kubernetes_ai` so you can automate Pro-only workflows safely.
This returns a feature map like `ai_alerts`, `ai_autofix`, and `kubernetes_ai` so you can automate Pro-only workflows safely.
## Under The Hood (Technical)
@@ -141,10 +139,10 @@ This returns a feature map like `ai_patrol`, `ai_alerts`, `ai_autofix`, and `kub
}
```
Heuristic (free-tier) findings omit `source: "ai-analysis"` and include the same schema for consistent automations.
Findings include `source: "ai-analysis"` when AI is enabled (BYOK).
## Privacy and Data Handling
Patrol runs on your Pulse server. When Pro is enabled, only the minimal context needed for analysis is sent to the configured AI provider. No telemetry is sent to Pulse by default.
Patrol runs on your Pulse server. When AI is enabled, only the minimal context needed for analysis is sent to the configured AI provider. No telemetry is sent to Pulse by default.
For a deeper AI walkthrough, see [AI.md](AI.md).

4
docs/README.md
View File

@@ -41,12 +41,12 @@ Welcome to the Pulse documentation portal. Here you'll find everything you need
## 🚀 Pulse Pro
Pulse Pro unlocks **LLM-backed AI Patrol** — automated background monitoring that spots issues before they become incidents.
Pulse Pro unlocks **Auto-Fix and advanced AI analysis** — **Pulse Patrol is available to all with BYOK**.
- **[Learn more at pulserelay.pro](https://pulserelay.pro)**
- **[AI Patrol deep dive](AI.md)**
- **[Pulse Pro technical overview](PULSE_PRO.md)**
- **What you actually get**: LLM-backed patrol analysis, alert-triggered deep dives, Kubernetes AI analysis, and optional auto-fix workflows.
- **What you actually get**: Auto-fix + autonomous mode, alert-triggered deep dives, Kubernetes AI analysis, reporting, and agent profiles.
- **Technical highlights**: correlation across nodes/VMs/backups/containers, trend-based capacity predictions, and findings you can resolve/suppress.
- **Scheduling**: 10 minutes to 7 days (default 6 hours).
- **Agent Profiles (Pro)**: centralized agent configuration profiles. See [Centralized Agent Management](CENTRALIZED_MANAGEMENT.md).