39 lines
1.9 KiB
Markdown
39 lines
1.9 KiB
Markdown
# PearData user guide
|
||
|
||
End-user documentation for the **Pear desktop client** and day-to-day monitoring workflows.
|
||
|
||
For install and agent ops, see [Getting started](../docs/GETTING-STARTED.md).
|
||
For engineers (protocol, REST deep-dive, architecture), see [docs/](../docs/README.md).
|
||
|
||
---
|
||
|
||
## Contents
|
||
|
||
| Guide | What you’ll learn |
|
||
|-------|-------------------|
|
||
| [Overview](./overview.md) | What PearData is, planes (agent / desktop / REST), mental model |
|
||
| [Connect](./connect.md) | Public key, invites, admin seed, restoring saved agents |
|
||
| [Overview tab](./overview-tab.md) | KPIs, spark charts, fleet strip, spotlight |
|
||
| [Charts](./charts.md) | Metrics wall, time bar, pins, board, gestures |
|
||
| [Metric Correlations](./metric-correlations.md) | Highlight → Find Correlations → filtered wall (full walkthrough) |
|
||
| [Related metrics](./related-metrics.md) | Per-chart ⇢ related (taxonomy + Pearson) — different from Correlate |
|
||
| [Alerts](./alerts.md) | Anomaly list, Show / Correlate actions |
|
||
| [Logs](./logs.md) | System log stream — journal (default), anomalies, audit; Follow / search |
|
||
| [Containers](./containers.md) | Docker metrics with human names (installer socket access) |
|
||
| [Fleet](./fleet.md) | Multi-host roster, set active, reconnect, forget |
|
||
| [QVAC (local AI)](./qvac.md) | On-device SRE copilot, onboarding, tools → agent |
|
||
| [Settings](./settings.md) | Appearance, Data Manager (retention / prune), connections |
|
||
| [Keyboard shortcuts](./keyboard.md) | Charts and shell shortcuts |
|
||
| [Weights API](./weights-api.md) | REST / RPC for Metric Correlations from scripts |
|
||
|
||
---
|
||
|
||
## Quick path
|
||
|
||
1. [Connect](./connect.md) an agent
|
||
2. Skim [Overview](./overview-tab.md)
|
||
3. Open **Charts** — [Charts guide](./charts.md)
|
||
4. Investigate with [Metric Correlations](./metric-correlations.md), [Logs](./logs.md), or [Related](./related-metrics.md)
|
||
5. Ask the local copilot on the [QVAC](./qvac.md) tab
|
||
6. Manage hosts in [Fleet](./fleet.md)
|