Skip to content

[BUGFIX] Handle missing log directories more gracefully#1418

Merged
microtechno9000 merged 16 commits intoautomatic-ripping-machine:mainfrom
alwold:error-handling-improvements
Feb 5, 2026
Merged

[BUGFIX] Handle missing log directories more gracefully#1418
microtechno9000 merged 16 commits intoautomatic-ripping-machine:mainfrom
alwold:error-handling-improvements

Conversation

@alwold
Copy link
Copy Markdown
Contributor

@alwold alwold commented Jun 15, 2025 •
edited
Loading

Description

I recently set up ARM on a bare metal Ubuntu 25.04 install (I'm hoping to do a writeup soon for that as well). Since there is more manual setup involved, I forgot to create the logs/progress directory, which caused the main.py script to crash inside the log cleanup function. When that happened, the exception wasn't logged in any of the logs, as far as I could tell, and the job was left in the database (and couldn't be abandoned since the PID was no longer is running).

This makes two small changes to better handle this scenario:

  • Move the calls to the cleanup function inside the try block in main.py. That way if an exception is thrown during log cleanup, it is caught, logged, and the job is cleaned up properly.
  • If any of the log directories are missing, log something and continue on to the next directory without throwing an exception.

This is my first contribution, and I'm happy to adjust the PR if anything isn't following the correct procedures, just let me know!

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

  • Docker
  • Other (Please state here)

I tested these on bare metal since I don't have docker, but it should be possible to test on docker as well, if you can build an image where you remove the logs/progress directory.

Change to log cleanup

  • Make sure your logs/progress directory does not exist
  • Start a rip
  • Verify that a message is logged during log cleanup indicating the progress directory was skipped
  • Verify that the rip continues

Change to top level exception handling

  • Comment out the change in logger.py to continue when a logging directory is missing
  • Start a rip
  • Verify that the job throws an exception, but it is handled and logged, and the job is properly aborted

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have tested that my fix is effective or that my feature works

Note: there's no functional changes in here, so documentation updates shouldn't be needed.

Changelog:

Include the details of changes made here

  • Handle missing log directories during cleanup in logger.py
  • Expand the scope of the top level try block in main.py so it handles exceptions in log cleanup

Logs

Attach logs from successful test runs here

Sample run where the logs/progress directory hasn't been created is below. Before the fix, the job would crash after the "Checking path /home/arm/logs/progress for old log files..." entry.

[06-22-2025 15:35:21] INFO ARM: ARMInfo.get_values ARM version: 2.14.0
[06-22-2025 15:35:21] INFO ARM: ARMInfo.get_values Python version: 3.13.3 (main, Jun 16 2025, 18:15:32) [GCC 14.2.0]
[06-22-2025 15:35:21] INFO ARM: ARMInfo.get_values User is: arm
[06-22-2025 15:35:21] INFO ARM: ARMInfo.get_values Alembic head is: 6870a5546912
[06-22-2025 15:35:21] INFO ARM: ARMInfo.get_values Database version is: 6870a5546912
[06-22-2025 15:35:21] INFO ARM: main.<module> ************* Starting ARM processing at 2025-06-22 15:35:21.797455 *************
[06-22-2025 15:35:21] DEBUG ARM: utils.database_adder Trying to add Job
[06-22-2025 15:35:21] DEBUG ARM: utils.database_adder successfully written Job to the database
[06-22-2025 15:35:22] DEBUG ARM: DriveUtils.update_drive_job Updating Drive: ['Drive 1'|'/dev/sr0'] Current Job: [23] Previous Job: [22]
[06-22-2025 15:35:22] DEBUG ARM: DriveUtils.update_drive_job Database update with new Job ID to associated drive
[06-22-2025 15:35:22] DEBUG ARM: main.<module> drive_mode: auto
[06-22-2025 15:35:22] DEBUG ARM: utils.database_adder Trying to add Config
[06-22-2025 15:35:22] DEBUG ARM: utils.database_adder successfully written Config to the database
[06-22-2025 15:35:22] INFO ARM: logger.clean_up_logs Looking for log files older than 1 days old.
[06-22-2025 15:35:22] INFO ARM: logger.clean_up_logs Checking path /home/arm/logs/ for old log files...
[06-22-2025 15:35:22] INFO ARM: logger.clean_up_logs Deleting log file: DUNE.log
[06-22-2025 15:35:22] INFO ARM: logger.clean_up_logs Checking path /home/arm/logs/progress for old log files...
[06-22-2025 15:35:22] INFO ARM: logger.clean_up_logs /home/arm/logs/progress is not a directory or doesn't exist. Skipping.
[06-22-2025 15:35:22] INFO ARM: main.<module> Job: FARGO_SE__16X9
[06-22-2025 15:35:22] INFO ARM: utils.clean_old_jobs Job #23 with PID 3673252 is currently running.
[06-22-2025 15:35:22] DEBUG ARM: main.log_udev_params ******************* Logging udev attributes *******************

Sample run with the fix in logger.py commented out. This would previously crash silently and the job would appear to still be in progress.

[06-22-2025 16:52:31] INFO ARM: ARMInfo.get_values ARM version: 2.14.0
[06-22-2025 16:52:31] INFO ARM: ARMInfo.get_values Python version: 3.13.3 (main, Jun 16 2025, 18:15:32) [GCC 14.2.0]
[06-22-2025 16:52:31] INFO ARM: ARMInfo.get_values User is: arm
[06-22-2025 16:52:31] INFO ARM: ARMInfo.get_values Alembic head is: 6870a5546912
[06-22-2025 16:52:31] INFO ARM: ARMInfo.get_values Database version is: 6870a5546912
[06-22-2025 16:52:31] INFO ARM: main.<module> ************* Starting ARM processing at 2025-06-22 16:52:31.501687 *************
[06-22-2025 16:52:31] DEBUG ARM: utils.database_adder Trying to add Job
[06-22-2025 16:52:31] DEBUG ARM: utils.database_adder successfully written Job to the database
[06-22-2025 16:52:32] DEBUG ARM: DriveUtils.update_drive_job Updating Drive: ['Drive 1'|'/dev/sr0'] Current Job: [24] Previous Job: [23]
[06-22-2025 16:52:32] DEBUG ARM: DriveUtils.update_drive_job Database update with new Job ID to associated drive
[06-22-2025 16:52:32] DEBUG ARM: main.<module> drive_mode: auto
[06-22-2025 16:52:32] DEBUG ARM: utils.database_adder Trying to add Config
[06-22-2025 16:52:32] DEBUG ARM: utils.database_adder successfully written Config to the database
[06-22-2025 16:52:32] INFO ARM: logger.clean_up_logs Looking for log files older than 1 days old.
[06-22-2025 16:52:32] INFO ARM: logger.clean_up_logs Checking path /home/arm/logs/ for old log files...
[06-22-2025 16:52:32] INFO ARM: logger.clean_up_logs Checking path /home/arm/logs/progress for old log files...
[06-22-2025 16:52:32] ERROR ARM: main.<module> [Errno 2] No such file or directory: '/home/arm/logs/progress'
Traceback (most recent call last):
  File "/opt/arm/arm/ripper/main.py", line 216, in <module>
    logger.clean_up_logs(cfg.arm_config["LOGPATH"], cfg.arm_config["LOGLIFE"])
    ~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/arm/arm/ripper/logger.py", line 90, in clean_up_logs
    for filename in os.listdir(log_dir):
                    ~~~~~~~~~~^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/home/arm/logs/progress'
[06-22-2025 16:52:32] ERROR ARM: main.<module> A fatal error has occurred and ARM is exiting.  See traceback below for details.
[06-22-2025 16:52:32] DEBUG ARM: utils.notify apprise message, title: ARM notification body: ARM encountered a fatal error processing None. Check the logs for more details. [Errno 2] No such file or directory: '/home/arm/logs/progress'
[06-22-2025 16:52:32] DEBUG ARM: utils.database_adder Trying to add Notifications
[06-22-2025 16:52:32] DEBUG ARM: utils.database_adder successfully written Notifications to the database
[06-22-2025 16:52:32] DEBUG ARM: job.eject Unmounted disc /dev/sr0
[06-22-2025 16:52:36] DEBUG ARM: job.eject Failed to eject /dev/sr0

alwold added 2 commits June 14, 2025 18:15
@alwold
If a log directory doesn't exist, skip it so the script doesn't crash
d916700
@alwold
Move logging cleanup inside of the try-catch block
f3c0b2b 
If an exception is thrown inside of the logging cleanup, this will
properly handle it and clean up the job.
@alwold alwold marked this pull request as ready for review June 22, 2025 23:55
microtechno9000
microtechno9000 reviewed Jun 23, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@microtechno9000 microtechno9000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, please review the suggested change

@microtechno9000
Copy link
Copy Markdown
Collaborator

microtechno9000 commented Jun 23, 2025

Thanks for making ARM better, and adding logs to your PR :)

The version script isn't working for some reason at the moment, please bump your ARM version manually

@microtechno9000 microtechno9000 added the Awaiting feedback Waiting for user to test fixes label Jun 30, 2025
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jul 13, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@alwold alwold requested a review from microtechno9000 July 13, 2025 03:16
1337-server
1337-server requested changes Oct 4, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@1337-server 1337-server left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also need to update/sync your fork as the submodule is out of date.

@alwold alwold requested a review from 1337-server October 5, 2025 06:01
1337-server
1337-server requested changes Oct 26, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@1337-server 1337-server left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the delay, can you please bump the version and we can merge ?

@1337-server 1337-server self-assigned this Oct 26, 2025
@alwold alwold force-pushed the error-handling-improvements branch from 80b16d6 to a3740e3 Compare November 19, 2025 05:24
@alwold alwold force-pushed the error-handling-improvements branch from a3740e3 to cb51748 Compare November 19, 2025 05:24
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Nov 19, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@alwold
Copy link
Copy Markdown
Contributor Author

alwold commented Nov 19, 2025

Sorry about the delay, can you please bump the version and we can merge ?

@1337-server ok, it's updated! Sorry for the delay on my end as well :) I'll try to keep it updated if the VERSION in main changes again.

@alwold alwold requested a review from 1337-server November 19, 2025 05:25
@microtechno9000 microtechno9000 added the ReadyToMerge Ready for approval and merge as a group label Feb 4, 2026
@microtechno9000
Update VERSION
ed45dfc 
fixing, went the wrong way
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Feb 5, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@microtechno9000 microtechno9000 merged commit 42472fc into automatic-ripping-machine:main Feb 5, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@microtechno9000 microtechno9000 microtechno9000 approved these changes

@1337-server 1337-server Awaiting requested review from 1337-server

Assignees

@1337-server 1337-server

Labels

Awaiting feedback Waiting for user to test fixes ReadyToMerge Ready for approval and merge as a group

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alwold @microtechno9000 @1337-server