Iris.IfxLite.FilePurger.exe

Overview

Iris.IfxLite.FilePurger.exe is a command-line utility that helps manage disk space by removing old IRIS log files.

It optionally archives the logs before deletion, ensuring that you maintain historical records while reclaiming valuable disk space.

Key features

• Disk Space Optimization - quickly identifies and removes outdated log files, freeing up storage.
• Optional Backup - archives logs into compressed files before deletion, preserving a historical record.
• Flexible Targets - works with IRIS program logs and data logs directories.
• Dry run - simulate the purge operation to preview which files would be affected without making any changes.

Prerequisites

• Administrative Privileges - run with elevated permissions to ensure access to protected log files.
• Sufficient Disk Space - needed for temporary compressed backups if archiving is enabled.
• Backup Strategy - decide if you need historical logs before choosing a purge method.

Archiving

When archiving is enabled, the tool creates compressed files containing the old log files before deleting them.

The compressed files are created under "IRIS"\Logs\_ArchivedLogs\"Current_IRIS_Version"\Date_Time

Example path for archived logs:

"IRIS"\Logs\__ArchivedLogs\v25.1\20250120_111612\

Subsequent runs of the tool generate additional Date_Time folders under the same folder structure.

The archived logs can be moved to a backup location or deleted as required.

Important

• Multiple IRIS installations (LPO and Central Main Installers) - Iris.IfxLite.FilePurger.exe will need to be run on each machine that the LPO or main IRIS installer has been run on.
• Data\Log Purging - we recommend running Iris.IfxLite.FilePurger.exe from the main IRIS installation as opposed to running it from an LPO installation when purging the data logs directory.
• Data Integrity - always ensure that you have a backup strategy in place before performing purge operations, especially if historical logs are important.

• Dry Run - use the `-dry-run` option to preview the impact of the purge operation before executing it.

• Administrative Privileges - running the utility without elevated permissions may result in errors due to restricted access to protected files.

Usage

From an elevated command prompt run "IRIS"\LogPurger\Iris.IfxLite.FilePurger.exe

Syntax:

Iris.IfxLite.FilePurger.exe [-h] [-mode=<mode>] [-purge] [-purge-no-backup] [-dry-run] [-before-days=<days>]

Options:

-h

    show this help message and exit.

-purge

    archive old log files into .zip archives, then delete the original files.

-purge-no-backup

    delete old log files without creating .zip archives.

-dry-run

    simulate the selected purge operation without making any changes. This is helpful for previewing which files would be archived and/or removed.

-mode=<mode>

    Specify the mode of operation.

The following modes are available:

• full - process both IRIS program logs and data logs.
• data_logs_only - process only data logs.
• iris_logs_only - process only IRIS program logs.

If not specified, the default mode is 'full'.

-before-days=<days>

    Specify the age threshold (in days) that determines which logs are considered old and eligible for purging.

    If not specified, the default is 90 days.

Important note on operation election

One of -purge, -purge-no-backup, or -dry-run must be specified.

Examples:

1. Display Help Information:
   Iris.IfxLite.FilePurger.exe -h
   Prints usage info and exits.
   

2. Dry Run (No Changes):
   Iris.IfxLite.FilePurger.exe -dry-run -before-days=7
   Shows what would be purged if logs older than 7 days were targeted, but does not modify any files.
   Also displays a summary of the number of files and their sizes that would be archived and/or deleted.

3. Purge With Backup (Default 90 Days):
   Iris.IfxLite.FilePurger.exe -purge
   Archives all log files older than 90 days into .zip files, then deletes the originals.
   Also displays a summary of the number of files and their sizes that have been archived and/or deleted.
   
4. Purge Without Backup:
   Iris.IfxLite.FilePurger.exe -purge-no-backup -before-days=14
   Immediately deletes all log files older than 14 days without creating backups.
   Also displays a summary of the number of files and their sizes that have been archived and/or deleted.
   
5. Specify Mode:
   Iris.IfxLite.FilePurger.exe -purge -mode=data_logs_only -before-days=60
   Purges data logs older than 60 days, archiving them first, in the specified "data_logs_only" mode.
   Also displays a summary of the number of files and their sizes that have been archived and/or deleted.