SOLR plugin

This plugin collects metrics from Apache SOLR using Rest API from Solr Admin server.


Meter 4.5.0-778 or later must be installed.

The Apache Solr plugin 4.5 or later supports the following Operating Systems.


To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

HostSOLR hostname default:localhost
PortSOLR Admin port number default: 8983
Core NameThe Solr core(s) that need to be monitored
Source NameSource name which will be displayed as source identifier
Poll IntervalThe frequency (in milliseconds) used to poll the SOLR for metrics.

Advanced configuration

To customize this plugin, see Solr meter plugin on GitHub.

Plugin metrics

Metric NameDescription
SOLR_SYSTEM_COMMITED_VIRTUAL_MEMORY_SIZETotal commited memory on the system reported by SOLR service
SOLR_SYSTEM_FREE_PHYSICAL_MEMORY_SIZEAmount of free memory on the system reported by SOLR service
SOLR_SYSTEM_PROCESS_CPU_TIMECPU time on the system used by SOLR
SOLR_SYSTEM_OPEN_FILE_DESCRIPTOR_COUNTTotal amount of file descriptors open in the system
SOLR_SYSTEM_MAX_FILE_DESCRIPTOR_COUNTTotal amount of allowed file descriptors in the system
SOLR_JVM_UPTIMENumber of processors used by SOLR
SOLR_JVM_MEMORY_FREEAmount of free memory in the JVM stack used by SOLR
SOLR_JVM_MEMORY_TOTALThe total amount of allocated JVM memory size
SOLR_JVM_MEMORY_MAXTotal amount of JVM memory used by SOLR since the last startup
SOLR_JVM_MEMORY_USEDTotal amount of JVM memory currently in use
SOLR_THREAD_CURRENTNumber of threads running to serv requests arriving to SOLR
SOLR_THREAD_PEAKThe maximum number of threads in running state since the last startup
SOLR_THREAD_DAEMONThe number of running threads used by the SOLR daemon
SOLR_CACHE_DOCUMENT_LOOKUPSTotal amount of lookups in the document cache
SOLR_CACHE_DOCUMENT_HITSTotal amount of document cache hits
SOLR_CACHE_DOCUMENT_HITRATIOThe percentage of hits in the document cache
SOLR_CACHE_DOCUMENT_INSERTSTotal amount of inserts in the document cache
SOLR_CACHE_DOCUMENT_SIZEThe size of the document cache
SOLR_CACHE_DOCUMENT_EVICTIONSTotal amount of evictions in the document cache
SOLR_CACHE_DOCUMENT_WARMUPTIMEThe time needed (seconds) to warm up the document cache
Was this page helpful? Yes No Submitting... Thank you