SOLR plugin
This plugin
collects metrics from Apache SOLR using Rest API from Solr Admin server.
Prerequisites
Meter 4.5.0-778 or later must be installed.
The Apache Solr plugin 4.5 or later supports the following Operating Systems.
Linux | ✅️ |
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click
> Data Collection, select the TrueSight meter, and select the Sources tab. - Click > Configure Sources.
- Click
- 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.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
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
Field | Description |
|---|---|
Host | SOLR hostname default:localhost |
Port | SOLR Admin port number default: 8983 |
Core Name | The Solr core(s) that need to be monitored |
Source Name | Source name which will be displayed as source identifier |
Poll Interval | The frequency (in milliseconds) used to poll the SOLR for metrics. |
Plugin metrics
Metric Name | Description |
|---|---|
SOLR_SYSTEM_COMMITED_VIRTUAL_MEMORY_SIZE | Total commited memory on the system reported by SOLR service |
SOLR_SYSTEM_FREE_PHYSICAL_MEMORY_SIZE | Amount of free memory on the system reported by SOLR service |
SOLR_SYSTEM_PROCESS_CPU_TIME | CPU time on the system used by SOLR |
SOLR_SYSTEM_OPEN_FILE_DESCRIPTOR_COUNT | Total amount of file descriptors open in the system |
SOLR_SYSTEM_MAX_FILE_DESCRIPTOR_COUNT | Total amount of allowed file descriptors in the system |
SOLR_JVM_UPTIME | Number of processors used by SOLR |
SOLR_JVM_MEMORY_FREE | Amount of free memory in the JVM stack used by SOLR |
SOLR_JVM_MEMORY_TOTAL | The total amount of allocated JVM memory size |
SOLR_JVM_MEMORY_MAX | Total amount of JVM memory used by SOLR since the last startup |
SOLR_JVM_MEMORY_USED | Total amount of JVM memory currently in use |
SOLR_THREAD_CURRENT | Number of threads running to serv requests arriving to SOLR |
SOLR_THREAD_PEAK | The maximum number of threads in running state since the last startup |
SOLR_THREAD_DAEMON | The number of running threads used by the SOLR daemon |
SOLR_CACHE_DOCUMENT_LOOKUPS | Total amount of lookups in the document cache |
SOLR_CACHE_DOCUMENT_HITS | Total amount of document cache hits |
SOLR_CACHE_DOCUMENT_HITRATIO | The percentage of hits in the document cache |
SOLR_CACHE_DOCUMENT_INSERTS | Total amount of inserts in the document cache |
SOLR_CACHE_DOCUMENT_SIZE | The size of the document cache |
SOLR_CACHE_DOCUMENT_EVICTIONS | Total amount of evictions in the document cache |
SOLR_CACHE_DOCUMENT_WARMUPTIME | The time needed (seconds) to warm up the document cache |