OS Manuals

/usr/share/java/solr/prometheus-exporter/bin/solr-exporter

Solr modules, cross-dc-manager and prometheus-exporter

From solr-9-full 9.11.0-r3 (enterprise-packages), captured 2026-11-08 by running solr-exporter --help (exit 0). permalink

Also provided by 1 other package version
usage: bin/solr-exporter [-b <BASE_URL>] [--cluster-id <CLUSTER_ID>]
       [--config-file <CONFIG>] [-f <CONFIG>] [-h] [-n <NUM_THREADS>]
       [--num-threads <NUM_THREADS>] [-p <PORT>] [-s <SCRAPE_INTERVAL>]
       [--scrape-interval <SCRAPE_INTERVAL>] [-ssl] [-u <CREDENTIALS>] [-z
       <ZK_HOST>]
Prometheus exporter for Apache Solr.
 -b,--base-url <BASE_URL>                 Specify the Solr base URL when
                                          connecting to Solr in standalone
                                          mode. If omitted both the -b
                                          parameter and the -z parameter,
                                          connect to
                                          http://localhost:8983.
    --cluster-id <CLUSTER_ID>             Specify a unique identifier for
                                          the cluster, which can be used
                                          to select between multiple
                                          clusters in Grafana. By default
                                          this ID will be equal to a hash
                                          of the -b or -z argument
    --config-file <CONFIG>                Specify the configuration file;
                                          the default is
                                          solr-exporter-config.xml.
 -f <CONFIG>                              Specify the configuration file;
                                          the default is
                                          solr-exporter-config.xml.
 -h,--help                                Prints this help message.
 -n <NUM_THREADS>                         Specify the number of threads.
                                          solr-exporter creates a thread
                                          pools for request to Solr. If
                                          you need to improve request
                                          latency via solr-exporter, you
                                          can increase the number of
                                          threads; the default is 1.
    --num-threads <NUM_THREADS>           Specify the number of threads.
                                          solr-exporter creates a thread
                                          pools for request to Solr. If
                                          you need to improve request
                                          latency via solr-exporter, you
                                          can increase the number of
                                          threads; the default is 1.
 -p,--port <PORT>                         Specify the solr-exporter HTTP
                                          listen port; default is 8989.
 -s <SCRAPE_INTERVAL>                     Specify the delay between
                                          scraping Solr metrics; the
                                          default is 60 seconds.
    --scrape-interval <SCRAPE_INTERVAL>   Specify the delay between
                                          scraping Solr metrics; the
                                          default is 60 seconds.
 -ssl,--ssl-enabled                       Enable TLS connection to Solr.
                                          Expects following env variables:
                                          SOLR_SSL_KEY_STORE,
                                          SOLR_SSL_KEY_STORE_PASSWORD,
                                          SOLR_SSL_TRUST_STORE,
                                          SOLR_SSL_TRUST_STORE_PASSWORD.
                                          Example: --ssl-enabled
 -u,--credentials <CREDENTIALS>           Specify the credentials in the
                                          format username:password.
                                          Example: --credentials
                                          solr:SolrRocks
 -z,--zk-host <ZK_HOST>                   Specify the ZooKeeper connection
                                          string when connecting to Solr
                                          in SolrCloud mode. If omitted
                                          both the -b parameter and the -z
                                          parameter, connect to
                                          http://localhost:8983.
Options (13)
OptionDescriptionSource
-b, --base-url BASE_URLSpecify the Solr base URL when connecting to Solr in standalone mode.help
--cluster-id CLUSTER_IDSpecify a unique identifier for the cluster, which can be used to select between multiple clusters in Grafana.help
--config-file CONFIGSpecify the configuration file;help
-f CONFIGSpecify the configuration file;help
-h, --helpPrints this help message.help
-n NUM_THREADSSpecify the number of threads.help
--num-threads NUM_THREADSSpecify the number of threads.help
-p, --port PORTSpecify the solr-exporter HTTP listen port;help
-s SCRAPE_INTERVALSpecify the delay between scraping Solr metrics;help
--scrape-interval SCRAPE_INTERVALSpecify the delay between scraping Solr metrics;help
-ssl, --ssl-enabledEnable TLS connection to Solr.help
-u, --credentials CREDENTIALSSpecify the credentials in the format username:password.help
-z, --zk-host ZK_HOSTSpecify the ZooKeeper connection string when connecting to Solr in SolrCloud mode.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.