Add runtime logging #33

Merged
JackFrostbyte merged 1 commit from feature/v0.6-issue-14-runtime-logging into main 2026-05-09 19:44:21 -04:00

Summary

Implements structured runtime logging for the RGB Aura controller.

This adds a central logging setup and wires it into the main runtime path without changing the animation visuals.

Changes

  • Added central runtime logging setup in src/rgb_aura/logging_setup.py.
  • Added CLI logging options:
    • --log-level
    • --log-file
    • --log-max-mb
    • --log-backup-count
  • Added rotating file logging.
  • Default log retention is about 25 MB total:
    • 5 MB current log
    • 4 rotated backups
  • Logged startup and shutdown activity.
  • Logged OpenRGB connection status.
  • Logged mapping validation success/failure.
  • Logged selected runtime mode and scheduler settings.
  • Logged active logical zones and animation summary at startup.
  • Moved scheduler event start/completion details to DEBUG to avoid noisy normal logs.
  • Logged runtime errors clearly.
  • Ignored local runtime/dev output:
    • logs/
    • reports/dev/

Validation

  • Ran Ruff formatting and linting successfully:
ruff format src/rgb_aura
ruff check src/rgb_aura scripts tests
## Summary Implements structured runtime logging for the RGB Aura controller. This adds a central logging setup and wires it into the main runtime path without changing the animation visuals. ## Changes - Added central runtime logging setup in `src/rgb_aura/logging_setup.py`. - Added CLI logging options: - `--log-level` - `--log-file` - `--log-max-mb` - `--log-backup-count` - Added rotating file logging. - Default log retention is about 25 MB total: - 5 MB current log - 4 rotated backups - Logged startup and shutdown activity. - Logged OpenRGB connection status. - Logged mapping validation success/failure. - Logged selected runtime mode and scheduler settings. - Logged active logical zones and animation summary at startup. - Moved scheduler event start/completion details to `DEBUG` to avoid noisy normal logs. - Logged runtime errors clearly. - Ignored local runtime/dev output: - `logs/` - `reports/dev/` ## Validation - Ran Ruff formatting and linting successfully: ```text ruff format src/rgb_aura ruff check src/rgb_aura scripts tests
JackFrostbyte deleted branch feature/v0.6-issue-14-runtime-logging 2026-05-09 19:44:21 -04:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
JackFrostbyte/rgb-aura!33
No description provided.