05 Apache Solr: Admin UI and solrui
To help administrators and engineers adjust Solr configurations and access online documents and other help services, Solr provides a Web interface to view Solr configuration details, run query statements, and analyze document fields. This interface is mentioned in the third article as the administrator interface (Admin UI), as shown in: it can be seen that the Admin UI is still relatively complex. The following sections describe the modules of the interface.Get helpAt the bottom of the area on the right is the help area. No matter what you are operating on the Admin UI, the position of the Help area remains unchanged and is always displayed. See the following table:
Link |
Description |
Documentation |
Navigate to Solr's online document page. |
Issue Tracker |
Navigate to the JIRA issue tracking server of the Apache Solr project. Service address: |
IRC Channel |
Navigate to the Apache Wikipedia page and describe how to join Solr's IRC online chat room: |
Community forum |
Navigate to the Apache Wikipedia page. For more information, see add to the Solr community email list. |
Solr Query Syntax |
Navigate to the Query Syntax and Parsing section of the Guide document. |
LogsThe log page displays the latest records of the current Solr node. Click the Logging link on the left of the Admin UI to view a similar page.
Set the Log LevelWhen you select the Level Link under Logging, you will see a hierarchical structure of classpath and classname. If you click on any row, a log-level menu is displayed, which can be set to any level or canceled. Because the log settings are tree-like, setting the Log Level of the parent node will affect its subnodes by default, unless the subnode has specific settings ., By default, all nodes under root are INFO-level, but hadoop nodes only output logs at WARN level.
Core AdminThe Core Admin interface provides some basic functions for managing Core-level information and is driven by the Core Admin API. On the Core Admin interface (for example), a list of existing cores is displayed on the left. Click any Core name to view its details and perform various operations.
Java PropertiesThe Java Properties interface provides simple access to the most efficient essential components in the Solr system. On this interface, we can see all attributes of the JVM running Solr: including class path, file encoding, JVM memory settings, operating system, and so on.
Thread Dump (Thread stack)The thread stack interface enables you to check the active threads on the server. Every thread is displayed in the list, and the access to the stack track can also be viewed. The icon on the left of the thread name to indicate the thread status. For example, the icon indicates the "runable status", and the country arrow on the right of the thread name, used to show the stack trace. When the pointer is moved to the thread name, the thread status is displayed. The following thread states are available:
Status |
Meaning |
NEW |
The thread is not started. |
RUNNABLE |
The thread is running on JVM. |
BLOCKED |
The thread is blocked by the monitor lock. |
WAITING |
The thread waits for another thread to complete a specific action indefinitely. |
TIMED_WAITING |
The thread waits for another thread to complete an action to specify a wait time. |
TERMINATED |
The thread has exited. |
Core SelectorClick the Core Selector menu to display a list of cores in the current Solr instance. If there are too many cores, you can search for a specific Core in the search box above the list. After a Core is selected, the metadata of the Core is displayed in the content area, and a level-2 menu is displayed under the Core selection box. The secondary menu is as follows:
- Overview: displays the Core statistics, instance information, synchronous replication, and other information on the default page after the Core is selected.
- Analysis: analyzes the data found from a specified field.
- Dataimport: displays the current status of Data Import Handler.
- Documents: provides a simple form that allows you to directly execute many Solr index commands in a browser.
- Files: displays the configuration file of the current Core.
- Ping: checks the availability of the server.
- Plugins/Stats: view the plug-in and statistical status of the Core.
- Query: You can submit a structured Query for multiple elements in the Core.
- Replication: displays basic information about master-slave Replication. You can complete simple settings.
- Schema: displays basic information about the mode. You can add fields, dynamic fields, and copy fields.
- Segmetns info: View part information.
Analysis (Analysis interface)The analysis interface allows you to check how data is processed based on the fields, field types, and dynamic field configurations set in the Schema. You can analyze how the content will be processed during indexing and query processing, and view the results separately. Ideally, you may want the content to be processed consistently, and this interface allows you to verify the settings of the field and field analysis chain. Enter content in one or two input boxes at the top, and then select the field name or field type to be analyzed. If you select Verbose Output, more Output information is displayed.
Dataimport (data import Interface)The DataImportHandler configuration is displayed on the data import interface, and allows you to start and monitor the status of import commands. For the definition of the import command, see the intermediate area. This interface also allows you to adjust the option content to control how to import data to Solr and view the configuration file for control import. Documents interface provides a simple form that allows you to execute many Solr index commands and supports several file formats (such as JSON, XML, and CSV ), you can even upload documents in the corresponding format. The first step is to define RequestHandler, also known as 'qt '. By default, use/update. If you want to use Solr Cell, change the command to/update/extract. Next, select the document type. After the document type is selected, the following parameters will change.
JSONThe JSON document type is the same as the RequestHandler type in the command line. The difference is that the document is entered in the Documents text box, rather than in the command line, but the structure of the document should also be JSON type. Then, determine when the document should be added to the index (Commit Within). Whether or not the document with the same id already exists, it must be overwritten (if not, the newly added documents will be deleted) and the documents will be submitted.
CSVWhen the CSV file type is used, it is the same as the command line uses RequestHandler. The difference is that the document is entered in the Documents text box, rather than in the command line, but the format of the document is CSV. Then, determine when the document should be added to the index (Commit Within). Whether or not the document with the same id already exists, it must be overwritten (if not, the newly added documents will be deleted) and the documents will be submitted.
File UploadThe File Upload option allows you to Upload a prepared File. If you only use the/update command, the format of the document to be uploaded is limited to XML, CSV, and JSON.
Solr commandThe Solr Command Option allows you to use XML or JSON to execute specified actions. For example, you can define commands to add or delete documents, update specified fields of documents, and submit and optimize indexes. When using the/update command, the document must be formatted as needed.
XMLWhen the XML document type is used, it is the same as the command line uses RequestHandler. The difference is that the document is entered in the Documents text box, rather than in the command line, but the document format is XML, and each document must be separated by the <doc> label, define fields in the <doc> label. Then, determine when the document should be added to the index (Commit Within). Whether or not the document with the same id already exists, it must be overwritten (if not, the newly added documents will be deleted) and the documents will be submitted.
File InterfaceOn the document page, you can view the configuration files (such as solrconfig. xml and Schema files) of the selected set or Core ). The solrconfig. xml file defines the Solr index content and query response behavior. Schema allows you to define the field type, fields, and dynamic fields of a document. Other configuration files usually depend on how they reference solrconfig. xml or Schema files. You cannot edit the configuration file on this page. to edit the configuration file, you must use another text editor.
Query (Query interface)On the query page, you can submit a query request to the Solr set (or Core) and analyze the result. In the example, a default query has been submitted, and the query result is displayed on the right. The full query http request is displayed on the top right (cross-platform query can be completed using this request in other programming languages ). The query interface contains many query fields or parameters. See the following table:
Field |
Description |
Request-handler (qt) |
Specify the query handler for the request ). If the query processor is specified, Solr uses the standard query processor to process the response. |
Q |
Query events. Detailed query parameters are described later. |
Fq |
Filter queries. |
Sort |
Query results are arranged in the forward or backward order based on the response scores or specified characters. |
Start, rows |
Start is the offset of the query result. The default value is 0, which means that the result returned from the first query is returned. Rows indicates the number of rows returned. |
Fl |
Define the fields in the result document. The specified field that can be displayed. All fields are returned by default. Use a comma (,) or space () to separate the sequence of field names. |
Wt |
Specify the format of the returned results (json \ xml \ python \ ruby \ php \ csv ). |
Indent |
Select this option to indent the query result. This improves the readability of the results. |
DebugQuery |
Select this option to add Debug information to the query result, including the Explain info of each document. |
Dismax |
Select this option to make the Dismax query and resolution available. |
Edismax |
Select this option. Extended query resolution is available. |
Hl |
Select this option to highlight the query results. |
Facet |
Select this option to allow segmented query. |
Spatial |
Select this option to allow location data. |
Spellcheck |
Select this option to enable syntax verification. |