You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2020/08/21 21:23:45 UTC
[GitHub] [lucene-solr] epugh opened a new pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
epugh opened a new pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773
To replace the old https://cwiki.apache.org/confluence/display/solr/LukeRequestHandler page, and eventually provide a link to the Luke application's getting started page!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] ctargett edited a comment on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
ctargett edited a comment on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-681096031
The MBean Request Handler page is under Monitoring Solr. That makes sense - you look at MBeans as a way of monitoring stats. I quickly searched the source files and don't see any links from any of the UI pages to the MBean Handler page, FWIW.
Since one uses the Luke handler to inspect the schema, should it perhaps go somewhere under `documents-fields-and-schema-design.adoc`? WDYT? A link from the page about the Schema Browser (`schema-browser-screen.adoc`), which uses the Luke handler, to the new page might also be helpful if you want.
_Edit: corrected the page that uses the Luke handler_
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] ctargett commented on a change in pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
ctargett commented on a change in pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#discussion_r477558467
##########
File path: solr/solr-ref-guide/src/luke-request-handler.adoc
##########
@@ -0,0 +1,77 @@
+= Luke Request Handler
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+The Luke Request Handler offers programmatic access to the information provided on the <<schema-browser-screen#schema-browser-screen,Schema Browser>> page of the Admin UI.
+It is modeled after the Luke, the Lucene Index Browser by Andrzej Bialecki. It is an implicit handler, so you don't need to define it.
+
+The Luke Request Handler accepts the following parameters:
+
+`show`::
+The data about the index to include in the response. Options are `schema`, `index`, `doc`, `all`. `index` describes the high level details about the index. `schema` returns details about the `schema` plus the `index` data. `doc` works in conjunction with `docId` or `id` parameters and returns details about a specific document plus the `index` data.
+
+`id`::
+Get a document using the uniqueKeyField specified in schema.xml.
+
+`docId`::
+Get a document using a lucene documentID.
+
+`fl`::
+Which fields you want to list the top terms for.
+
+`numTerms`::
+How many top terms for each field. The default is 10.
+
+`includeIndexFieldFlags`::
+Choose whether /luke should return the index-flags for each field. Fetching and returning the index-flags for each field in the index has non-zero cost, and can slow down requests to /luke.
+
+
+== LukeRequestHandler Examples
+
+The following examples assume you are running Solr's `techproducts` example configuration:
+
+[source,bash]
+----
+bin/solr start -e techproducts
+----
+
+To return summary information about the index:
+
+[source,text]
+ttp://localhost:8983/solr/techproducts/admin/luke?numTerms=0
+
Review comment:
Missing starting 'h' for the URL.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] ctargett commented on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
ctargett commented on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-681096031
The MBean Request Handler page is under Monitoring Solr. That makes sense - you look at MBeans as a way of monitoring stats. I quickly searched the source files and don't see any links from any of the UI pages to the MBean Handler page, FWIW.
Since one uses the Luke handler to inspect the schema, should it perhaps go somewhere under `documents-fields-and-schema-design.adoc`? WDYT? A link from the page about the Analysis screen (`analysis-screen.adoc`), which uses the Luke handler, to the new page might also be helpful if you want.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] epugh commented on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
epugh commented on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-681081838
Thanks for looking at this @ctargett (and I hope your vacation was good).
I modeled the `luke-request-handler.adoc` page on the `mbean-request-handler.adoc` page, which is also linked from the UI page (maybe?)...
However, now I'm thinking that maybe it should be under `monitoring-solr.adoc` instead?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] epugh commented on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
epugh commented on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-685009245
@ctargett do you think this is ready to go?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] epugh merged pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
epugh merged pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] ctargett commented on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
ctargett commented on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-681050148
Eric, the content is good for the new page (I've long wanted to make a page for each request handler), but can you discuss your idea to put the new page under the UI section? While the handler is used by the UI, I'm not following how it fits in that overall section since users would use it more like an API.
When I've thought about making a page for each handler, I thought most of them would probably end up under the Implicit RequestHandlers page itself. (I'm also working on an extensive re-org of the entire Guide, so that's feeding some of my doubt on this too).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] ctargett edited a comment on pull request #1773: SOLR-14773 Add LukeRequestHandler to the Solr Ref Guide
Posted by GitBox <gi...@apache.org>.
ctargett edited a comment on pull request #1773:
URL: https://github.com/apache/lucene-solr/pull/1773#issuecomment-681050148
Eric, the content is good for the new page (I've long wanted to make a page for each request handler), but can you discuss your idea to put the new page under the UI section? While the handler is used by the UI, I'm not following how it fits in that overall section since users would use it more like an API.
When I've thought about making a page for each handler, I thought most of them would probably end up under the Implicit RequestHandlers page itself. (I'm also working on an extensive re-org of the entire Guide, so that's feeding some of my doubt on this too). I'm not saying I prefer that, only that's what I assumed in my mind without having thought much about it yet.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org