Tools: Heka Insights Agent Update: Architecture + Configuration Docs Now Reflect Runtime Behavior

Tools: Heka Insights Agent Update: Architecture + Configuration Docs Now Reflect Runtime Behavior

Build Update (April 16, 2026)

What I updated

Architecture documentation improvements

Configuration documentation improvements

Important behavior clarified

Why this matters

Next steps This week I focused on documentation quality and operational clarity for heka-insights-agent. The goal was simple: make docs match the code exactly, so contributors and operators can reason about behavior without reading every module first. docs/architecture.md now documents: This gives a real “as-implemented” architecture baseline instead of aspirational text. docs/configuration.md now includes exact behavior for the two active runtime settings: Current config loading is split across two env files: That split is now explicitly documented to reduce startup/debug confusion. For an agent project, docs are part of reliability.

Operators need to know what can fail at startup, where config is read from, and what telemetry shape to expect downstream. This update makes onboarding and future refactors safer. Repo: https://github.com/ronin1770/heka-insights-agent Templates let you quickly answer FAQs or store snippets for re-use. Are you sure you want to ? It will become hidden in your post, but will still be visible via the comment's permalink. Hide child comments as well For further actions, you may consider blocking this person and/or reporting abuse

Code Block

Copy

heka-insights-agent docs/architecture.md docs/configuration.md docs/architecture.md src/main.py CPUCollector MemoryCollector DiskCollector src/logger/config.py docs/configuration.md LOG_LOCATION CPU_POLL_INTERVAL_SECONDS LOG_LOCATION CPU_POLL_INTERVAL_SECONDS - Rewrote docs/architecture.md from scratch - Rewrote docs/configuration.md from scratch - Expanded README.md with project context, setup, and environment guidance - the actual runtime topology and control loop in src/main.py - collector boundaries and behavior (CPUCollector, MemoryCollector, DiskCollector) - logging subsystem behavior in src/logger/config.py - current payload shapes emitted by collectors - known gaps (no sender layer yet, no tests yet, no schema versioning yet) - practical extension points for next phases - LOG_LOCATION - CPU_POLL_INTERVAL_SECONDS - source/precedence rules - defaults and validation behavior - failure modes - local setup and production recommendations - root .env is used for LOG_LOCATION - src/.env is used for CPU_POLL_INTERVAL_SECONDS - add transport/sender layer (backend adapters) - add collector-focused tests - consolidate config loading into a single source - define schema/versioning strategy for emitted payloads