Data Retention and Cleanup Tool
The Data Retention and Cleanup Tool enables you to retain or delete data from Cavisson products. Using this tool, you can configure the data retention and cleanup settings for various types of files and database entities across Cavisson products. You can also specify different retention periods for different types of data such as raw data, processed data, metrics data, DDR data, and logs, etc.
Key Features
The Data Retention tool enables you to:
- Manage data effectively.
- Retain or delete the required data.
- Specify the time period for retaining data.
- Generate an audit log of the deleted data.
- Configure special days (such as high sale days), for which the data shall be retained for elongated durations
Supported Products
Various Cavisson products generate a variety of data, which may need periodic cleanup. For example, NetDiagnostics generates processed data, RTG data, logs, and database partition tables. In Netstorm and NetCloud products, you may need to delete the test runs. The Data Retention tool enables you to free up disk space in these products by removing the obsolete data.
Data Retention tool is supported by the following products:
- NetStorm
- NetDiagnostics
- NetCloud (Controller and Generator)
- NetOcean
- NetVision
- NetForest
- NetChannel
- NetTest
- NetHavoc
Accessing the Data Retention and Cleanup tool
To access the Data Retention and Data Cleanup tool, select Admin > Retention Policy.
In the Data Retention and Cleanup tool, you can specify the following for your data:
- Global configuration
- Cleanup configuration
Global Configuration
In the Global Configuration tab, you can specify the following settings:
- Enable data retention: Select the Enable data retention option to enable the data retention feature for the entire data on your system.
- Enable Recycle Bin: Select the Enable Recycle Bin to specify the time period for storing the deleted data. Note: Only test runs will be stored in the recycle bin for a given period of time.
- Disable entire data cleanup: This allows you to specify the time period when the data retention tool is disabled for the entire data.
- Cleanup Negative Days: Specify the days when the data retention tool will not run for the selected components on your system.
Enabling the Data Retention and Cleanup Tool
To enable the Data Retention and Data Cleanup tool:
- Select Admin > Retention Policy.
- Select the Enable Data Retention option in the Global Configuration tab.
- Click Save.
Storing Deleted TRs in the Recycle Bin
If you want to store deleted test runs for a given period of time, you can select the Enable Recycle Bin option in the Data Retention and Cleanup tool. All the deleted test runs will show in the recycle bin tab and the user can further restore or delete the test run from the recycle bin. By default, the Enable Recycle Bin option is disabled.
Note: The maximum value of storing the test runs in the recycle bin is 7 days.
To use this feature:
- Select the Enable Recycle Bin
- Select the number of days you want to store data in the recycle bin.
3. Click Save.
Disabling Entire Data Cleanup
To apply the data retention policy for the entire data:
- Select the Enable Data Retention option in the Global Configuration tab.
- Specify the Start Date and End Date settings in the Disable Entire Data Cleanup section.
- Click the
icon to add multiple time period, as shown in the following figure:
4. Click Save.
Specifying Cleanup Negative Days
By defining the Cleanup Negative Days, you can specify the time period for not deleting the selected components from your system. You can specify a single date or range of dates when you do not want to run the tool. It consists of only future dates. For example, Single date-2020/2/15 and multiple dates-2020/2/15:2020/2/17″.
To specify the days when the data retention tool will not run:
- Select the required component from the list of Select Component.
2. Enable the Start Date option to specify both start date and end date.
3. Click the icon to add multiple time period for not running the tool.
Custom Clean Path
You can also provide the path of any file or directory which needs to be removed from the system. To select the required data:
- Enter the path of the required file name or click Browse to access the required file.
2. Select the time value such as Month, Year, Week, or Day.
3. Click Add to include multiple files.
Specifying the Log Settings
In the Log settings section, you can specify the size of a log file, audit log file, and log level:
- Log File size: Specifies the size of a log file. By default, the value of log file is 10 MB and the maximum size user can configure is upto 1024MB.
- Audit Log size: Specifies the size of the audit log file.
- Log level: Specifies the log level, by default value of log level is 1 and max value of log level will be 4.
Cleanup Configuration
In the Cleanup Configuration tab, you can configure different retention periods for different types of data such as raw data, processed data, metrics data, DDR data, logs etc. The data that can be retained is listed in the following sections:
- Common: In the Common section, you can specify the retention period for the following components:
- Metric data
- Resource timing
- Page dumps
- Drill down data
- Aggregated drill down data
- Diagnostics data
- Performance Test Runs: In the Performance Test Runs section, you can specify the retention period for the following components:
- Debug test runs
- Archive testrun
- TR
- Advance Settings: In the Advance Settings section, you can specify the retention period for the following components:
- Processed data
- Cavisson product logs
- Raw data
Specifying the Data Retention Period
To specify the required retention period for selected components on your system:
- Open the Data Retention and Data Cleanup window by selecting Admin > Retention Policy.
- Click the Cleanup Configuration tab.
3. Expand the required section: Common, Performance Test Runs, or Advanced Settings.
4. Select the retention time period for the required component.
5. Click Save.