efa1ec1cd9
Added comprehensive documentation for the per-metric alert delay feature that was requested in issue #433. This feature allows configuring different alert delays for different metrics (e.g., longer delays for CPU spikes, shorter delays for memory pressure). Key additions: - Detailed explanation of delay precedence hierarchy - JSON configuration examples for common use cases - Table of recommended delays by metric type with reasoning - UI access instructions for the Alert Delay row Also added example tests demonstrating the feature's functionality and common configuration patterns. The feature itself was already fully implemented in both backend (metricTimeThresholds support) and frontend (per-metric delay inputs in ResourceTable). This commit surfaces the feature through documentation so users know it exists and how to use it. Related to #433 |
||
|---|---|---|
| .. | ||
| api | ||
| development | ||
| images | ||
| monitoring | ||
| security | ||
| API.md | ||
| CONFIGURATION.md | ||
| CONTRIBUTING-SCRIPTS.md | ||
| DOCKER.md | ||
| DOCKER_HUB_README.md | ||
| DOCKER_MONITORING.md | ||
| FAQ.md | ||
| HOST_AGENT.md | ||
| INSTALL.md | ||
| installer-v2-rollout.md | ||
| KUBERNETES.md | ||
| MIGRATION.md | ||
| OIDC.md | ||
| PORT_CONFIGURATION.md | ||
| PROXY_AUTH.md | ||
| PULSE_SENSOR_PROXY_HARDENING.md | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| script-library-guide.md | ||
| SECURITY.md | ||
| TEMPERATURE_MONITORING.md | ||
| TEMPERATURE_MONITORING_SECURITY.md | ||
| TROUBLESHOOTING.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| zfs-monitoring.md | ||
Pulse Documentation Index
Use this index to navigate the documentation bundled with the repository. Each section groups related guides so you can jump straight to the material you need.
Getting Started
- INSTALL.md – Installation guide covering script, Docker, and Helm paths.
- FAQ.md – Common questions and troubleshooting quick answers.
- MIGRATION.md – Export/import process for moving between hosts.
- DEV-QUICK-START.md – Hot reload workflow for local development.
Deployment Guides
- DOCKER.md – Container deployment walkthroughs and compose samples.
- KUBERNETES.md – Helm chart usage, ingress, persistence.
- REVERSE_PROXY.md – nginx, Caddy, Apache, Traefik, HAProxy recipes.
- DOCKER_MONITORING.md – Docker/Podman agent installation.
- HOST_AGENT.md – Host agent installers for Linux, macOS, Windows.
- PORT_CONFIGURATION.md – Changing default ports and listeners.
Operations & Monitoring
- CONFIGURATION.md – Detailed breakdown of config files and env vars.
- TEMPERATURE_MONITORING.md – Sensor proxy setup and hardening.
- VM_DISK_MONITORING.md – Enabling guest-agent disk telemetry.
- monitoring/ – Adaptive polling and Prometheus metric references.
- WEBHOOKS.md – Notification providers and payload templates.
- TROUBLESHOOTING.md – Deep dive into common operational issues.
Security
- SECURITY.md – Canonical security policy (root-level document).
- docs/security/ – Sensor proxy network and hardening guidance.
- PROXY_AUTH.md – Authenticating via Authentik, Authelia, etc.
- TEMPERATURE_MONITORING_SECURITY.md – Legacy SSH considerations.
Reference
- API.md – REST API overview with examples.
- api/SCHEDULER_HEALTH.md – Adaptive scheduler API schema.
- RELEASE_NOTES.md – Latest feature highlights and changes.
- SCREENSHOTS.md – UI tour with annotated screenshots.
- DOCKER_HUB_README.md – Summarised feature list for registries.
Development & Contribution
- CONTRIBUTING.md – Repository-wide contribution guide.
- CONTRIBUTING-SCRIPTS.md – Expectations for installer contributors.
- script-library-guide.md – Working with shared Bash modules.
- installer-v2-rollout.md – Process for shipping major installer updates.
- development/MOCK_MODE.md – Using mock data while developing.
- MIGRATION_SCAFFOLDING.md – Tracking temporary migration code.
Have an idea for a new guide? Update this index when you add documentation so discoverability stays high.