OpenSearch Indices and Fields Used in Analytics

GigaVUE-FM uses the following OpenSearch indices to store data1. These OpenSearch indices store different sets of data based on usability. The document mappings of the indices are also different.

fmstats*: For storing statistics information of entities such as maps, gsgrops, gsops, etc(except port)
fmstats_ports*: For storing statistics information of the port
fminventory: For storing the inventory and assets.
fmevents: For storing events
fmalarms: For storing alarms.

The following table lists the new keys introduced in software version 6.0:

Table 1:
New Field	Applicable Indices	Type	Description
resource.id.entityid	fmalarms fmevents fmstats: Applicable for the following document types: vport stats gsop stats gtap port stats	text	Represents the entity ID. Holds value exactly similar to resourceId in the existing alarms/events document. If the resourceId does not exist in the document, the resource.id.entityId also will not exist. Example: For alarms related to port, port ID will be the resourceId, and resource.id.entityId.
resource.id.deviceId	fmalarms fmevents fmstats_ports fmstats: Applicable for the following document types: gsgroup stats gsgroup port rate core rate stats vport stats Map and MapRule stats gsop stats	text	Represents the deviceId. That is, hostname. If the hostname does not exist in the document, the resource.id.deviceId also will not exist in the document
resource.id.clusterId	fmalarms fmstats: Applicable for the following document types: vport stats gsop stats	text	Represents the clusterId. If the clusterId does not exist in the document, then resource.id.clusterId also will not exist in the document
resoure.type	fmalarms fmevents fmstats: Applicable for the following document types: vport stats gsop stats	text	Represents the resource type (port, map, device, gsgroup)
resource.id.alias	fmalarms fmevents fminventory fmstats_ports fmstats: Applicable for the following document types: vport stats gsop stats Map and Map Rule stats	text	Represents the alias name of the associated entity of the alarm. If the alias does not exist in the document, then resource.id.alias will not exist in the document.
resource.name	fminventory fmstats fmstats: Applicable for the following document types: vport stats gsop stats		Represents the key used to uniquely identify a particular entity across the system. For example, for ports, ClusterID, and PortId can be combined and used to uniquely identify the entity. In case of map, ClusterID, and map alias name are used. The value will be in the form of ClusterId__EntityId
port.alias	fmstats_ports		Represents the alias name of the port's alias.
port.dir	fmstats_ports		Represents the direction of the port.
gsGroup.alias	fmstats: Applicable for the following document types: gsgroup stats gsgroup port rate, and core rate stats documents vport stats gsop stats		Represents the alias name of the gsgroup alias
map.alias	fmstats: Applicable for the following document types: Map and MapRule stats gsop stats		Represent the alias name of the map alias
gsVport.alias	fmstats: Applicable for the following document types: vport stats gsop stats		Represents the alias name of the vport alias
cluster.mode	fminventory		Represents the mode of the device with respect to the cluster. Applicable values are as follows: leader standby standalone normal
linkSpeedInBits	fmstats_ports		Represents the link speed in bits per second. Note: It is recommended to use the linkSpeedInBits field in custom visualizations (instead of linkSpeed)