Pulse/docs
rcourtman 7a185c4ab3 Improve guest agent timeout handling for high-load environments (refs #592)
This change addresses intermittent "Guest details unavailable" and "Disk stats
unavailable" errors affecting users with large VM deployments (50+ VMs) or
high-load Proxmox environments.

Changes:
- Increased default guest agent timeouts (3-5s → 10-15s) to better handle
  environments under load
- Added automatic retry logic (1 retry by default) for transient timeout failures
- Made all timeouts and retry count configurable via environment variables:
  * GUEST_AGENT_FSINFO_TIMEOUT (default: 15s)
  * GUEST_AGENT_NETWORK_TIMEOUT (default: 10s)
  * GUEST_AGENT_OSINFO_TIMEOUT (default: 10s)
  * GUEST_AGENT_VERSION_TIMEOUT (default: 10s)
  * GUEST_AGENT_RETRIES (default: 1)
- Added comprehensive documentation in VM_DISK_MONITORING.md with configuration
  examples for different deployment scenarios

These improvements allow Pulse to gracefully handle intermittent API timeouts
without immediately displaying errors, while remaining configurable for
different network conditions and environment sizes.

Fixes: https://github.com/rcourtman/Pulse/discussions/592
2025-11-05 09:40:58 +00:00
..
api Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
development Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
images Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
monitoring Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
security docs: comprehensive v4.24.0 documentation audit and updates 2025-10-20 17:20:13 +00:00
API.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
CONFIGURATION.md Fix CSRF token validation and improve token management 2025-11-05 09:23:44 +00:00
CONTRIBUTING-SCRIPTS.md feat: add shared script library system and refactor docker-agent installer 2025-10-20 15:13:38 +00:00
DOCKER.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
DOCKER_HUB_README.md docs: comprehensive v4.24.0 documentation audit and updates 2025-10-20 17:20:13 +00:00
DOCKER_MONITORING.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
FAQ.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
HOST_AGENT.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
INSTALL.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
installer-v2-rollout.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
KUBERNETES.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
MIGRATION.md docs: update documentation for v4.24.0 features 2025-10-20 16:08:10 +00:00
OIDC.md refactor: remove legacy DISABLE_AUTH flag and enhance authentication UX 2025-10-27 19:46:51 +00:00
PORT_CONFIGURATION.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
PROXY_AUTH.md docs: comprehensive v4.24.0 documentation audit and updates 2025-10-20 17:20:13 +00:00
PULSE_SENSOR_PROXY_HARDENING.md Update Pulse install flow and related components 2025-10-21 19:58:53 +00:00
README.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
RELEASE_NOTES.md feat: finalize swarm service monitoring (#598) 2025-10-26 09:35:49 +00:00
REVERSE_PROXY.md refactor: remove legacy DISABLE_AUTH flag and enhance authentication UX 2025-10-27 19:46:51 +00:00
SCREENSHOTS.md Fix settings security tab navigation 2025-10-11 23:29:47 +00:00
script-library-guide.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
SECURITY.md feat: implement priority queue-based task execution (Phase 2 Task 6) 2025-10-20 15:13:37 +00:00
TEMPERATURE_MONITORING.md Fix CSRF token validation and improve token management 2025-11-05 09:23:44 +00:00
TEMPERATURE_MONITORING_SECURITY.md Enhance container detection for temperature SSH safeguards (refs #601) 2025-11-04 22:30:35 +00:00
TROUBLESHOOTING.md Refactor: Code cleanup and localStorage consolidation 2025-11-04 21:50:46 +00:00
VM_DISK_MONITORING.md Improve guest agent timeout handling for high-load environments (refs #592) 2025-11-05 09:40:58 +00:00
WEBHOOKS.md docs: simplify Mermaid diagrams for better readability 2025-10-21 10:50:40 +00:00
zfs-monitoring.md docs: comprehensive v4.24.0 documentation audit and updates 2025-10-20 17:20:13 +00:00

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

Operations & Monitoring

Security

Reference

Development & Contribution

Have an idea for a new guide? Update this index when you add documentation so discoverability stays high.