Skip to main content

Solr AdminUI

This section provides a brief introduction to Solr's AdminUI. The AdminUI offers the ability to view information about the service and collections, activate additional logging for Solr, and perform management actions for individual collections. Here we describe the most common views and options that are relevant for troubleshooting and problem resolution.

Accessing the AdminUI​

To access the AdminUI of the Solr, an SSH tunnel to connect to the ADITO system must be established first. Then by using either http://localhost:8983/solr/ or http://adito-solr.[My-ADITO-Domian]:8983/solr/ as URL will show the main dashboard.

If basic auth is enabled, the first access will show the login screen.

The port 8983 is the default used in all ADITO-Cloud systems and the legacy adito/solr docker image.

note

The actual URL to access the Solr depends on the System and the way used to open the SSH tunnel that manages port mapping and forwarding. Look up the actual host and port in your designer or script used to establish the tunnel.

Login​

By default, the user admin is set up. The password can be found in the SSP in the Details tab under Config Maps stored in the parameter INFO_secret_SOLR.admin. When accessing via Kubernetes, the parameter can be found in the secrets of the ADITO system.

Solr Login

Dashbord​

The dashboard shows the basic information about the Solr, including the version, number of processes, amount of RAM, and active settings. This is the default landing page of the AdminUI. On the left side of the page are the main menu options, which are described in the following sections.

Solr Dashboard

The dashboard contains the following panels:

  • Instance - Shows the uptime of the Solr instance.
  • Versions - Shows the version of the Solr and underlying Lucene version.
  • JVM - Contains all information about the JVM used by the Solr.
    • Runtime - Shows the JVM version of the Solr.
    • Process - Shows the number of processes used by the Solr.
    • Args - Shows a list of all arguments used to start the Solr.
  • System - Shows the information for physical memory and file descriptor count.
  • JVM Memory - Shows the currently used and maximum memory of the JVM.
  • Security - Shows the currently used security plugin.

Logging​

The logging page contains a list of all current log messages from the Solr.

important

In SPP systems, the logging page only shows log messages that occurred during the startup of the Solr instance. All other log messages are redirected and only available in the GrayLog of the ADITO system.

Solr Logging

  • Solr uses the Log4j2 logging framework.
  • The default log level is set to WARN so only warnings and errors are shown.
  • This page does automatically refresh.

Change the Log Level​

The log level can be changed by clicking on the Level option within the Logging menu.

Solr Log-Level

  • This page contains a list of all available Log4j loggers and their current log level.

To change the log level of a specific logger, click on the logger in the tree and select the desired log level.

  • This will change the log level of all loggers that are below the selected logger.
  • All changes are applied immediately at runtime.

Solr edit Log-Level

Useful Loggers​

LoggerDescription
org.apache.solr.core.SolrCore.SlowRequestLogs if all slow requests to a core of the collection.
org.apache.solr.handler.SchemaHandlerLogs all actions done to the schema of a collection .
org.apache.solr.componentCreates detailed logs for specific query operations during search, like the facade search.
org.apache.solr.searchCreates detailed logs for all search requests.
org.apache.solr.servlet.HttpSolrCallLogs all incoming http requests of the Solr.
org.apache.solr.update.UpdateHandlerCreates logs for all update operations done during indexing.

Security​

The security menu allows to configure basic authentication settings and to manage users and roles and their permissions.

Solr Security

  • The security menu is only available if a security plugin like the basic authentication plugin is enabled.
  • The solr user used by the ADITO server and administrator if separate must have the admin role with the permission all to grant full access to the Solr.
  • The password for the solr user for unmanaged or on-premise ADITO systems can be configured here after the initial setup.
    • To edit the password of an existing user, click on the user in the list under the Users section. This will open a dialog where the password and roles can be changed.
important

Any changes of the security settings in a managed ADITO system will be lost after the next restart of the Solr instance. This is because the ADITO operator manages the security settings and will overwrite any changes made in the AdminUI.

Cloud​

