Solr's Administration page (found by default at
), provides a section with menu items for monitoring indexing and performance statistics, information about index distribution and replication, and information on all threads running in the JVM at the time. There is also a section where you can run queries, and an assistance area.
In addition, SolrCloud provides its own administration page (found at http://localhost:8983/solr/#/~cloud), as well as a few tools available via a ZooKeeper Command Line Utility (CLI). The CLI scripts found in
server/scripts/cloud-scripts let you upload configuration information to ZooKeeper, in the same two ways that were shown in the examples in Parameter Reference. It also provides a few other commands that let you link collection sets to collections, make ZooKeeper paths or clear them, and download configurations from ZooKeeper to the local filesystem.
zkcli.sh provided by Solr is not the same as the
zkCli.sh included in ZooKeeper distributions.
zkCli.sh provides a completely general, application-agnostic shell for manipulating data in ZooKeeper. Solr's
zkcli.sh – discussed in this section – is specific to Solr, and has command line arguments specific to dealing with Solr data in ZooKeeper.
Many of the functions provided by the zkCli.sh script are also provided by the Solr Control Script Reference, which may be more familiar as the start script ZooKeeper maintenance commands are very similar to Unix commands.
Using Solr's ZooKeeper CLI
zkcli.sh (for Unix environments) and
zkcli.bat (for Windows environments) support the following command line options:
CLI Command to be executed:
ZooKeeper host address. This parameter is mandatory for all CLI commands.
Display help text.
Run ZooKeeper internally by passing the Solr run port; only for clusters on one machine.
The short form parameter options may be specified with a single dash (eg:
The long form parameter options may be specified using either a single dash (eg:
-collection mycollection) or a double dash (eg:
ZooKeeper CLI Examples
Below are some examples of using the
zkcli.sh CLI which assume you have already started the SolrCloud example (
bin/solr -e cloud -noprompt)
If you are on Windows machine, simply replace
zkcli.bat in these examples.
Upload a configuration directory
Bootstrap ZooKeeper from existing SOLR_HOME
Using the boostrap command with a zookeeper chroot in the -zkhost parameter, e.g.
-zkhost 127.0.0.1:2181/solr, will automatically create the chroot path before uploading the configs.
Put arbitrary data into a new ZooKeeper file
Put a local file into a new ZooKeeper file
Link a collection to a configuration set
Create a new ZooKeeper path
This can be useful to create a chroot path in ZooKeeper before first cluster start.
Set a cluster property
This command will add or modify a single cluster property in
/clusterprops.json. Use this command instead of the usual getfile -> edit -> putfile cycle. Unlike the CLUSTERPROP REST API, this command does not require a running Solr cluster.