Enabling the Solr administrative interface

You can monitor Solr in WebSphere Commerce Search using the Solr administrative interface. The Solr native administrative interface can be used to gather runtime statistics for each Solr core that is running on the search server. It can also be used to perform simple search queries.

Before you begin

Download the supported Solr package from Apache. It contains an admin directory in Solr.war.

About this task

The Solr administrative interface does not support workspace cores. When using the interface, you must request the status of each specific core. That is, if requesting the status of the full set of cores (which includes workspaces), an exception will be thrown.

For more information, see SolrAdminGUI.

Procedure

  1. Import the Search_eardir/Search-Solr.war project into your workspace.
  2. Copy the following directories and files from the downloaded Solr.war file into a location that depends on whether you are working in a developer or runtime environment.
    Files to be copied:
    • css
    • img
    • js
    • tpl
    • admin.html
    • favicon.ico
    • WebSphere Commerce DeveloperIf you are working in a development environment, place the files in the Search-Solr/WebContent directory.
    • Alternatively, if you want to enable the Solr administrative interface in a runtime environment, copy the files to the following locations:

      Search_eardir/Search-Solr.war

      Search_eardir/deployments/Search_demo/Search-Solr.war

    Alternatively, to enable the Solr administrative interface in a runtime environment, perform the steps to the following locations:WebSphere Commerce Enterprise
    • Search_eardir/Search-Solr.war
    • Search_eardir/deployments/Search_demo/Search-Solr.war
  3. Open the Search-Solr/WebContent/WEB-INF/ibm-web-ext.xml file for editing.
  4. Find the enable-file-serving flag and set it to true.
    For example:
    
<web-ext
   xmlns="http://websphere.ibm.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://websphere.ibm.com/xml/ns/javaee http://websphere.ibm.com/xml/ns/javaee/ibm-web-ext_1_0.xsd"
   version="1.0">

   <reload-interval value="3"/>
   <context-root uri="/solr" />
   <enable-directory-browsing value="false"/>
   <enable-file-serving value="true"/>
   <enable-reloading value="false"/>
   <enable-serving-servlets-by-class-name value="false" />

</web-ext>
  5. Save your changes and close the files.
  6. WebSphere Commerce Developer Deploy the Search-Solr project; Right-click the project and select Java EE > Prepare for Deployment.
  7. Update the following files:
    • WebSphere Commerce DeveloperSearch-Solr.war/WEB-INF/web.xml
    • Search-Solr.war/WEB-INF/web.xml
    • Solr_cell/applications/solr.ear/deployments/solr/Search-Solr.war/WEB-INF/web.xml
  8. Change the URL pattern for the SolrSearchServlet servlet:
    • Change it to /solr
    For example:
    
<servlet-mapping>
     <servlet-name>SolrSearchServlet</servlet-name>
       <url-pattern>/solr</url-pattern>
</servlet-mapping>
  9. Save your changes and close the files.
  10. Publish the search EAR.
  11. Use the following URL to access the Solr administrative interface:
    • http://hostname:3737/solr/admin.html