indexerinfo XML status report syntax (FAST Search Server 2010 for SharePoint)
Applies to: FAST Search Server 2010
The indexerinfo status command retrieves an XML-formatted report for the Microsoft FAST Search Server 2010 for SharePoint indexer status. This article describes the syntax of the report.
Element quick reference
The report uses the following elements:
| Element | Description |
|---|---|
<indexer> |
This top-level element specifies the overall status of the indexer. |
<documents> |
This element shows information about indexed items. |
<column_role> |
This element specifies the role of an indexer in an index column. |
<index_frequence> |
This element shows the number of items indexed per second. |
<partition> |
This element shows information for one index partition. |
<partition/documents> |
This element shows the number of indexed items in an index partition. |
<document_api> |
This element shows status information related to the input API queues for the indexer. |
<queue_size> |
This element shows the size of the input API queues for the indexer. |
<operations_processed> |
This element shows the number of item batch operations processed by the indexer. |
indexerinfo status XML format
The status output follows all conventions and syntax rules that are defined for the XML file format.
The basic XML structure is as follows:
<?xml version="1.0"?>
<indexer >
<documents />
<column_role />
<index_frequence />
<partition>
<documents />
</partition>
<document_api>
<queue_size />
<operations_processed />
</document_api>
</indexer>
indexer
This is the top-level element. The element specifies the overall status of the indexer.
Attributes
| Attribute | Description |
|---|---|
hostname |
The fully qualified domain name of the server that runs the indexer. |
port |
The lowest port in the range of ports that are used by the indexer. |
cluster |
This attribute contains information that is mainly used for debugging. |
column |
You can look up the column identifiers for the indexers in the deployment.xml configuration file. |
row |
You can look up the row identifiers for the indexers in the deployment.xml configuration file. |
factory_type |
This attribute contains information that is mainly used for debugging. |
preferred_master |
This attribute contains information that is mainly used for debugging. |
connected_feeds |
The number of active feeding (crawling) sessions that are associated with the indexer. |
status |
Shows the status of the indexer:
|
heartbeat |
Shows the status of the indexer heartbeat:
The backup indexer uses the heartbeat to verify that a primary indexer is available. |
exclusion_interval |
This attribute contains information that is mainly used for debugging. |
time_since_last_index |
Shows the number of seconds since a new index set was created. |
Remarks
If a local re-build of the index (reset index) is in progress, you can determine the progress by looking at the status for each index partition (the status attribute for the partition sub-elements).
documents
This element contains information about indexed items related to the indexer.
Attributes
| Attribute | Description |
|---|---|
size |
Shows the total size of the pre-index item store (FiXML files), in bytes. |
total |
Shows the total number of items received by the indexer. This includes items that are not yet available in the search index. |
indexed |
Shows the total number of items that are available in the search index. |
not_indexed |
Shows the number of items that are received by the indexer but are not yet available in the search index. |
column_role
This element specifies the role of an indexer in an index column.
Attributes
| Attribute | Description |
|---|---|
state |
Shows the role of the indexer:
For more information about indexer roles, see Plan FAST Search Server farm topology (FAST Search Server 2010 for SharePoint). |
backups |
Shows the number of backup indexers that are associated with the indexer. Typically, there will only be one backup indexer. |
index_frequence
This element shows the number of items indexed per second.
Attributes
| Attribute | Description |
|---|---|
min |
Shows the lowest measurement of indexed items per second for the indexer. The value is reset when the indexer is restarted. |
max |
Shows the highest measurement of indexed items per second for the indexer. The value is reset when the indexer is restarted. |
partition
This element contains information for one index partition. The report contains one partition element for each index partition.
Attributes
| Attribute | Description |
|---|---|
id |
Shows the internal index partition number. |
index_id |
Shows a unique string identifying the content index associated with this index partition. |
status |
Shows the status of an index partition:
|
type |
This attribute contains information that is mainly used for debugging. |
timestamp_indexed |
Shows the point in time when the index partition was last updated, specified as the number of seconds since midnight January 1, 1970 (UTC), not counting leap seconds. |
indexed_per_second |
Shows the average number of items indexed per second for this index partition. |
pending_exclusionlist |
This attribute contains information that is mainly used for debugging. |
range |
The indexed items are stored in a pre-index item store (FiXML files). The FIXML structures are numbered by using increasing sequence numbers. The range attribute specifies the range of FIXML structures included in the index that is associated with the index partition. If no items are indexed, the range is specified as "0-0". |
Remarks
Within each index column, the indexer uses a dynamic partitioning of the index to handle large number of indexed items with low indexing and query latency. This partitioning is dynamic and is handled internally on each indexer.
partition/documents
This element shows the number of indexed items in an index partition.
Attributes
| Attribute | Description |
|---|---|
active |
Shows the number of searchable items in the index that is associated with the index partition. |
total |
Shows the total number of items in the index that is associated with the index partition. This includes the items in the exclusion list for the partition. |
document_api
This element shows status information related to the internal input API queues for the indexer.
Attributes
| Attribute | Description |
|---|---|
number_of_elements |
Shows the number of item batches stored on the internal input API queue for the indexer. |
last_sequence |
Shows the identifier of the last sequence operation that was processed. |
frequence |
Shows the number of content batch operations processed per second (average value). |
load |
Shows the amount of memory that is used by the input queue, as a percentage of the maximum allowed size. |
status_updates |
Shows the number of failed item operations registered during the uptime of the indexer server. |
queue_size
This element shows the size of the internal input API queues for the indexer.
Attributes
| Attribute | Description |
|---|---|
current |
Shows the size of the input queue in bytes. |
operations_processed
This element shows the number of item batch operations processed by the indexer.
Attributes
| Attribute | Description |
|---|---|
api |
Shows the number of item batch operations processed during the uptime of the indexer server. |
Example
The following example shows the XML output for a single-server FAST Search Server 2010 for SharePoint deployment when you run the command indexerinfo status.
<indexer hostname="host3.site1.contoso.com"
port="13050" cluster="webcluster"
column="0" row="0" factory_type="filehash"
preferred_master="no" connected_feeds="1"
status="running ok" heartbeat="Running"
exclusion_interval="60" time_since_last_index="5043">
<documents size="670099.000000" total="5" indexed="5" not_indexed="0"/>
<column_role state="standalone" backups="0"/>
<index_frequence min="0.125000" max="0.833333"/>
<partition id="0" index_id="1284101760870988000" status="idle" type="dynamic"
timestamp_indexed="1284101766" indexed_per_second="1.000000"
pending_exclusionlist="0" range="1-19">
<documents active="5" total="5"/>
</partition>
<partition id="1" index_id="1283161117300848000" status="idle" type="dynamic"
timestamp_indexed="1283161145" indexed_per_second="0.000000"
pending_exclusionlist="0" range="0-0">
<documents active="0" total="0"/>
</partition>
<partition id="2" index_id="1283161073250105000" status="idle" type="dynamic"
timestamp_indexed="1283161117" indexed_per_second="0.000000"
pending_exclusionlist="0" range="0-0">
<documents active="0" total="0"/>
</partition>
<partition id="3" index_id="1283161051967838000" status="idle" type="dynamic"
timestamp_indexed="1283161073" indexed_per_second="0.000000"
pending_exclusionlist="0" range="0-0">
<documents active="0" total="0"/>
</partition>
<partition id="4" index_id="1283160986359326000" status="idle" type="dynamic"
timestamp_indexed="1283161051" indexed_per_second="0.000000"
pending_exclusionlist="0" range="0-0">
<documents active="0" total="0"/>
</partition>
<document_api number_of_elements="0" last_sequence="77" frequence="0.000000"
load="0.000000" status_updates="0">
<queue_size current="0"/>
<operations_processed api="41"/>
</document_api>
</indexer>
The XML output shows that there are five items (documents) in the index, and that the indexer is active (not suspended).
See Also
Reference
indexerinfo.exe reference (FAST Search Server 2010 for SharePoint)
Concepts
Plan FAST Search Server farm topology (FAST Search Server 2010 for SharePoint)
Recommendations: Redundancy and availability (FAST Search Server 2010 for SharePoint)
deployment.xml reference