The Purge Policies module allows you to create instance/company purge policies to archive or purge ARCHIVE data or USERDATA automatically given a certain condition.

The Purge Policies module includes the following sections:

You can also filter the instance/company purge policies list from this sub-module.

When data is archived, the data is extracted from a Clickhouse Data Server and stored as a .csv.gz file. Each .csv.gz file is up to ten times the size of the data size displayed in Litmus Edge Manager (The data size that is shown in the Stats By Periods section of Statistics is a compressed size).

Before you archive, ensure the Litmus Edge Manager has enough disk space to store all the .csv.gz file data that it will archive. Insufficient disk space will prevent the data from being archived. After archiving, review the list of archive files to ensure the archive operation was successful.

To access the purge policies UI:

Refer to the following actions you can take on the Litmus Edge Manager Admin Console Data Lifecycle's Purge Policies pane.

[1] Show filter / Hide filter: Search by Data Type and Policy Action

[2] Create Instance Purge Policy: Option availability depends on previous selections. See the Create a Policy section below.

[3] Action menu:

[4] Show filter / Hide filter: Search by Company Name, Data Type or Policy Action

[5] Create Company Purge Policy: Option availability depends on previous selections.

[6] Action menu:

Litmus Edge Manager keeps track of disk usage in partitions of months. The tracked disk usage is only for Clickhouse data (hence all archive/purge operations are applicable for only Clickhouse data). The disk usage amount is calculated either from the instance or each individual project. Each month of disk usage is defined as a period.

For example, your Litmus Edge Manager has five projects. To calculate disk usage, each project will be categorized as one period for the same month. So Litmus Edge Manager will generate five periods for the same month, each period including one project.

As an additional example, three months have passed. For the five projects above, each of them experienced some disk usage in those three months. So you will have 15 additional periods (five projects of disk usage * 3 months).

Periods are also categorized as previous or current. If the current system date is March 2023, then all disk usage by projects during March 2023 are current periods. All periods from February 2023 and before are previous periods.

A policy is only applicable for a previous period. See Statistics. 

Refer to the Period Explained section above to learn more about the definition of period in Litmus Edge Manager's Data Lifecycle feature.

When a policy is selected for instance purge settings, it will check all existing project's previous periods.

When a policy is selected for company purge settings, it will check the selected company's existing project's previous periods.

Data will be archived/purged based on the number of months you enter. 

Example 1

You enter 1 and the current date is January 1, 2023.

Example 2

You enter 3 and the current date is January 1, 2023.

Data will be archived/purged for a previous period if the data size is equal to or greater than the data size you enter. The oldest data is archived/purged first.

Example 1

You enter 1GB and the current date is January 1, 2023.

Data will be archived/purged once as long as the free disk-space percentage is below the specified threshold. The oldest data is archived/purged first.

Example 1

You enter 1% and the total disk space size is 100GB.

Example 2

You enter 50% and the total disk space size is 100GB.