Apache Solr Reference Guide 7.

7 Page 109 of 1426

c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
• To improve parameter consistency in the Collections API, the parameter names fromNode for
the
MOVEREPLICA command and source, target for the REPLACENODE command have been deprecated
and replaced with sourceNode and targetNode instead. The old names will continue to work
for backcompatibility
but they will be removed in Solr 8.
• The unused valType option has been removed from ExternalFileField, if you have this in
your schema
you can safely remove it.
Major Changes in Earlier 6.x Versions
The following summary of changes in earlier 6.x releases highlights significant changes
released between
Solr 6.0 and 6.6 that were listed in earlier versions of this Guide. Mentions of deprecations
are likely
superseded by removal in Solr 7, as noted in the above sections.
Note again that this is not a complete list of all changes that may impact your installation,
so a thorough
review of CHANGES.txt is highly recommended if upgrading from any version earlier than 6.6.
• The Solr contribs map-reduce, morphlines-core and morphlines-cell have been removed.
• JSON Facet API now uses hyper-log-log for numBuckets cardinality calculation and calculates
cardinality
before filtering buckets by any mincount greater than 1.
• If you use historical dates, specifically on or before the year 1582, you should re-index
for better date
handling.
• If you use the JSON Facet API (json.facet) with method=stream, you must now set
sort='index asc' to
get the streaming behavior; otherwise it won’t stream. Reminder: method is a hint that
doesn’t change
defaults of other parameters.
• If you use the JSON Facet API (json.facet) to facet on a numeric field and if you use
mincount=0 or if you
set the prefix, you will now get an error as these options are incompatible with numeric
faceting.
• Solr’s logging verbosity at the INFO level has been greatly reduced, and you may need to
update the log
configs to use the DEBUG level to see all the logging messages you used to see at INFO level
before.
• We are no longer backing up solr.log and solr_gc.log files in date-stamped copies
forever. If you
relied on the solr_log_<date> or solr_gc_log_<date> being in the logs folder that will no
longer be the
case. See the section Configuring Logging for details on how log rotation works as of Solr
6.3.
• The create/deleteCollection methods on MiniSolrCloudCluster have been deprecated. Clients
should
instead use the CollectionAdminRequest API. In addition,
MiniSolrCloudCluster#uploadConfigDir(File, String) has been deprecated in favour of
#uploadConfigSet(Path, String).
• The bin/solr.in.sh (bin/solr.in.cmd on Windows) is now completely commented by default.
Previously, this wasn’t so, which had the effect of masking existing environment variables.
• The _version_ field is no longer indexed and is now defined with indexed=false by
default, because the
field has DocValues enabled.
• The /export handler has been changed so it no longer returns zero (0) for numeric fields
that are not in
the original document. One consequence of this change is that you must be aware that some
tuples will
not have values if there were none in the original document.
• Metrics-related classes in org.apache.solr.util.stats have been removed in favor of the
Dropwizard
metrics library. Any custom plugins using these classes should be changed to use the
equivalent classes
Page 110 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation
from the metrics library. As part of this, the following changes were made to the output of
Overseer
Status API:
◦ The "totalTime" metric has been removed because it is no longer supported.
◦ The metrics "75thPctlRequestTime", "95thPctlRequestTime", "99thPctlRequestTime" and
"999thPctlRequestTime" in Overseer Status API have been renamed to "75thPcRequestTime",
"95thPcRequestTime" and so on for consistency with stats output in other parts of Solr.
◦ The metrics "avgRequestsPerMinute", "5minRateRequestsPerMinute" and
"15minRateRequestsPerMinute" have been replaced by corresponding per-second rates viz.
"avgRequestsPerSecond", "5minRateRequestsPerSecond" and "15minRateRequestsPerSecond" for
consistency with stats output in other parts of Solr.
• A new highlighter named UnifiedHighlighter has been added. You are encouraged to try out
the
UnifiedHighlighter by setting hl.method=unified and report feedback. It’s more
efficient/faster than the
other highlighters, especially compared to the original Highlighter. See
HighlightParams.java for a
listing of highlight parameters annotated with which highlighters use them.
hl.useFastVectorHighlighter is now considered deprecated in lieu of
hl.method=fastVector.
• The maxWarmingSearchers parameter now defaults to 1, and more importantly commits will
now block if
this limit is exceeded instead of throwing an exception (a good thing). Consequently there is
no longer a
risk in overlapping commits. Nonetheless users should continue to avoid excessive committing.
Users
are advised to remove any pre-existing maxWarmingSearchers entries from their
solrconfig.xml files.
• The Complex Phrase query parser now supports leading wildcards. Beware of its possible
heaviness,
users are encouraged to use ReversedWildcardFilter in index time analysis.
• The JMX metric "avgTimePerRequest" (and the corresponding metric in the metrics API for
each handler)
used to be a simple non-decaying average based on total cumulative time and the number of
requests.
The Codahale Metrics implementation applies exponential decay to this value, which heavily
biases the
average towards the last 5 minutes.
• Parallel SQL now uses Apache Calcite as its SQL framework. As part of this change the
default
aggregation mode has been changed to facet rather than map_reduce. There have also been
changes to
the SQL aggregate response and some SQL syntax changes. Consult the Parallel SQL Interface
documentation for full details.
Major Changes from Solr 5 to Solr 6
There are some major changes in Solr 6 to consider before starting to migrate your
configurations and
indexes.
There are many hundreds of changes, so a thorough review of the Solr Upgrade Notes section as
well as the
CHANGES.txt file in your Solr instance will help you plan your migration to Solr 6. This
section attempts to
highlight some of the major changes you should be aware of.
Highlights of New Features in Solr 6
Some of the major improvements in Solr 6 include:
Streaming Expressions
Introduced in Solr 5, Streaming Expressions allow querying Solr and getting results as a
stream of data,
Apache Solr Reference Guide 7.7 Page 111 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
sorted and aggregated as requested.
Several new expression types have been added in Solr 6:
• Parallel expressions using a MapReduce-like shuffling for faster throughput of high-
cardinality fields.
• Daemon expressions to support continuous push or pull streaming.
• Advanced parallel relational algebra like distributed joins, intersections, unions and
complements.
• Publish/Subscribe messaging.
• JDBC connections to pull data from other systems and join with documents in the Solr index.
Parallel SQL Interface
Built on streaming expressions, new in Solr 6 is a Parallel SQL interface to be able to send
SQL queries to
Solr. SQL statements are compiled to streaming expressions on the fly, providing the full
range of
aggregations available to streaming expression requests. A JDBC driver is included, which
allows using SQL
clients and database visualization tools to query your Solr index and import data to other
systems.
Cross Data Center Replication
Replication across data centers is now possible with Cross Data Center Replication. Using an
active-passive
model, a SolrCloud cluster can be replicated to another data center, and monitored with a new
API.
Graph QueryParser
A new graph query parser makes it possible to to graph traversal queries of Directed (Cyclic)
Graphs
modelled using Solr documents.
DocValues
Most non-text field types in the Solr sample configsets now default to using DocValues.
Java 8 Required
The minimum supported version of Java for Solr 6 (and the SolrJ client libraries) is now Java
8.
Index Format Changes
Solr 6 has no support for reading Lucene/Solr 4.x and earlier indexes. Be sure to run the
Lucene
IndexUpgrader included with Solr 5.5 if you might still have old 4x formatted segments in
your index.
Alternatively: fully optimize your index with Solr 5.5 to make sure it consists only of one
up-to-date index
segment.
Managed Schema is now the Default
Solr’s default behavior when a solrconfig.xml does not explicitly define a
<schemaFactory/> is now
dependent on the luceneMatchVersion specified in that solrconfig.xml. When
luceneMatchVersion <
6.0, ClassicIndexSchemaFactory will continue to be used for back compatibility, otherwise
an instance of
ManagedIndexSchemaFactory will be used.
The most notable impacts of this change are:
Page 112 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation
• Existing solrconfig.xml files that are modified to use luceneMatchVersion >= 6.0, but
do not have an
explicitly configured ClassicIndexSchemaFactory, will have their schema.xml file
automatically
upgraded to a managed-schema file.
• Schema modifications via the Schema API will now be enabled by default.
Please review the Schema Factory Definition in SolrConfig section for more details.
Default Similarity Changes
Solr’s default behavior when a Schema does not explicitly define a global <similarity/> is
now dependent
on the luceneMatchVersion specified in the solrconfig.xml. When luceneMatchVersion <
6.0, an
instance of ClassicSimilarityFactory will be used, otherwise an instance of
SchemaSimilarityFactory
will be used. Most notably this change means that users can take advantage of per Field Type
similarity
declarations, without needing to also explicitly declare a global usage of
SchemaSimilarityFactory.
Regardless of whether it is explicitly declared, or used as an implicit global default,
SchemaSimilarityFactory 's implicit behavior when a Field Types do not declare an explicit
<similarity />
has also been changed to depend on the the luceneMatchVersion. When luceneMatchVersion <
6.0, an
instance of ClassicSimilarity will be used, otherwise an instance of BM25Similarity will
be used. A
defaultSimFromFieldType init option may be specified on the SchemaSimilarityFactory
declaration to
change this behavior. Please review the SchemaSimilarityFactory javadocs for more details.
Replica & Shard Delete Command Changes
DELETESHARD and DELETEREPLICA now default to deleting the instance directory, data directory,
and index
directory for any replica they delete. Please review the Collection API documentation for
details on new
request parameters to prevent this behavior if you wish to keep all data on disk when using
these
commands.
facet.date.* Parameters Removed
The facet.date parameter (and associated facet.date.* parameters) that were deprecated in
Solr 3.x have
been removed completely. If you have not yet switched to using the equivalent facet.range
functionality
you must do so now before upgrading.
Apache Solr Reference Guide 7.7 Page 113 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04

