Data Store Garbage Collection AEM 6.x

Running Data Store Garbage Collection

There are three ways of running data store garbage collection, depending on the data store setup on which AEM is running:

1. Via Revision Cleanup - a garbage collection mechanism usually used for node store cleanup.
2. Via Data Store Garbage Collection - a garbage collection mechanism specific for external data stores, available on the Operations Dashboard.
3. Via the JMX Console.

If TarMK is being used as both the node store and data store, then Revision Cleanup can be used for garbage collection of both node store and data store.

However if an external data store is configured such as File System Data Store, then data store garbage collection must be explicitly triggered separate from Revision Cleanup. 

Data store garbage collection can be triggered either via the Operations Dashboard or the JMX Console.

The below table shows the data store garbage collection type that needs to be used for all the supported data store deployments in AEM 6:

Node Store	Data Store	Garbage Collection Mechanism
TarMK	TarMK	Revision Cleanup (binaries are in-lined with Segment Store)
TarMK	External Filesystem	Data Store Garbage Collection task via Operations Dashboard JMX Console
MongoDB	MongoDB	Data Store Garbage Collection task via Operations Dashboard JMX Console
MongoDB	External Filesystem	Data Store Garbage Collection task via Operations Dashboard JMX Console

Running Data Store Garbage Collection via the Operations Dashboard

The built-in Weekly Maintenance Window, available via the Operations Dashboard, contains a built-in task to trigger the Data Store Garbage Collection at 1 am on Sundays.

If you need to run data store garbage collection outside of this time, it can be triggered manually via the Operations Dashboard.

Before running data store garbage collection you should check that no backups are running at the time.

Open the Operations Dashboard by Navigation -> Tools -> Operations -> Maintenance.




Click or tap the Weekly Maintenance Window.







Select the Data Store Garbage Collection task and then click or tap the Run icon.







Data store garbage collection runs and its status is displayed in the dashboard.

Note:

The Data Store Garbage Collection task will only be visible if you have configured an external file data store. See Configuring node stores and data stores in AEM 6 for information on how to set up a file data store.

Running Data Store Garbage Collection via the JMX Console

This section is about manually running data store garbage collection via the JMX Console. If your installation is set up without an external data store, then this does not apply to your installation. Instead see the instructions on how to run Revision cleanup under Maintaining the Repository.

Note:

If you are running TarMK with an external data store, it is required you run Revision Cleanup first in order for garbage collection to be effective.

To run garbage collection:

In the Apache Felix OSGi Management Console, highlight the Main tab and select JMX from the following menu.




Next, search for and click the Repository Manager MBean (or go to http://host:port/system/console/jmx/org.apache.jackrabbit.oak%3Aname%3Drepository+manager%2Ctype%3DRepositoryManagement).




Click startDataStoreGC(boolean markOnly).




enter "true" for the markOnly parameter if required:


Option	Description
boolean markOnly	Set to true to only mark references and not sweep in the mark and sweep operation. This mode is to be used when the underlying BlobStore is shared between multiple different repositories. For all other cases set it to false to perform full garbage collection.




Click Invoke. CRX runs the garbage collection and indicates when it has completed.

Note:

The data store garbage collection will not collect files that have been deleted in the last 24 hours.

Note:

The data store garbage colleciton task will only start if you have configured an external file data store. If an external file data store has not been configured, the task will return the message Cannot perform operation: no service of type BlobGCMBean found after invoking. See Configuring node stores and data stores in AEM 6 for information on how to set up a file data store.

Automating Data Store Garbage Collection

If possible, data store garbage collection should be run when there is little load on the system, for example in the morning.

The built-in Weekly Maintenance Window, available via the Operations Dashboard, contains a built-in task to trigger the Data Store Garbage Collection at 1 am on Sundays. You should also check that no backups are running at this time. The start of the maintenance window can be customized via the dashboard as necessary.

Note:

The reason not to run it concurrently is so that old (and unused) data store files are also backed up, so that if it is required to roll back to an old revision, the binaries are still there in the backup.

If you don't wish to run data store garbage collection with the Weekly Maintenance Window in the Operations Dashboard, it can also be automated using the wget or curl HTTP clients. The following is an example of how to automate backup by using curl:

Caution:

In the following example curl commands various parameters might need to be configured for your instance; for example, the hostname (localhost), port (4502), admin password (xyz) and various parameters for the actual data store garbage collection.

Here is an example curl command to invoke data store garbage colleciton via the command line:

1	curl -u admin:admin -X POST --data markOnly=true  http://localhost:4503/system/console/jmx/org.apache.jackrabbit.oak"%"3Aname"%"3Drepository+manager"%"2Ctype"%"3DRepositoryManagement/op/startDataStoreGC/boolean

The curl command returns immediately.

Reference URL:

https://helpx.adobe.com/experience-manager/6-4/sites/administering/using/data-store-garbage-collection.html