The menu Cloud contains information about the current state and configuration files of the Solr Cloud. It contains the sections Nodes, Tree, ZK Status and Graph. The individual sections are described below.

Nodes​

The Nodes section shows the current state of the all Solr Cloud nodes, which in the case of an ADITO system is a single node. It contains general information about the node, the current state, the host, the memory and cpu usage, disc space usage and document count.

Solr Cloud Nodes

  • If the node is not in the state active, it will be highlighted in red and most of the information is unavailable.
note

The node information is only available if the Solr and Zookeeper are correctly configured. The Status is monitored by the Zookeeper. If the Zookeeper cannot reach the Solr via the configured Solr host, the node will be marked as down.

Tree​

The Tree section provides a simple file browser for all files used by the Solr.

  • The browser can only display JSON, XML and TXT files.

Solr Cloud Tree

Useful files and folders:

  • /security.json - The current active security configuration of the Solr. Empty if no security plugin is enabled.
  • /configs - Folder containing all available ConfigSets.
  • /collections - Folder containing all existing collections.
  • /collections/<My-Collection>/state.json - Managed file containing the current state of the collection.

ZK Status​

Shows general information and the current status of the Zookeeper.

Solr Cloud ZK Status

  • If the Zookeeper is not reachable, the status will be marked as down.
  • If the ZooKeeper works correctly, the status will be marked as green.

Collections​

The Collections section shows a list of all existing collections and allows performing basic actions like creating and deleting collections.

Solr Collections

  • When selecting a collection, additional information for the collection is shown like the used ConfigSet and number of shards and the replication factor.
  • With the Delete Collection button, the collection can be deleted.
    • This will show a small popup window where the name of the collection needs to be entered manually to confirm the deletion.

Official Guides​

For more detailed information regarding the AdminUI please see the official guide if needed.
Solr Reference Guide — Solr Admin UI

Common Actions​

A short description of the most common actions that can be done with the AdminUI to help troubleshooting.

Checking the Status Information​

Overall System Status of the Solr​

The overall status of the Solr can be checked in the Dashboard section. Solr Dashboard

  • This shows the uptime of the Solr instance, general information like the processor count and memory usage.
  • The Args lists all active arguments used to start the Solr.

Collection Status​

The overall status of the collection can be checked in the Nodes section.

  • If the collection is not in the state active, it will be highlighted in red and most of the information is unavailable.
  • If the node information does not contain an active collection, the collection is not created yet.

For more detailed information about the collection can be found in the Collections section.

  • To view the information about the collection, select the collection in the list.
  • If the collection is not shown in the list, it is not created yet.

For the most detailed information about the collection status, the state.json file of the collections folder can be accessed via the Tree section. Collection state.json

  • The state.json contains the current state of the shards and replicas of the collection.
  • All state fields should have the value active.
  • If the state of one is not active, the collection is not running correctly.
    • A restart of solr can fix this issue, otherwise the collection will not be recreated.

Zookeeper Status​

The overall status of the Zookeeper can be checked in the ZK Status section. Solr Cloud ZK Status

  • If the Zookeeper is not reachable, the status will be marked as down.
  • If the ZooKeeper works correctly, the status will be marked as green.

Checking the ADITO-ConfigSet Information​

The required ConfigSet for the ADITO version used can be found on the Versions and Dependencies page. This section describes how to check and verify if the collection uses the correct ConfigSet or what the name of the used ConfigSet is.

note

The name of the ConfigSet actually used by the collection does not match the name of the ConfigSet stated as baseConfigSet in the version guide. On collection creation the ConfigSet is either copied from the baseConfigSet or directly uploaded by the ADITO server. In order for multiple collections to not use the same ConfigSet, the ConfigSet actual ConfigSet is named <My-Collection>_config.

Finding the name of the uses ConfigSet​

  • In the Collections section, the name of used ConfigSet is viewed when selecting it in the list. Solr Collections

  • Alternatively, the name of the used ConfigSet can be found in the configoverlay.json file of the collection.

  • This file can be accessed

    • either via the file browser of Tree menu under /collections/<My-Collection>/configoverlay.json folder.
    • or via the Files menu of the selected Collection on the left side of the page.

    Solr Collection Files - configoverlay.json