Using the Solr Administration User Interface

This section discusses the Solr Administration User Interface ("Admin UI").
The Overview of the Solr Admin UI explains the basic features of the user interface, what’s
on the initial
Admin UI page, and how to configure the interface. In addition, there are pages describing
each screen of
the Admin UI:
• Logging shows recent messages logged by this Solr node and provides a way to change logging
levels
for specific classes.
• Cloud Screens display information about nodes when running in SolrCloud mode.
• Collections / Core Admin explains how to get management information about each core.
• Java Properties shows the Java information about each core.
• Thread Dump lets you see detailed information about each thread, along with state
information.
• Suggestions Screen displays the state of the system with regard to the autoscaling policies
that are in
place.
• Collection-Specific Tools is a section explaining additional screens available for each
collection.
◦ Analysis - lets you analyze the data found in specific fields.
◦ Dataimport - shows you information about the current status of the Data Import Handler.
◦ Documents - provides a simple form allowing you to execute various Solr indexing commands
directly from the browser.
◦ Files - shows the current core configuration files such as solrconfig.xml.
◦ Query - lets you submit a structured query about various elements of a core.
◦ Stream - allows you to submit streaming expressions and see results and parsing
explanations.
◦ Schema Browser - displays schema data in a browser window.
• Core-Specific Tools is a section explaining additional screens available for each named
core.
◦ Ping - lets you ping a named core and determine whether the core is active.
◦ Plugins/Stats - shows statistics for plugins and other installed components.
◦ Replication - shows you the current replication status for the core, and lets you
enable/disable
replication.
◦ Segments Info - Provides a visualization of the underlying Lucene index segments.
Page 114 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation

