This article is relevant ONLY if you are working in an On-Premises environment for ControlUp for VDI & DaaS Real-Time DX.
This is the less common deployment so this article may not apply to your environment.

Insights On-Premises: Data Retention Policy

Prev Next
Important

Before you use this feature, make sure to have backups of your activity files. Learn how to make backups here.

Insights On-Premises (IOP) stores historical data for an unlimited period of time on your data disk(s). With the Data Retention Policy feature in versions 8.7 and higher, you can define the number of days that you want to retain IOP data on your appliance disks.

You can precisely define which type(s) of data to retain:

  • Processes: Data collected from processes running on a computer, such as CPU utilization, memory usage, disk IOPS
  • Sessions: Data collected during a login session (RDSH, VDI, etc.). For example, the login time, username, and the resources acquired by the session (CPU, RAM, etc.)
  • Computers: Data collected from a computer, hypervisor host, and VDI. This includes CPU utilization, memory usage, etc.
  • Hosts: Data collected from the virtualization host, such as CPU usage, memory usage, etc
  • CUIOP: Data collected from Citrix ADC, Gateway, Load balancer, XD app, XD session, Top insights, HEC logs, and Container logs
  • All data

On-Premises historical data is stored at full resolution with no per-resolution retention tiers. Any resolution (5 minutes to 1 day) is available for the whole retained period.

Data Retention Policy Settings

  • You must set the the number of days to retain data from 10 to 9999 days.
  • Set one value for all data, or a separate value for each type: processes, sessions, computers, hosts, and other ControlUp data.
  • Older IOP versions and Linux installs have no UI setting. You must manually change data retention in the index configuration.
  • Reports use a standard time-range picker with presets and custom dates. No lookback limit or maximum range is enforced by the reports.
  • If you request dates older than the retained data, the report returns no results for that period.

Note that the disk limit always applies. If the disk limit is reached before the retention period, the oldest data is still deleted first.

Prerequisites

  • IOP version 8.7 or higher
  • The IOP appliance must be an OVA installation. Linux-based installations aren't supported.
  • The password for the master node and the data node must be indentical.

How to Set a Data Retention Policy

By default, the data retention is set to 2184 days.
Data Retention Policy page

To set the number of days that each data type should be retained, select its checkbox and enter a digit in the Days field. For this example, we want to keep process data for 30 days, session data for 60 days, and all other data for 90 days.
All data section