You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by er...@apache.org on 2018/07/24 04:00:10 UTC
lucene-solr:branch_7x: SOLR-12576: Update ref guide for additional
information displayed in cloud view
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x 2376d7dde -> 24f7fd8e2
SOLR-12576: Update ref guide for additional information displayed in cloud view
(cherry picked from commit 9d7aef6)
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/24f7fd8e
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/24f7fd8e
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/24f7fd8e
Branch: refs/heads/branch_7x
Commit: 24f7fd8e213352ba94fa7c1617ba60b56f371110
Parents: 2376d7d
Author: Erick Erickson <er...@apache.org>
Authored: Mon Jul 23 20:58:32 2018 -0700
Committer: Erick Erickson <er...@apache.org>
Committed: Mon Jul 23 21:00:00 2018 -0700
----------------------------------------------------------------------
solr/CHANGES.txt | 2 ++
solr/solr-ref-guide/src/cloud-screens.adoc | 14 +++++++++-----
.../src/images/cloud-screens/cloud-graph.png | Bin 54929 -> 94496 bytes
.../src/images/cloud-screens/cloud-hover.png | Bin 0 -> 83343 bytes
.../src/images/cloud-screens/cloud-radial.png | Bin 62572 -> 102878 bytes
.../src/images/cloud-screens/cloud-tree.png | Bin 105371 -> 122158 bytes
6 files changed, 11 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/CHANGES.txt
----------------------------------------------------------------------
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index c2b68ae..dfb3e35 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -134,6 +134,8 @@ Bug Fixes
* SOLR-12570: OpenNLPExtractNamedEntitiesUpdateProcessor cannot support multi fields because pattern replacement
doesn't work correctly. (Koji Sekiguchi)
+* SOLR-12576: Update ref guide for additional information displayed in cloud view (Erick Erickson)
+
Optimizations
----------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/solr-ref-guide/src/cloud-screens.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/cloud-screens.adoc b/solr/solr-ref-guide/src/cloud-screens.adoc
index f7d0dfb..77cf9e5 100644
--- a/solr/solr-ref-guide/src/cloud-screens.adoc
+++ b/solr/solr-ref-guide/src/cloud-screens.adoc
@@ -16,7 +16,7 @@
// specific language governing permissions and limitations
// under the License.
-When running in <<solrcloud.adoc#solrcloud,SolrCloud>> mode, a "Cloud" option will appear in the Admin UI between <<logging.adoc#logging,Logging>> and <<collections-core-admin.adoc#collections-core-admin,Collections/Core Admin>>.
+When running in <<solrcloud.adoc#solrcloud,SolrCloud>> mode, a "Cloud" option will appear in the Admin UI between <<logging.adoc#logging,Logging>> and <<collections-core-admin.adoc#collections-core-admin,Collections>>.
This screen provides status information about each collection & node in your cluster, as well as access to the low level data being stored in <<using-zookeeper-to-manage-configuration-files.adoc#using-zookeeper-to-manage-configuration-files,ZooKeeper>>.
@@ -26,18 +26,22 @@ This screen provides status information about each collection & node in your clu
The "Cloud" menu option is only available on Solr instances running in <<getting-started-with-solrcloud.adoc#getting-started-with-solrcloud,SolrCloud mode>>. Single node or master/slave replication instances of Solr will not display this option.
====
-Click on the Cloud option in the left-hand navigation, and a small sub-menu appears with options called "Tree", "Graph", "Graph (Radial)" and "Dump". The default view ("Graph") shows a graph of each collection, the shards that make up those collections, and the addresses of each replica for each shard.
+Click on the Cloud option in the left-hand navigation, and a small sub-menu appears with options called "Tree", "Graph", and "Graph (Radial)". The default view ("Graph") shows a graph of each collection, the shards that make up those collections, and the addresses and type ("NRT", "TLOG" or "PULL") of each replica for each shard.
-This example shows the very simple two-node cluster created using the `bin/solr -e cloud -noprompt` example command. In addition to the 2 shard, 2 replica "gettingstarted" collection, there is an additional "films" collection consisting of a single shard/replica:
+This example shows a simple cluster. In addition to the 2 shard, 2 replica "gettingstarted" collection, there is an additional "tlog" collection consisting of mixed TLOG and PULL replica types.
image::images/cloud-screens/cloud-graph.png[image,width=512,height=250]
+Tooltips appear when hovering over each replica giving additional information.
+
+image::images/cloud-screens/cloud-hover.png[image,width=512,height=250]
+
The "Graph (Radial)" option provides a different visual view of each node. Using the same example cluster, the radial graph view looks like:
image::images/cloud-screens/cloud-radial.png[image,width=478,height=250]
-The "Tree" option shows a directory structure of the data in ZooKeeper, including cluster wide information regarding the `live_nodes` and `overseer` status, as well as collection specific information such as the `state.json`, current shard leaders, and configuration files in use. In this example, we see the `state.json` file definition for the "films" collection:
+The "Tree" option shows a directory structure of the data in ZooKeeper, including cluster wide information regarding the `live_nodes` and `overseer` status, as well as collection specific information such as the `state.json`, current shard leaders, and configuration files in use. In this example, we see part of the `state.json` definition for the "tlog" collection:
image::images/cloud-screens/cloud-tree.png[image,width=487,height=250]
-The final option is "Dump", which returns a JSON document containing all nodes, their contents and their children (recursively). This can be used to export a snapshot of all the data that Solr has kept inside ZooKeeper and can aid in debugging SolrCloud problems.
+As an aid to debugging, the data shown in the "Tree" view can be exported locally using the following command `bin/solr zk ls -r /`
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/solr-ref-guide/src/images/cloud-screens/cloud-graph.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/cloud-screens/cloud-graph.png b/solr/solr-ref-guide/src/images/cloud-screens/cloud-graph.png
index a1f81b2..5478cd4 100644
Binary files a/solr/solr-ref-guide/src/images/cloud-screens/cloud-graph.png and b/solr/solr-ref-guide/src/images/cloud-screens/cloud-graph.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/solr-ref-guide/src/images/cloud-screens/cloud-hover.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/cloud-screens/cloud-hover.png b/solr/solr-ref-guide/src/images/cloud-screens/cloud-hover.png
new file mode 100644
index 0000000..db55ba0
Binary files /dev/null and b/solr/solr-ref-guide/src/images/cloud-screens/cloud-hover.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/solr-ref-guide/src/images/cloud-screens/cloud-radial.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/cloud-screens/cloud-radial.png b/solr/solr-ref-guide/src/images/cloud-screens/cloud-radial.png
index 76f9e1e..d3b245f 100644
Binary files a/solr/solr-ref-guide/src/images/cloud-screens/cloud-radial.png and b/solr/solr-ref-guide/src/images/cloud-screens/cloud-radial.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24f7fd8e/solr/solr-ref-guide/src/images/cloud-screens/cloud-tree.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/cloud-screens/cloud-tree.png b/solr/solr-ref-guide/src/images/cloud-screens/cloud-tree.png
index 127812a..200fb6d 100644
Binary files a/solr/solr-ref-guide/src/images/cloud-screens/cloud-tree.png and b/solr/solr-ref-guide/src/images/cloud-screens/cloud-tree.png differ