Overview of the Solr Admin UI

Solr features a Web interface that makes it easy for Solr administrators and programmers to
view Solr
configuration details, run queries and analyze document fields in order to fine-tune a Solr
configuration and
access online documentation and other help.
Dashboard
Accessing the URL http://hostname:8983/solr/ will show the main dashboard, which is
divided into two
parts.
Solr Dashboard
The left-side of the screen is a menu under the Solr logo that provides the navigation
through the screens of
the UI.
The first set of links are for system-level information and configuration and provide access
to Logging,
Collection/Core Administration, and Java Properties, among other things.
At the end of this information is at least one pulldown listing Solr cores configured for
this instance. On
SolrCloud nodes, an additional pulldown list shows all collections in this cluster. Clicking
on a collection or
core name shows secondary menus of information for the specified collection or core, such as
a Schema
Browser, Config Files, Plugins & Statistics, and an ability to perform Queries on indexed
data.
The center of the screen shows the detail of the option selected. This may include a sub-
navigation for the
option or text or graphical representation of the requested data. See the sections in this
guide for each
screen for more details.
Under the covers, the Solr Admin UI re-uses the same HTTP APIs available to all clients to
access Solr-related
Apache Solr Reference Guide 7.7 Page 115 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
data to drive an external interface.

The path to the Solr Admin UI given above is http://hostname:port/solr, which redirects
to http://hostname:port/solr/#/ in the current version. A convenience redirect is also
supported, so simply accessing the Admin UI at http://hostname:port/ will also redirect
to http://hostname:port/solr/#/.
Login Screen
If authentication has been enabled, Solr will present a login screen to unauthenticated users
before allowing
them further access to the Admin UI.
Login Screen
This login screen currently only works with Basic Authentication. See the section Basic
Authentication Plugin
for details on how to configure Solr to use this method of authentication.
If Kerberos is enabled and the user has a valid ticket, the login screen will be skipped.
However, if the user
does not have a valid ticket, they will see a message that they need to obtain a valid ticket
before continuing.
Getting Assistance
At the bottom of each screen of the Admin UI is a set of links that can be used to get more
assistance with
configuring and using Solr.
Assistance icons
Page 116 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation
These icons include the following links.
Link Description
Documentation Navigates to the Apache Solr documentation hosted on
https://lucene.apache.org/solr/.
Issue Tracker Navigates to the JIRA issue tracking server for the Apache Solr project. This
server resides at https://issues.apache.org/jira/browse/SOLR.
IRC Channel Navigates to Solr’s IRC live-chat room: http://webchat.freenode.net/?
channels=#solr.
Community forum Navigates to the Apache Wiki page which has further information about ways to
engage in the Solr User community mailing lists: https://wiki.apache.org/solr/
UsingMailingLists.
Solr Query Syntax Navigates to the section Query Syntax and Parsing in this Reference Guide.
These links cannot be modified without editing the index.html in the server/solr/solr-
webapp directory
that contains the Admin UI files.
Apache Solr Reference Guide 7.7 Page 117 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04

