Index Cache Cleanup Report

Table of Contents

Overview

The Index Cache Cleanup Report is a log that displays a list of index files that were retained during the cleanup operation, rather than being deleted, with the reason.

CVD launches a cleanup service every 24 hours on the MediaAgent computer. Index files older than the value set for Index retention time in days are automatically deleted once in 24 hours, irrespective of disk free space percentage. The default value of Index Retention Criteria is 15 days. Once the number of retention days for a specific index is met, it gets aged (deleted).

If Index files were not deleted from the disk, the Index Cache Cleanup Report on the MediaAgent can be used to analyze why this happened.

When to Use This Report

This report is useful in these cases:

  • When an aged index did not get pruned or deleted during cleanup.

    For example: A job may have locked the index or the index may have been corrupted.

  • To analyze the number of index files present in the MediaAgent computer.

    For example: The presence of too many index files may require aggressive cleanup activity.

Where to Find This Report

This report is created on the MediaAgent computer, in this directory:

MediaAgent_name/index_cache/IndexCacheCleanupReport.csv

Sample Report

The Index Cache Cleanup Report is provided in CSV format. Its content looks like this:

Report Columns

The report contains the three columns listed here.

Index Cache folder

The location of index files not pruned during the automatic cleanup operation.

Note that index files present under the Intermediate Index Cache are not included in this report.

EventID

The ID corresponding to event message in the third column.

These common Event IDs appear for the reasons shown:

Event ID Retention Reason
234881273 Index is in use by a running job.
234881274 Index was accessed recently.
234881275 Index is in use.
234881276 Failed to open index, check IndexCacheCleanup.log for more details.
234881277 Failed to delete index, check IndexCacheCleanup.log for more details.
234881278 Failed to verify state of index.

Retention Reason

The reason an index file was not deleted.

Disabling Automatic Generation of This Report

By default, the Index Cache Cleanup report is automatically generated. You can prevent this by adding the disableIndexCacheCleanupReport Additional Setting to the MediaAgent.

To disable generation of the Index Cache Cleanup report, follow these steps:

  1. In the CommCell Browser, expand Client Computers.
  2. Right-click the MediaAgent name, then click Properties. In the Client Properties dialog box, click Advanced.
  3. In the Advanced Client Properties dialog box, click the Additional Settings tab.
  4. Click Add. In the Name box, enter disableIndexCacheCleanupReport and press TAB. The Category and Type details automatically populate.

    If you prefer, you can click Lookup and search for this Additional Setting using the Find box.

  5. In the Value box, enter 1.
  6. Verify that the Enable option is selected.
  7. Click OK to save the Additional Setting.
  8. Click OK to close the Advanced Properties dialog box.
  9. Click OK to close the Client Properties dialog box.