Trim down notable event KV store collections in ITSI

ITSI stores the status of notable events and episodes in the KV store collections called itsi_notable_<object type>. By default, notable event metadata is archived after six months to keep the KV store from growing too large. If you have a large number of events, use the ITSI Health Check dashboard to check the collection sizes on disk and decide if you need to change the retention policy.

You can tune the retention policy for notable event metadata using an ITSI configuration file. The retention policy determines how long notable event metadata remains in the KV store before it is moved to itsi_notable_archive. Retention policies are based on the mod_time (modify time), not the tag creation time.

Prerequisites

• Only users with file system access, such as system administrators, can set the notable event retention policy.
• Review the steps in How to edit a configuration file in the Admin Manual.

Never change or copy the configuration files in the default directory. The files in the default directory must remain intact and in their original location.

Steps

1. Open or create a local itsi_notable_event_retention.conf file in $SPLUNK_HOME/etc/apps/SA-ITOA/local/
2. To set the retention time for all object types, reduce the retentionTimeInSec in the [default] stanza. To individually set retention times for specific collections, add the retentionTimeInSec setting to individual stanzas as needed and reduce the retention time there. The settings in individual stanzas override what's set in the [default] stanza.
   

# default retention policy is 6 months
retentionTimeInSec = 15768000
retentionObjectCount = 500000
disabled = 1

[itsi_notable_event_tag]
# Check retention policy against mod_time (modify time of tags) and move tags to index once they meet the condition
disabled = 0
object_type = notable_event_tag

[itsi_notable_event_ticketing]
# Check retention policy against mod_time (modify time of ticket) and move ticket to index once they meet the condition
disabled = 0
object_type = external_ticket

[itsi_notable_group_user]
# Default is one year
retentionTimeInSec = 31536000
retentionObjectCount = 500000
disabled = 0
object_type = notable_event_group

[itsi_notable_group_system]
# Default is one year
retentionTimeInSec = 31536000
retentionObjectCount = 500000
disabled = 0
object_type = notable_group_system