[SOLR-15397] Expose zookeeper status in the exporter - ASF JIRA

XML

Word

Printable

JSON

Details

Type: New Feature
Status: Closed
Priority: Major
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 8.9
Component/s: contrib - prometheus-exporter
Labels:
None

Description

This issue will add these prometheus metrics to solr exporter: solr_zookeeper_ensemble_size, solr_zookeeper_nodestatus, solr_zookeeper_status

# HELP solr_zookeeper_nodestatus See following URL: https://solr.apache.org/guide/cloud-screens.html#zk-status-view
# TYPE solr_zookeeper_nodestatus gauge
solr_zookeeper_nodestatus{host="zoo1:2181",zk_host="zoo1:2181,zoo2:2181,zoo3:2181",} 1.0
solr_zookeeper_nodestatus{host="zoo2:2181",zk_host="zoo1:2181,zoo2:2181,zoo3:2181",} 1.0
solr_zookeeper_nodestatus{host="zoo3:2181",zk_host="zoo1:2181,zoo2:2181,zoo3:2181",} 0.0

# HELP solr_zookeeper_status See following URL: https://solr.apache.org/guide/cloud-screens.html#zk-status-view
# TYPE solr_zookeeper_status gauge
solr_zookeeper_status{status="yellow",zk_host="zoo1:2181,zoo2:2181,zoo3:2181",} 0.0

# HELP solr_zookeeper_ensemble_size See following URL: https://solr.apache.org/guide/cloud-screens.html#zk-status-view
# TYPE solr_zookeeper_ensemble_size gauge
solr_zookeeper_ensemble_size{mode="ensemble",zk_host="zoo1:2181,zoo2:2181,zoo3:2181",} 3.0

The data is fetched and parsed from Solr's /admin/zookeeper/status endpoint. Can be used for alerting on earlier ZK versions that do not natively support prometheus, or if you don't want to setup separate ZK monitoring. Example Grafana dashboard tile:

I plan to add this to the new solr cluster row next to the solr live-nodes graph: