Version: NG-2.13

Nomenclature of Index Patterns

When configuring Data Retention settings in vuSmartMaps, understanding the nomenclature of the index pattern is essential. The index prefix you provide plays a crucial role in specifying which data to apply the retention settings to.

note

The default Data Retention Settings are that of Index Pattern 1-*
- For any particular Index Name if Data Retention Settings are not configured then the default Data Retention Settings will be followed.
- In case of a mismatch between Index Pattern and Index Name, the default Data Retention Settings will be followed.

Case 1

If all the indices to be archived have a common Index Name followed by Date in format name-of-the-index-YYYY-MM-DD then the Index Pattern to be entered in Data Retention Settings should be name-of-the-index

Example: If the indices to be archived are:

vunet-1-1-aruba-airwave-trend-2022.07.11  
vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07

These all have same Index Name which is vunet-1-1-aruba-airwave-trend followed by date therefore the Index Pattern to be entered in Data Retention Settings should be vunet-1-1-aruba-airwave-trend

note

Avoiding Common Mistakes

If the Index Pattern is named as vunet-1-1-aruba-airwave-trend-*
This will result in mis-match between the Index Name & Index Pattern and the default Data Retention Settings will be followed.
If the Index Pattern is named as vunet-1-1-aruba-airwave-trend*
This will result in matching with some additional Index Names which may not be required in this case.

Example: If the Index Pattern is named as vunet-1-1-aruba-airwave-trend* then in addition to the above-mentioned Indices which are

vunet-1-1-aruba-airwave-trend-2022.07.11  
vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07

Other Indices such that:

vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10  
vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11  
vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08  
vunet-1-1-aruba-airwave-trend-chennai

Will also be archived and later deleted, resulting in unwanted archival or deletion of data.

Hence, Indices archived using Index Pattern vunet-1-1-aruba-airwave-trend are a subset of the Indices archived using Index Pattern vunet-1-1-aruba-airwave-trend*

Case 2

If the indices to be archived have different Index Names as shown in example below:

vunet-1-1-aruba-airwave-client-data      
vunet-1-1-aruba-airwave-data-2022.07.11   	   
vunet-1-1-aruba-airwave-trend-2022.07.11       
vunet-1-1-aruba-airwave-trend-2022.07.10

Here,

vunet-1-1-aruba-airwave-client-data
has Index Name
vunet-1-1-aruba-airwave-client-data

vunet-1-1-aruba-airwave-data-2022.07.11 has Index Name
vunet-1-1-aruba-airwave-data

vunet-1-1-aruba-airwave-trend-2022.07.11
and
vunet-1-1-aruba-airwave-trend-2022.07.10
have Index Name
vunet-1-1-aruba-airwave-trend

Then the Index Pattern to be entered in Data Retention Settings to archive all the above-mentioned Indices should be part of the Index Name common to all followed by *

Here, the part of Index Name common to all of these below:

vunet-1-1-aruba-airwave-client-data      
vunet-1-1-aruba-airwave-data-2022.07.11   	   
vunet-1-1-aruba-airwave-trend-2022.07.11       
vunet-1-1-aruba-airwave-trend-2022.07.10

is vunet-1-1-aruba-airwave-

so the Index Pattern should be vunet-1-1-aruba-airwave-*

Example:

Below is the list of all the indices

vunet-1-1-aruba-airwave-trend-2022.07.11  
vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10  
vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11  
vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08  
vunet-1-1-aruba-airwave-trend-chennai  
vunet-1-1-aruba-airwave-client-data      
vunet-1-1-aruba-airwave-data-2022.07.11  
vunet-1-1-aruba-temp-airwave-client-data  
vunet-1-1-aruba-new-airwave-client-data

