Solr Performance Monitoring - SearchStax


Overview

SearchStax® provides real-time and historical statistical graphs of critical Solr server and JVM metrics and statistics. These statistics provide a birds-eye view of Solr cluster health, enabling you to tune server performance. This can be crucial when performing Solr shard management and setting up your collections for best performance.

Contents of this page:

Cloud Manager Health Display

The Cloud Manager list of active deployments contains a "Health" column that reflects the overall health of the deployment's servers.

SearchStax Health Display

The health status indicators have the following meanings:

Indicator Description
OK All servers are running.
Warn At least one server is down. At least one server is still up.
Error All servers are down.

To investigate further, click the name of the deployment. This leads to the Deployment Details page where individual servers may be inspected.

How to Access the Pulse Graphs

You can access the graphs from the SearchStax Dashboard.

To access the graphs:

  1. From the SearchStax Dashboard, click on Cloud Manager.
  2. Select a Deployment for which you would like to view performance history. This exposes the deployment's details page.
  3. In the navigation pane on the left, select Pulse. Multiple pages of graphs may be accessed from the horizontal menu bar at the top of the display.

SearchStax Pulse Monitoring

Note that you can compare multiple deployments on this page by using the checklist of available deployments in the upper right.

SearchStax Pulse Deployments

Pulse offers several pages of diagnostic displays, accessible through the menu bar at the top of the screen. These are:

Menu Description
CPU, Memory, JVM Shows server-related metrics
Collections List of collections in this deployment
Garbage Collection Garbage-collection metrics for Solr cluster
Throughput, Latency Search and indexing performance for the Solr cluster
Caches Cache-performance metrics for the Solr cluster
Alerts See Solr Service Alerting to manage alerts.

Click on any menu to view the associated graphs.

About the Graphs

SearchStax currently provides graphs for the following server and search metrics.

CPU, Memory, JVM

Screenshot

The following server-performance metrics are reported by SearchStax:

Metric Definition
System Load Average Average load on the system over time.
Memory Total memory size and used memory size plotted on a single graph.
Thread Count Server thread count usage over time.
Swap Total disc swap space available and used over time.
Heap Memory Heap memory usage over time. Heap memory is used for storing Java objects.
Non-Heap Memory Non-heap memory usage over time. Non-heap memory is used by Java to store loaded classes and other metadata.

Collections

The Collections table shows the distribution of collections and shards across servers.

Garbage Collection

Screenshot

The following garbage-collection metrics are reported by SearchStax:

Metric Definition
ConcurrentMarkSweep CollectionTime & CollectionCount Collection time and count for the ConcurrentMarkSweep approach.
ParNew CollectionTime & CollectionCount Collection time and count for the ParNew approach.

Search Throughput and Latency

Screenshot

SearchStax provides graphs that report on throughput and latency.

Metric Definition
Average Requests/second (ms) Reports average search requests per second.
Average Time/Request (ms) Reports average time for search request to fulfill the query.
5-minute Request Rate Reports search-request rate over a 5-minute interval.
15-minute Request Rate Reports search-request rate over 15-minute interval.
Timeouts Reports server timeouts, where the server did not respond to the request fast enough.
Errors Numbers of search-request errors.

Indexing Throughput and Latency

ScreenshotScreenshot

SearchStax provides graphs that report on throughput and latency.

Metric Definition
Average Requests/Second Reports average indexing requests per second.
Average Time/Request (ms) Reports average time for indexing request to fulfill the query.
Timeouts Reports server timeouts, where the server did not respond to the request fast enough.
Errors Numbers of indexing request errors.
Update Handler graphs Reports various Update Handler metrics over a period of time, such as commits, autoCommits, deletesById, etc.

Caches

ScreenshotScreenshot

SearchStax provides graphs that report on Caches.

Metric Definition
QueryResultCache This cache stores ordered sets of document IDs — the top N results of a query ordered by some criterion. Multiple metrics report how the query result cache is being utilized to fulfill search requests. Metrics include hitratio, evictions, warmup time, etc.
FilterCache This cache stores unordered sets of document IDs that match the queries. Multiple metrics report how the filter cache is being utilized to fulfill search requests. Metrics include itratio, evictions, warmup time, etc.
DocumentCache The documentCache stores Lucene Document objects that have been fetched from disk. Multiple metrics report how the document cache is being utilized. Metrics include itratio, evictions, warmup time, etc.
FieldValueCache The fieldValueCache is similar to fieldCache, and supports multiple values per document. It is primarily used for faceting. Metrics include warmup time, size.

Alerting

The SearchStax alerting features are described on the Solr Service Alerting page.

Questions?

Do not hesitate to contact the SearchStax Support Desk.