Apache Solr

Supported Versions

Currently supported versions are Apache Solr 4.0 or newer.

Configuration

To collect data, JMX module needs to be enabled in Solr:

  • Add <jmx /> to <SOLR_HOME>/server/solr/configsets/basic_configs/conf/solrconfig.xml
  • Set ENABLE_REMOTE_JMX_OPTS="true" in <SOLR_HOME>/bin/solr.in.sh.

Metrics collection

Configuration data

  • Port
  • Version
  • Cores

    • Name
    • Version
    • Start Time

Performance Metrics (per core)

Metric Description
Average request time Average time for request processing
Requests Number of requests
Cache Lookups Number of cache lookups
Cache Hit Rate Cache hit percentage
Inserts Number of inserts
Evictions Number of evictions
Errors Number of server errors
Timeouts Number of timeouts
Documents Added Number of added documents
Documents Pending Number of pending documents (to be processed)

Note: In order to see these metrics you need to have cores defined.

Health Signatures

For each sensor, there is a curated knowledgebase of health signatures that are evaluated continuously against the incoming metrics and are used to raise issues or incidents depending on user impact.

Built-in events trigger issues or incidents based on failing health signatures on entities, and custom events trigger issues or incidents based on the thresholds of an individual metric of any given entity.

For information about built-events for Solr Node, see the Built-in events reference.

Cloud

Tracked Configuration

  • Cluster name
  • Nodes/Number of nodes
  • Shards/Number of shards

Metrics

Metric Description
Average request time Average time for request processing
Requests Number of requests
Cache Lookups Number of cache lookups
Cache Hit Rate Cache hit percentage
Inserts Number of inserts
Evictions Number of evictions
Errors Number of server errors
Timeouts Number of timeouts
Documents Added Number of added documents
Documents Pending Number of pending documents (to be processed)

Health Signatures

For information about built-events for Solr Cloud, see the Built-in events reference.