2.2.4.40 QueryHealthMonitoringSettings

msdn link

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Monitoring

The QueryHealthMonitoringSettings complex type defines settings that are used to configure query health monitoring data collection into the objects defined in section 3.1.1.5.

 <xs:complexType name="QueryHealthMonitoringSettings" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" name="AggregatedBufferFlushTimeoutMinutes" type="xs:int"/>
     <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="AggregatorFilters" nillable="true" type="q3:ArrayOfboolean"/>
     <xs:element minOccurs="0" name="BufferFlushThreshold" type="xs:int"/>
     <xs:element minOccurs="0" name="LatencyTrendBucketMs" type="xs:int"/>
     <xs:element minOccurs="0" name="LatencyTrendUseAggregation" type="xs:boolean"/>
     <xs:element minOccurs="0" name="MaxSizeMb" type="xs:int"/>
     <xs:element minOccurs="0" name="RetentionPeriodDays" type="xs:int"/>
     <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="VerboseFilters" nillable="true" type="q3:ArrayOfstring"/>
     <xs:element minOccurs="0" name="VerboseLatencyThreshold" type="xs:int"/>
     <xs:element minOccurs="0" name="VerboseQueryMonitoring" type="xs:boolean"/>
   </xs:sequence>
 </xs:complexType>

AggregatedBufferFlushTimeoutMinutes:  Specifies the time period that query latencies are aggregated in the objects in section 3.1.1.5.

AggregatorFilters:  Specifies a list of Boolean values that indicate whether to aggregate query latencies based on the associated value of the search query property in the objects defined in section 3.1.1.5. The list MUST include five values, as specified in the following table.

Value	Meaning
1	Corresponds to the PartitionId of the search query.
2	Corresponds to the ClientType property of the search query.
3	Corresponds to the ResultsUrl property of the search query.
4	Corresponds to the FlowName property of the search query.
5	Corresponds to the QueryTag property of the search query and any other tags added by the protocol server.

The query properties are specified in section 3.1.4.7.3.1. The protocol server MUST aggregate query latencies for every query property for which the corresponding flag is set to TRUE.

BufferFlushThreshold:  Specifies the maximum number of queries to be aggregated in the objects in section 3.1.1.5.

LatencyTrendBucketMs:  Specifies the approximation value for the aggregated query latencies in the KeyValueOfintAggregatedOMQueryLatencyDataBuffer_PFsic3Az.Value defined in section 2.2.4.14.

LatencyTrendUseAggregation:  Specifies whether the values in the KeyValueOfintAggregatedOMQueryLatencyDataBuffer_PFsic3Az.Value defined in section 2.2.4.14 are used by the protocol server.

MaxSizeMb: Specifies the maximum size in megabytes of the data used to store the query monitoring information specified in section 3.1.1.5 on the protocol server.

RetentionPeriodDays: Specifies the maximum number of days over which the query monitoring information specified in section 3.1.1.5 is stored on the protocol server.

VerboseFilters:  Specifies a list of values for which, when satisfied by the properties of a search query, the protocol server will record query latencies for that query. The list MUST include five values, as specified in the following table.

Value	Meaning
1	Corresponds to the unique identifier of the Partitionid property for the search query.
2	Corresponds to the ClientType property of the search query.
3	Corresponds to the ResultsUrl property of the search query.
4	Corresponds to the FlowName property of the search query.
5	Corresponds to the QueryTag property of the search query and any other tags added by the protocol server.

The query properties are specified in section 3.1.4.7.3.1.

VerboseLatencyThreshold:  Specifies a latency value beyond which, when exceeded by a search query, the protocol server will record query latencies for that query.

VerboseQueryMonitoring:  Specifies the maximum number of queries to be aggregated in the objects in section 3.1.1.5.