Endeca Server Stats Test

This test continuously monitors the target Endeca server, reports the time taken for processing admin, config, and user's search queries, and promptly alerts administrators to performance lags in terms of latencies, if any. In addition, this test also reports the time taken for result serialization, reading the request, writing the response, retrieving and storing documents, etc. These metrics help administrators to identify where exactly the processing is delayed and troubleshoot the bottleneck condition at the earliest.

Target of the test : An Endeca Search Application

Agent deploying the test : An internal agent

Outputs of the test : One set of results the Endeca search application being monitored.

Configurable parameters for the test
Parameter	Description
Test period	How often should the test be executed
Host	The IP address of the host for which this test is to be configured.
Port	The port at which the specified host listens to. The default port is 15000.
PerfStatURL	Specify the URL to access the page from which this test will be collecting the required statistics. The default URL will be in the format: http://{Endeca_Server_IP}:8000/admin?op=stats
Show Most Expensive Queries	To show the most expensive queries set this flag to Yes, or else, set the flag to No. Enable or Disable the Detailed diagnosis to show most expensive queries.
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.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Total request time	Indicates the total amount of time taken for reading the request and sending the result.	Seconds	A low value is desired for this measure.
Reading request time	Indicates the time taken to read the request.	Seconds	Ideally, the value for this measure should be low. A high value for this measure can cause performance degradation in terms of latency.
Time in scheduler	Indicates the time query spend in the scheduler.	Seconds
Time writing response	Indicates the time spend for writing the response.	Seconds	The value of this measure should be low.
Request data read	Indicates the size of the request read data.	KB
Response size	Indicates the size of the response.	KB
Query queue time before processing	Indicates the time the query spend in queue before processing.	Seconds	A low value is desired for this measure. If the queries have a higher queuing time it indicates high resource usage that can cause performance lag.
Query processing time	Indicates the time taken to process the query.	Seconds	Ideally, the value for this measure should be low. A high value indicates an increase in the query processing time that can cause performance degradation in terms of latency. The detailed diagnosis of this measure lists the Rank, Computation time(seconds) and URL.
Query queue time after processing	Indicates the time the query spend in queue after processing.	Seconds
Admin queue time before processing	Indicates the time the admin query spend in queue before processing.	Seconds	Ideally, the value for this measure should be low.
Admin processing time	Indicates the time taken to process the admin query.	Seconds	Ideally, the value of this measure should be low.
Admin queue time after processing	Indicates the time which the admin query spend in queue after processing.	Seconds
Config queue time before processing	Indicates the time the config query spend in queue before processing.	Seconds	The value for this measure should be low.
Config processing time	Indicates the time taken to process the config query.	Seconds	The value for this measure should be low.
Config queue time after processing	Indicates the time which the config query spend in queue after processing.	Seconds
Queries queued	Indicates the number of queries in the queue.	Number	The value for this measure should be low. A high value indicates longer processing time.
Queries in process	Indicates the number of queries which is in process.	Number
Total time in XQuery engine	Indicates the time taken to process query in Xquery.	Seconds	Ideally, the value for this measure should be low.
Total time in XQuery external functions	Indicates the time taken to process external function of Xquery.	Seconds	The Endeca XQuery implementation contains numerous external functions for use by application queries. These external functions add Endeca-specific features to the Endeca XQuery implementation. External functions are not implemented using XQuery syntax, nor are they defined by the XQuery specification. For this reason, a query must include declarations of the external functions it uses, either directly or by importing the library modules that contain the declarations of these functions.
Time in retrieving documents	Indicates the time taken to retrieve the documents.	Seconds	A low value is desired for this measure.
Time in storing documents	Indicates the time taken to store the documents.	Seconds	A low value is desired for this measure.
Result serialization time	Indicates the time taken for result serialization.	Seconds