Checking the ConfigSet​

{
  "userProps":{
    "ADITO.schema.version":9,
    "ADITO.schema.baseConfigSet":"adito_config_v9",
    "ADITO.configset.version":"9.0.0",
    "ADITO.schema.configset":"ADITO_xRM_dev_config"},
  "props":{"updateHandler":{
      "autoCommit":{
        "openSearcher":true,
        "maxDocs":10000},
      "autoSoftCommit":{"maxTime":-1}}}}

  • The ConfigSet must contain a userProps element in with all ADITO properties are stored.

    • The ADITO server writes and uses requires the properties to verify the collection.
    • If this part is missing or does not contain all required properties, the indexsearch of the ADITO server will not start.

  • Required properties:

    • ADITO.schema.version - The main version of the used schema.
    • ADITO.schema.baseConfigSet - The name of the base ConfigSet used as template.
    • ADITO.configset.version - The version of the used ConfigSet.
    • ADITO.schema.configset - The name of the ConfigSet.

Checking Basic-Auth and Security​

  • The first indicator if basic authentication is enabled is if the login screen is shown when accessing the AdminUI.
  • The active security plugin is shown in the Security part of the Dashboard in the bottom right corner. Solr Dashboard
  • If no security plugin is enabled, the Security menu in the main menu on the left side will not be available.

All solr related security settings are stored in the security.json file. This /security.json file can be accessed via the file browser of the Tree menu under Cloud. Solr Cloud Tree

If basic authentication is enabled, the security.json file will contain the following information:

{
  "authentication":{
    "blockUnknown": true,
    "class":"solr.BasicAuthPlugin",
    "credentials":{"admin":"Lux..BASE64-HASH-VALUE..U= AYw..BASE64-HASH-VALUE..kpo="},
    "realm":"adito solr users",
    "forwardCredentials": false
  },
  "authorization":{
    "class":"solr.RuleBasedAuthorizationPlugin",
    "permissions":[{"name":"all", "role":"admin"}],
    "user-role":{"admin":"admin"}
  }}

  • The authentication section contains the settings for the authentication plugin used.

    • The blockUnknown setting is set to true to prevent anonymous access.
    • The class setting is set to solr.BasicAuthPlugin to use the basic authentication plugin.
    • The credentials section contains the username and password of the solr user.
    • The realm section contains the name of the security realm.

  • The authorization section contains the settings for the authorization plugin used.

    • The class setting is set to solr.RuleBasedAuthorizationPlugin to use the local rule-based authorization plugin.
    • The permissions section contains the permissions for the solr user.
      • The name setting is set to all to grant full access to the Solr.
      • The role setting is set to admin to assign the solr user to the admin role.
    • The user-role section contains the mapping between the solr user and the role.
      • The admin setting is set to admin to assign the solr user to the admin role.`

Deleting a Collection​

  • Got to the Collections section.
  • Select the collection to delete.
  • Click the Delete Collection button at the top of the page.
  • This will show a small popup window where the name of the collection needs to be entered manually.
  • Confirm the deletion by clicking the Delete button.

Delete Collection

Deleting a specific ConfigSet​

Delete a specific ConfigSet is not possible in the AdminUI. But it can be done via a REST call to the ConfigSet API.

  • Directly via the Browser:

    http://adito-solr.<MY-SYSTEM>.svc.cloud.local:8983/solr/admin/configs?action=DELETE&name=<MY-CONFIG-SET>&omitHeader=true

  • via Curl:

    curl -X DELETE 'http://adito-solr.<MY-SYSTEM>.svc.cloud.local:8983/solr/admin/configs?action=DELETE&name=<MY-CONFIG-SET>&omitHeader=true'

When the operation is successful the ConfigSet will no longer be available in the Tree menu under /configs.