Logging
The Logging page shows recent messages logged by this Solr node.
When you click the link for "Logging", a page similar to the one below will be displayed:
The Main Logging Screen, including an example of an error due to a bad document sent by a
client
While this example shows logged messages for only one core, if you have multiple cores in a
single instance,
they will each be listed, with the level for each.
Selecting a Logging Level
When you select the Level link on the left, you see the hierarchy of classpaths and
classnames for your
instance. A row highlighted in yellow indicates that the class has logging capabilities.
Click on a highlighted
row, and a menu will appear to allow you to change the log level for that class. Characters
in boldface
indicate that the class will not be affected by level changes to root.
Log level selection
For an explanation of the various logging levels, see Configuring Logging.
Page 118 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation

Cloud Screens
When running in SolrCloud mode, a "Cloud" option will appear in the Admin UI between Logging
and
Collections.
This screen provides status information about each collection & node in your cluster, as well
as access to the
low level data being stored in ZooKeeper.

Only Visible When using SolrCloud

The "Cloud" menu option is only available on Solr instances running in SolrCloud mode.
Single node or master/slave replication instances of Solr will not display this option.
Click on the "Cloud" option in the left-hand navigation, and a small sub-menu appears with
options called
"Nodes", "Tree", "Graph" and "Graph (Radial)". The sub-view selected by default is "Graph".
Nodes View
The "Nodes" view shows a list of the hosts and nodes in the cluster along with key
information for each:
"CPU", "Heap", "Disk usage", "Requests", "Collections" and "Replicas".
The example below shows the default "cloud" example with some documents added to the
"gettingstarted"
collection. Details are expanded for node on port 7574, showing more metadata and more
metrics details.
The screen provides links to navigate to nodes, collections and replicas. The table supports
paging and
filtering on host/node names and collection names.
Tree View
The "Tree" view shows a directory structure of the data in ZooKeeper, including cluster wide
information
regarding the live_nodes and overseer status, as well as collection specific information
such as the
state.json, current shard leaders, and configuration files in use. In this example, we see
part of the
state.json definition for the "tlog" collection:
Apache Solr Reference Guide 7.7 Page 119 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
As an aid to debugging, the data shown in the "Tree" view can be exported locally using the
following
command bin/solr zk ls -r /
ZK Status View
The "ZK Status" view gives an overview over the ZooKeeper servers or ensemble used by Solr.
It lists
whether running in standalone or ensemble mode, shows how many zookeepers are configured,
and then
displays a table listing detailed monitoring status for each of the zookeepers, including who
is the leader,
configuration parameters and more.
Page 120 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation

