JackFrostbyte/rgb-aura
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add runtime logging #14

New issue
Closed
opened 2026-05-05 02:16:05 -04:00 by JackFrostbyte · 1 comment
JackFrostbyte commented 2026-05-05 02:16:05 -04:00
Owner
Copy link

Title:
Add runtime logging

Description:
Add structured runtime logging for the aurora controller.

Scope:

  • Log startup and shutdown.
  • Log OpenRGB connection status.
  • Log mapping validation success/failure.
  • Log active logical zones.
  • Log runtime errors clearly.
  • Avoid noisy per-frame logging during normal operation.

Acceptance criteria:

  • Controller writes useful logs for troubleshooting.
  • Errors are visible and understandable.
  • Normal animation does not spam logs excessively.
Title: Add runtime logging Description: Add structured runtime logging for the aurora controller. Scope: - Log startup and shutdown. - Log OpenRGB connection status. - Log mapping validation success/failure. - Log active logical zones. - Log runtime errors clearly. - Avoid noisy per-frame logging during normal operation. Acceptance criteria: - Controller writes useful logs for troubleshooting. - Errors are visible and understandable. - Normal animation does not spam logs excessively.
JackFrostbyte commented 2026-05-09 19:45:05 -04:00
Author
Owner
Copy link

Implemented runtime logging for the RGB Aura controller.

Summary:

  • Added central runtime logging setup.
  • Added rotating file logging with about 25 MB default retention.
  • Added CLI logging options:
    • --log-level
    • --log-file
    • --log-max-mb
    • --log-backup-count
  • Logged startup/shutdown.
  • Logged OpenRGB connection status.
  • Logged mapping validation success/failure.
  • Logged runtime mode, scheduler settings, and active logical zones.
  • Moved scheduler event details to DEBUG so normal INFO logs stay readable.
  • Logged runtime errors clearly.
  • Ignored local runtime/dev output folders:
    • logs/
    • reports/dev/

Validation:

  • ruff format src/rgb_aura
  • ruff check src/rgb_aura scripts tests
  • Tested normal INFO runtime logging.
  • Tested DEBUG scheduler event logging.
  • Tested custom log rotation options.
  • Tested invalid logging arguments and confirmed exit code 2.

Commit:

  • ae38f41 Add runtime logging

PR merged successfully.

Closing issue #14.

Implemented runtime logging for the RGB Aura controller. Summary: - Added central runtime logging setup. - Added rotating file logging with about 25 MB default retention. - Added CLI logging options: - `--log-level` - `--log-file` - `--log-max-mb` - `--log-backup-count` - Logged startup/shutdown. - Logged OpenRGB connection status. - Logged mapping validation success/failure. - Logged runtime mode, scheduler settings, and active logical zones. - Moved scheduler event details to `DEBUG` so normal `INFO` logs stay readable. - Logged runtime errors clearly. - Ignored local runtime/dev output folders: - `logs/` - `reports/dev/` Validation: - `ruff format src/rgb_aura` - `ruff check src/rgb_aura scripts tests` - Tested normal `INFO` runtime logging. - Tested `DEBUG` scheduler event logging. - Tested custom log rotation options. - Tested invalid logging arguments and confirmed exit code `2`. Commit: - `ae38f41 Add runtime logging` PR merged successfully. Closing issue #14.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
v1.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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#14
No description provided.