Solr Query Test

Apache Solr is open-sourc e search engine based on Apache Lucene libraby. olr has RESTful XML/HTTP and JSON APIs and client libraries for many programming languages such as Java, Phyton, Ruby, C#, PHP, and many more being used to build search-based and big data analytics applications for websites, databases, files, etc. Solr takes in structured, semi-structured, and unstructured data from various sources, stores and indexes it, and makes it available for search in near real-time. The standard way of searching data via Solr is through queries. These queries are parsed and executed over a large datasets to return relevant results for clients. Given that query capability is at the heart of Solr, it is important for administrators to keep an eye on query performance so that any issues can be handled and fixed in timely manner.

Solr query test monitors the query requests to the Solr servers and produces key statistics around query efficiency and performance like number of errors, number of requests etc.

Target of the test : Apache Solr

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for each Query request handler in each Solr core in Solr setup.

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 target Apache Solr server listens to.
Username & Password	If JMX requires authentication only (but no security), then ensure that the user and password parameters are configured with the credentials of a user with read-write access to JMX.
Confirm Password	Confirm the password by retyping it in this box.
SSL	By default, SSL is disabled for Apache Solr, accordingly SSL flag is set to No by default. If the flag is set to Yes, the eG Agent will start communicating with Apache Solr server HTTPS.
Timeout	By default timeout is 5 secods.
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
Error	Indicates the number of errors encountered by handler.	Number	Ideally the value of this measure should be 0.
Client errors	Indicates the number of syntax or parse errors made by the client while making the request.	Number	Although can't do much about the client errors but you can take a look at errors reported just to ensure that they are informative enough.
Server errors	Indicates the number of errors reported by the server while executing the request.	Number	The server errors should be investigated if they are because of missing documents or if because one of the components is malfunctioning.
Requests	Indicates the number of query requets made by the client.	Number	It should be noted that all the requests are being replicated across the slave servers.
Timeout counts	Indicates the number of times when the response was received with partial results.	Number	Again it needs t be investigated if timeout happened because of lack of compute resources or cache unavailability etc.
Handler Start	Indicates the time it took for replication handler to be registered and started.	Minutes	The request handler for replication should start immediately as soon as data is updated on Solr server, if the delay is more than tolerance limit, you may need to investigate the same.