Graph Views
The "Graph" view shows a graph of each collection, the shards that make up those collections,
and the
addresses and type ("NRT", "TLOG" or "PULL") of each replica for each shard.
This example shows a simple cluster. In addition to the 2 shard, 2 replica "gettingstarted"
collection, there is
an additional "tlog" collection consisting of mixed TLOG and PULL replica types.
Apache Solr Reference Guide 7.7 Page 121 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
Tooltips appear when hovering over each replica giving additional information.
The "Graph (Radial)" option provides a different visual view of each node. Using the same
example cluster,
the radial graph view looks like:
Page 122 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation
Apache Solr Reference Guide 7.7 Page 123 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04
Collections / Core Admin
The Collections screen provides some basic functionality for managing your Collections,
powered by the
Collections API.

If you are running a single node Solr instance, you will not see a Collections option in the
left nav menu of the Admin UI.
You will instead see a "Core Admin" screen that supports some comparable Core level
information & manipulation via the CoreAdmin API instead.
The main display of this page provides a list of collections that exist in your cluster.
Clicking on a collection
name provides some basic metadata about how the collection is defined, and its current shards
& replicas,
with options for adding and deleting individual replicas.
The buttons at the top of the screen let you make various collection level changes to your
cluster, from add
new collections or aliases to reloading or deleting a single collection.
Replicas can be deleted by clicking the red "X" next to the replica name.
If the shard is inactive, for example after a SPLITSHARD action, an option to delete the
shard will appear as a
red "X" next to the shard name.
Page 124 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation
Apache Solr Reference Guide 7.7 Page 125 of 1426
c 2019, Apache Software Foundation Guide Version 7.7 - Published: 2019-03-04

Java Properties
The Java Properties screen provides easy access to one of the most essential components of a
topperforming
Solr systems. With the Java Properties screen, you can see all the properties of the JVM
running
Solr, including the class paths, file encodings, JVM memory settings, operating system, and
more.
Java Properties Screen
Page 126 of 1426 Apache Solr Reference Guide 7.7
Guide Version 7.7 - Published: 2019-03-04 c 2019, Apache Software Foundation

Thread Dump
The Thread Dump screen lets you inspect the currently active threads on your server.
Each thread is listed and access to the stacktraces is available where applicable. Icons to
the left indicate the
state of the thread: for example, threads with a green check-mark in a green circle are in a
"RUNNABLE"
state. On the right of the thread name, a down-arrow means you can expand to see the
stacktrace for that
thread.
List of Threads