Extend the platform,
empower your team.
Open-source enterprise-search platform, written in Java.
ExtensionMonitor your Apache Solr deployments with Dynatrace. Get metrics on documents, requests and caches for your Solr cores.
Install the agent on your Apache Solr hosts and create an extension monitoring configuration to get started.
This extension relies on JMX metrics collected through the OneAgent and as such requires the OneAgent to be deployed on the Solr hosts. Once that is done, a monitoring configuration for this extension needs to be created for these hosts.
This extension comes with two feature sets, solrcloud
and solrusermanaged
, designed to work with SolrCloud or Solr User Managed deployments, respectively (see relevant Solr documentation).
The two feature sets collect essentially the same metrics, the main difference being the topology created.
Currently, the only entity types created will be SolrCloud Replica
, for SolrCloud deployments and Solr User-Managed Core
for Solr User Managed deployments.
This extension retrieves Apache Solr metrics through the JMX framework, using the mBeans that are created by default by Solr. If you don't see any metrics, or are missing some metrics, ensure that your deployment is exposing mBeans of the following types:
solr:category=UPDATE
solr:category=SEARCHER
solr:category=CACHE
solr:name=requests
The metrics and events collected through this extension consume Dynatrace Davis Data Units (see DDUs for metrics) or metric data points depending on your licensing model.
A general formula to estimate the number of metrics would be 26 × solr cores
.
From there it follows that DDU consumption can be estimated by 13665 × solr cores (DDU per year)
.
Apache Solr 8.x, 9.x.
Although this extension should also work with Solr 7.x, please note that this version of Apache Solr is EOL and thus we cannot guarantee support for this version going forward.
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
Metric name | Metric key | Description | Unit |
---|---|---|---|
Solr metadata coreName | solr.solrcloud.metadata.coreName | Placeholder metric to extract metadata | Count |
Solr metadata replicaState | solr.solrcloud.metadata.replicaState | Placeholder metric to extract metadata | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
Solr searcher deleted documents (User Managed) | solr.solrusermanaged.searcher.deletedDocs | Solr searcher deleted documents (User Managed) | Count |
Solr searcher max documents (User Managed) | solr.solrusermanaged.searcher.maxDoc | Solr searcher max documents (User Managed) | Count |
Solr searcher current documents (User Managed) | solr.solrusermanaged.searcher.numDocs | Solr searcher current documents (User Managed) | Count |
Solr number of additions (User Managed) | solr.solrusermanaged.update.adds.count | Solr number of additions (User Managed) | Count |
Solr number of deletes by ID (User Managed) | solr.solrusermanaged.update.deletesById.count | Solr number of deletes by ID (User Managed) | Count |
Solr number of deletes by query (User Managed) | solr.solrusermanaged.update.deletesByQuery.count | Solr number of deletes by query (User Managed) | Count |
Solr number of update errors (User Managed) | solr.solrusermanaged.update.errors.count | Solr number of update errors (User Managed) | Count |
Solr number of requests (User Managed) | solr.solrusermanaged.select.requests.count | Solr number of requests (User Managed) | Count |
Solr document cache evictions (User Managed) | solr.solrusermanaged.documentCache.evictions.count | Solr document cache evictions (User Managed) | Count |
Solr document cache hits (User Managed) | solr.solrusermanaged.documentCache.hits.count | Solr document cache hits (User Managed) | Count |
Solr document cache inserts (User Managed) | solr.solrusermanaged.documentCache.inserts.count | Solr document cache inserts (User Managed) | Count |
Solr document cache lookups (User Managed) | solr.solrusermanaged.documentCache.lookups.count | Solr document cache lookups (User Managed) | Count |
Solr query result cache evictions (User Managed) | solr.solrusermanaged.queryResultCache.evictions.count | Solr query result cache evictions (User Managed) | Count |
Solr query result cache hits (User Managed) | solr.solrusermanaged.queryResultCache.hits.count | Solr query result cache hits (User Managed) | Count |
Solr query result cache inserts (User Managed) | solr.solrusermanaged.queryResultCache.inserts.count | Solr query result cache inserts (User Managed) | Count |
Solr query result cache lookups (User Managed) | solr.solrusermanaged.queryResultCache.lookups.count | Solr query result cache lookups (User Managed) | Count |
Solr filter cache evictions (User Managed) | solr.solrusermanaged.filterCache.evictions.count | Solr filter cache evictions (User Managed) | Count |
Solr filter cache hits (User Managed) | solr.solrusermanaged.filterCache.hits.count | Solr filter cache hits (User Managed) | Count |
Solr filter cache inserts (User Managed) | solr.solrusermanaged.filterCache.inserts.count | Solr filter cache inserts (User Managed) | Count |
Solr filter cache lookups (User Managed) | solr.solrusermanaged.filterCache.lookups.count | Solr filter cache lookups (User Managed) | Count |
Solr field cache evictions (User Managed) | solr.solrusermanaged.fieldValueCache.evictions.count | Solr field cache evictions (User Managed) | Count |
Solr field cache hits (User Managed) | solr.solrusermanaged.fieldValueCache.hits.count | Solr field cache hits (User Managed) | Count |
Solr field cache inserts (User Managed) | solr.solrusermanaged.fieldValueCache.inserts.count | Solr field cache inserts (User Managed) | Count |
Solr field cache lookups (User Managed) | solr.solrusermanaged.fieldValueCache.lookups.count | Solr field cache lookups (User Managed) | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
Solr searcher deleted documents | solr.solrcloud.searcher.deletedDocs | Solr searcher deleted documents | Count |
Solr searcher max documents | solr.solrcloud.searcher.maxDoc | Solr searcher max documents | Count |
Solr searcher current documents | solr.solrcloud.searcher.numDocs | Solr searcher current documents | Count |
Solr number of additions | solr.solrcloud.update.adds.count | Solr number of additions | Count |
Solr number of deletes by ID | solr.solrcloud.update.deletesById.count | Solr number of deletes by ID | Count |
Solr number of deletes by query | solr.solrcloud.update.deletesByQuery.count | Solr number of deletes by query | Count |
Solr number of update errors | solr.solrcloud.update.errors.count | Solr number of update errors | Count |
Solr number of requests | solr.solrcloud.select.requests.count | Solr number of requests | Count |
Solr document cache evictions | solr.solrcloud.documentCache.evictions.count | Solr document cache evictions | Count |
Solr document cache hits | solr.solrcloud.documentCache.hits.count | Solr document cache hits | Count |
Solr document cache inserts | solr.solrcloud.documentCache.inserts.count | Solr document cache inserts | Count |
Solr document cache lookups | solr.solrcloud.documentCache.lookups.count | Solr document cache lookups | Count |
Solr query result cache evictions | solr.solrcloud.queryResultCache.evictions.count | Solr query result cache evictions | Count |
Solr query result cache hits | solr.solrcloud.queryResultCache.hits.count | Solr query result cache hits | Count |
Solr query result cache inserts | solr.solrcloud.queryResultCache.inserts.count | Solr query result cache inserts | Count |
Solr query result cache lookups | solr.solrcloud.queryResultCache.lookups.count | Solr query result cache lookups | Count |
Solr filter cache evictions | solr.solrcloud.filterCache.evictions.count | Solr filter cache evictions | Count |
Solr filter cache hits | solr.solrcloud.filterCache.hits.count | Solr filter cache hits | Count |
Solr filter cache inserts | solr.solrcloud.filterCache.inserts.count | Solr filter cache inserts | Count |
Solr filter cache lookups | solr.solrcloud.filterCache.lookups.count | Solr filter cache lookups | Count |
Solr field cache evictions | solr.solrcloud.fieldValueCache.evictions.count | Solr field cache evictions | Count |
Solr field cache hits | solr.solrcloud.fieldValueCache.hits.count | Solr field cache hits | Count |
Solr field cache inserts | solr.solrcloud.fieldValueCache.inserts.count | Solr field cache inserts | Count |
Solr field cache lookups | solr.solrcloud.fieldValueCache.lookups.count | Solr field cache lookups | Count |
Extensions Framework 2.0 version of the JMX Solr Dynatrace extension