Index Pattern	Index Names Matched
`vunet-1-1-aruba-airwave-trend`	`vunet-1-1-aruba-airwave-trend-2022.07.10` `vunet-1-1-aruba-airwave-trend-2022.07.09` `vunet-1-1-aruba-airwave-trend-2022.07.08` `vunet-1-1-aruba-airwave-trend-2022.07.07`
`vunet-1-1-aruba-airwave-trend*`	`vunet-1-1-aruba-airwave-trend-2022.07.10` `vunet-1-1-aruba-airwave-trend-2022.07.09` `vunet-1-1-aruba-airwave-trend-2022.07.08` `vunet-1-1-aruba-airwave-trend-2022.07.07` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10` `vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11` `vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08` `vunet-1-1-aruba-airwave-trend-chennai`
`vunet-1-1-aruba-airwave-trend-*`	`vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10` `vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11` `vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08` `vunet-1-1-aruba-airwave-trend-chennai`
`vunet-1-1-aruba-airwave-trend-bangalore-*`	`No Match`
`vunet-1-1-aruba-airwave-trend-bangalore`	`vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10`
`vunet-1-1-aruba-airwave-trend-banga*`	`vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10`
`vunet-1-1-aruba-*`	`vunet-1-1-aruba-airwave-trend-2022.07.11` `vunet-1-1-aruba-airwave-trend-2022.07.10` `vunet-1-1-aruba-airwave-trend-2022.07.09` `vunet-1-1-aruba-airwave-trend-2022.07.08` `vunet-1-1-aruba-airwave-trend-2022.07.07` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10` `vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11` `vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08` `vunet-1-1-aruba-airwave-trend-chennai` `vunet-1-1-aruba-airwave-client-data` `vunet-1-1-aruba-airwave-data-2022.07.11` `vunet-1-1-aruba-temp-airwave-client-data` `vunet-1-1-aruba-new-airwave-client-data`
`vunet-1-1-aruba*`	`vunet-1-1-aruba-airwave-trend-2022.07.11` `vunet-1-1-aruba-airwave-trend-2022.07.10` `vunet-1-1-aruba-airwave-trend-2022.07.09` `vunet-1-1-aruba-airwave-trend-2022.07.08` `vunet-1-1-aruba-airwave-trend-2022.07.07` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10` `vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11` `vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08` `vunet-1-1-aruba-airwave-trend-chennai` `vunet-1-1-aruba-airwave-client-data` `vunet-1-1-aruba-airwave-data-2022.07.11` `vunet-1-1-aruba-temp-airwave-client-data` `vunet-1-1-aruba-new-airwave-client-data`
`vunet-1-1-aruba-airwave-*`	`vunet-1-1-aruba-airwave-trend-2022.07.11` `vunet-1-1-aruba-airwave-trend-2022.07.10` `vunet-1-1-aruba-airwave-trend-2022.07.09` `vunet-1-1-aruba-airwave-trend-2022.07.08` `vunet-1-1-aruba-airwave-trend-2022.07.07` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11` `vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10` `vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11` `vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08` `vunet-1-1-aruba-airwave-trend-chennai` `vunet-1-1-aruba-airwave-client-data`

The matching of the Index Pattern and Index Name follows an order. Index Patterns are in the order of their creation. While matching, the Index Name tries to match itself with the Index Pattern one by one from the first one in the order, if the Index Name finds a match it will take the Data Retention Settings of that Index Pattern and ignore all others, but if does not find a match with any Index Pattern then it would take the default Data Retention Settings of Index Pattern 1-* lying at the last in the order of Index Patterns.

Settings of that Index Pattern and ignore all others, but if does not find a match with any Index Pattern then it would take the default Data Retention Settings of Index Pattern 1-* lying at the last in the order of Index Patterns.

Example:
Suppose this is the exhaustive list of indices that we have

vunet-1-1-aruba-airwave-trend-2022.07.11  
vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10  
vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11  
vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08  
vunet-1-1-aruba-airwave-trend-chennai  
vunet-1-1-aruba-airwave-client-data      
vunet-1-1-aruba-airwave-data-2022.07.11  
vunet-1-1-aruba-temp-airwave-client-data  
vunet-1-1-aruba-new-airwave-client-data

Scenario 1:

Order of Index Pattern	Active Data	Inactive Data	Archive Data
`vunet-1-1-aruba-airwave-trend*`	1	2	3
`vunet-1-1-aruba-airwave-trend`	4	5	6

In this scenario,

vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10  
vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11  
vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08  
vunet-1-1-aruba-airwave-trend-chennai

Will take Settings of vunet-1-1-aruba-airwave-trend-* which is 1 day for Active Data, 2 days for Inactive Data and 3 days for Archive Data.

No Index Name will match with Index Pattern vunet-1-1-aruba-airwave-trend

Scenario 2:

Order of Index Pattern	Active Data	Inactive Data	Archive Data
`vunet-1-1-aruba-airwave-trend`	4	5	6
`vunet-1-1-aruba-airwave-trend*`	1	2	3

In this scenario,

vunet-1-1-aruba-airwave-trend-2022.07.10  
vunet-1-1-aruba-airwave-trend-2022.07.09  
vunet-1-1-aruba-airwave-trend-2022.07.08  
vunet-1-1-aruba-airwave-trend-2022.07.07

Will take Settings of vunet-1-1-aruba-airwave-trend which is 4 days for Active Data, 5 days for Inactive Data and 6 days for Archive Data.

And,

vunet-1-1-aruba-airwave-trend-bangalore-2022.07.11  
vunet-1-1-aruba-airwave-trend-bangalore-2022.07.10  
vunet-1-1-aruba-airwave-trend-mumbai-2022.07.11  
vunet-1-1-aruba-airwave-trend-kolkata-2022.07.08  
vunet-1-1-aruba-airwave-trend-chennai

Will take Settings of vunet-1-1-aruba-airwave-trend-* which is 1 day for Active Data, 2 days for Inactive Data and 3 days for Archive Data.