You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2006/02/24 05:18:33 UTC

[Solr Wiki] Update of "SolrAdminGUI" by YonikSeeley

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by YonikSeeley:
http://wiki.apache.org/solr/SolrAdminGUI

The comment on the change is:
corrections and removals.... too much documentation is bad :-)

------------------------------------------------------------------------------
  
  /!\ :TODO: /!\ Some of this links don't exist anymore, have they been repalced by other links?
  
- In a browser instance you can navigate to the Home page of the SOLR Administration for your environment. For example:
+ After you have your instance of Solr is running, you can navigate to it's admin interface with a browser. For example:
  
-       http://yourhost.domain.tld:999/admin/
+       http://yourhost.domain.tld:999/solr/admin/
  
  /!\ :TODO: /!\ need an up to date screen shot
  attachment:solr-admin-screenshot.gif
@@ -18, +18 @@

  == SOLR Links ==
    
  ||'''SOLR Link'''||'''Displays'''||
- ||STATUS ||Displays this data: cvsId, cvsSource, cvsTag, state, schemaFile, schemaName, indexDir, maxDoc.||
+ ||SCHEMA ||Displays the XML schema file that defines the collection for this Solr instance.||
  ||CONFIG ||Displays the SOLR configuration file, solrconfig.xml.||
- ||WEB.EXTERNAL.XML ||Displays an XML file that contains some SOLR configuration values. (See also the solrconfig.xml file.) ||
  ||PROPERTIES ||Displays a JSP that contains the properties of the Java Virtual Machine (JVM).||
- ||SCHEMA ||Displays the XML schema file that defines the collection for this Solr instance.||
  ||INFO||Displays a page that displays data in these Catagories: [[BR]] [[BR]]CORE[[BR]]CACHE[[BR]]QUERY handlers[[BR]]UPDATE handlers[[BR]]OTHER [[BR]] [[BR]] The above are links to locations on the same page. The information on the INFO page does not change after startup.||
  ||STATISTICS||Displays a subset of the data appearing on the INFO page. This data ''does'' change as the objects collect statistics over time.||
  ||DISTRIBUTION ||If you are looking at a Master instance, each row displays the name of the slave and the snapshots it has retrieved. If you are looking at a Slave instance, it will display one line showing the name of it's last attempt to retrieve a snapshot off its master. See also CollectionDistribution.||
@@ -30, +28 @@

  ||LOGGING||Displays the '''Log Level''' page that allows you to set these levels:[[BR]][[BR]]ALL[[BR]]CONFIG[[BR]]FINE[[BR]]FINER[[BR]]FINEST [[BR]]INFO [[BR]]OFF [[BR]]SEVERE [[BR]]WARNING[[BR]][[BR]]Each invokes an action.jsp which shows whether the action succeeded of failed. If '''successful''', the word, 'succeeded', is displayed and then you are returned to the Admin home page. If '''unsuccessful''', the Action page display the error until you navigate away from it). For detailed information on Logging levels, see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/logging/Logger.html:SUN's page on Class Logger].||
   
  
- == Resin Server Links ==
+ == AppServer Links ==
  
  ||'''Resin Server Link'''||'''Displays'''||
+ ||THREAD DUMP||Displays a thread dump of the appserver.||
+ ||ENABLE/DISABLE||Only for use behind a load balancer : takes a server in/out of rotation by making a healthcheck succeed/fail||
- ||STATUS||Displays the statuses for the following: Server Start,  Server Reload, Total Memory, Free Memory, Invocation Hit Ratio, Proxy Cache Hit Ratio, TCP ports, and Hosts and Applications.||
- ||CONFIG||An XML file&#151;XMLNS&#151;that displays the configuration information of the Resin server that was set in its config file (conf/resin.conf) at deployment time.||
- ||THREAD DUMP||Displays the results of a Java thread running in Resin.   Each run of the thread dump command writes the results to  /var/opt/resin3/port_number/logs/jvm.log. The `[All Entries]` link on the Thread Dump page shows all previous dumps (each one begins with the words "taking thread dump...").  ||
- ||ENABLE/DISABLE||A toggle switch that turns the Resin Server on and off.  For use by Operations to take individual servers out of rotation (usually for upgrades).||
- 
- == Hardware Links ==
- 
- ||'''Hardware Link'''||'''Displays'''||
- ||STATUS||The Hardware Status page displays a ton of data such as Switch ports, Listening ports, MIBs, history and so on. Also allows you to set Disk usage reporting rules.||
- ||TRAFFIC||Displays graphical representations of traffic in bits/second over 48 hours, 14 days, 60 days, and 1 year.||
- ||PROBLEMS||Displays a usage graph with stats for various user-setable parameters for the Linux machine SOLR is currently running on.||
  
  == Make a Query Links ==
  
  ||'''Make a Query Link'''||'''Description'''||
  ||FULL INTERFACE||To make a more customized query use the Full Interface page where you can stipulate the following: a full SOLR/Lucene Statement, Protocol Version, Start Row, Maximum Rows Returned, Query Type, and Style Sheet. ||
  ||'''Full Interface Parameters Page'''||||
- ||SOLR/Lucene Statement|| Use this field to input a full and efficient query using Lucene's query language. For detailed information on Lucene see [http://lucene.apache.org/java/docs/index.html Apache's Lucene page].||
+ ||SOLR/Lucene Statement|| Use this field to a query in Lucene's query language. For detailed information on Lucene see [http://lucene.apache.org/java/docs/index.html Apache's Lucene page].||
- ||Protocol Version||SOLR's 'protocol' as of June 2005 is '''2.0'''[[BR]] /!\ :TODO: /!\ is this still true? ||
- ||Start Row||Enter the number of the first row that you want the Search results to return.||
- ||Maximum Rows Returned||Enter the number of rows you want returned of the Search results.||
- ||Query Type||Choose *Standard*. Others TBD.||
+ ||Protocol Version|| The format version that is used to return responses.  Defaults to the latest, currently 2.1 ||
+ ||Start Row||Zero based offset of matching documents to return||
+ ||Maximum Rows||Maximum number of documents to return||
+ ||Query Type||Selects the query handler for this request.  Default is *standard*.||
  ||Style Sheet||The Style Sheet determines the look of the Search Results. [[BR]] /!\ :TODO: /!\ where can stylesheets be installed? ||
-  
- == Assistance Links ==
  
- ||'''Assistance Link'''||'''Description'''||
- ||DOCUMENTATION||Links to the [:SolrDocumentationAssistance:Documentation Page].||
- ||LUCENE QUERY SYNTAX||Opens the Apache Software Foundation's page on Lucene's Query Parser that you can use to construct an efficient query.||