Trex Indices Test

The index server indexes and classifies documents and answers search queries. The processing takes place in the engines that belong to the index server. There are the following engines:

  • Search engine: This engine is responsible for standard search functions such as the exact, error-tolerant, linguistic, Boolean, and phrase searches.
  • Text-mining engine: This engine is responsible for classification, searching for similar documents (‘See Also’ search), the extraction of key words, and so on.
  • Attribute engine: This engine is responsible for searching for document attributes such as author, creation date, and change date.

This test auto-discovers the indices available in the SAP TREX server and reports the current status of each index. In addition, this test helps administrators figure out the effectiveness of each index.

Target of the test : A SAP TREX

Agent deploying the test : An internal agent

Outputs of the test : One set of results for each Index type:Index of the target SAP TREX server that is to be monitored

Configurable parameters for the test
  1. TEST PERIOD - How often should the test be executed
  2. Host – The host for which the test is to be configured.
  3. PORT - Specify the port at which the specified HOST listens.
  4. TREX DIRECTORY - Specify the full path to the SAP TREX instance that is to be monitored for e.g., the location can be specified as D:\usr\sap\TRX\TRX01.
  5. TIMEOUT - Specify the duration (in seconds) beyond which this test should time out in the TIMEOUT text box. The default is 120 seconds.
  6. INCLUDE INDICES - Specify a comma-separated list of indices that should be included in the scope of monitoring. By default, none is specified in this text box. Alternately, if you wish to monitor indices of a similar pattern, then you can specify such patterns in this list.
  7. EXCLUDE INDICES - Specify a comma-separated list of indices that should be excluded in the scope of monitoring. By default, none is specified in this text box. Alternately, if you wish to monitor indices of a similar pattern, then you can specify such patterns in this list.
  8. SEARCHABLE DOCS CUTOFF - By default, when an index is queried, the number of searchable documents associated with the index can be figured out by the administrator. Mostly, administrators may be interested to monitor only the indices that are associated with a large number of searchable documents. Also, in environments where huge volume of indices are to be monitored, the performance overhead of the eG agent may increase considerably. Therefore, to cater to the needs of such administrators and to reduce the performance overhead of the eG agent, it is necessary to provide a cutoff value to the number of searchable documents associated with the indices that are to be monitored. By providing this cutoff value, the indices with the number of searchable documents with less than the cutoff limit would be excluded from the scope of monitoring of this test. By default, this cutoff limit is set to 100. If you have specified the indices to be monitored in the INCLUDE INDICES parameter, then this parameter would be void.
  9. DETAILED DIAGNOSIS - To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

    The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

    • The eG manager license should allow the detailed diagnosis capability
    • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measures made by the test:
Measurement Description Measurement Unit Interpretation

Status:

Indicates the current status of this index.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value

Numeric Value

Idle

0

Indexing

1

Preparing

2

Committing

3

Rolling back

4

Merging

5

Corrupt

6

Setting sparse

7

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the current status of this index. The graph of this measure however, represents the status of a server using the numeric equivalents only - 0 to 7.

Search engine memory:

Indicates the memory used by the search engine to process the search queries from this index.

KB

 

Attribute engine memory:

Indicates the memory used by the attribute engine to search for document attributes from this index.

KB

 

Text mining memory:

Indicates the memory used by the text mining engine to search for key words in this index.

KB

 

Total memory:

Indicates the total memory used by this index.

KB

 

Search engine disc size:

Indicates the amount of disk space used by the search engine to process search queries from this index.

KB

 

Attribute engine disc size:

Indicates the amount of disk space used by the attribute engine to search for document attributes from this index.

KB

 

Text mining disc size:

Indicates the amount of disk space used by the text mining engine to search for key words in this index.

KB

 

Total disc size:

Indicates the amount of disk space used by this index.

KB

 

Updated documents:

Indicates the number of documents that were updated for this index.

Number

 

Deleted documents:

Indicates the number of documents that were deleted for this index.

Number

 

Optimized documents:

Indicates the number of documents that were optimized for this index.

Number

A low value is desired for this measure. If too many documents are optimized i.e., if the index server performs frequent optimization, then the index server also rewrites the index frequently affecting the performance of the index.

Invalidated documents:

Indicates the number of documents that were invalidated for this index.

Number

 

Total indexed documents:

Indicates the total number of documents indexed for this index.

Number