You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ja...@apache.org on 2020/04/14 15:12:55 UTC

[lucene-solr] branch branch_8x updated (469ab4e -> 75de058)

This is an automated email from the ASF dual-hosted git repository.

janhoy pushed a change to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git.


    from 469ab4e  SOLR-14359: Use correct placeholder-text-single option for anguar-chosen
     new 84e993c  SOLR-14210: Add javadocs and refguide docs
     new 75de058  SOLR-14210: Fix precommit for javadocs

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../solr/handler/admin/HealthCheckHandler.java     | 25 ++++++++++++++++------
 .../src/implicit-requesthandlers.adoc              |  2 ++
 2 files changed, 21 insertions(+), 6 deletions(-)


[lucene-solr] 01/02: SOLR-14210: Add javadocs and refguide docs

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janhoy pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 84e993c53241fe977753f76435d8d0192f334340
Author: Jan Høydahl <ja...@apache.org>
AuthorDate: Tue Apr 14 16:09:36 2020 +0200

    SOLR-14210: Add javadocs and refguide docs
    
    (cherry picked from commit 60545a89e0ac0b40f065581df69b2b0fd0544e30)
---
 .../solr/handler/admin/HealthCheckHandler.java     | 25 ++++++++++++++++------
 .../src/implicit-requesthandlers.adoc              |  2 ++
 2 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java b/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
index afa8416..741faf0 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
@@ -40,14 +40,27 @@ import static org.apache.solr.common.params.CommonParams.FAILURE;
 import static org.apache.solr.common.params.CommonParams.OK;
 import static org.apache.solr.common.params.CommonParams.STATUS;
 
-/*
+/**
  * Health Check Handler for reporting the health of a specific node.
  *
- * This checks if:
- * 1. Cores container is active.
- * 2. Node connected to zookeeper.
- * 3. Node listed in 'live_nodes' in zookeeper.
- * 4. No RECOVERING or DOWN cores (if request param requireHealthyCores=true)
+ * <p>
+ *   By default the handler returns status <code>200 OK</code> if all checks succeed, else it returns
+ *   status <code>503 UNAVAILABLE</code>:
+ *   <ol>
+ *     <li>Cores container is active.</li>
+ *     <li>Node connected to zookeeper.</li>
+ *     <li>Node listed in <code>live_nodes</code> in zookeeper.</li>
+ *   </ol>
+ * </p>
+ *
+ * <p>
+ *   The handler takes an optional request parameter <code>requireHealthyCores=true</code>
+ *   which will also require that all local cores that are part of an <b>active shard</b>
+ *   are done initializing, i.e. not in states <code>RECOVERING</code> or <code>DOWN</code>.
+ *   This parameter is designed to help during rolling restarts, to make sure each node
+ *   is fully initialized and stable before proceeding with restarting the next node, and thus
+ *   reduce the risk of restarting the last live replica of a shard.
+ * </p>
  */
 public class HealthCheckHandler extends RequestHandlerBase {
 
diff --git a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
index 0703c4d..434a61b 100644
--- a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
+++ b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
@@ -138,6 +138,8 @@ v2: `api/node/health` |{solr-javadocs}/solr-core/org/apache/solr/handler/admin/H
 
 This endpoint can also take the collection or core name in the path (`solr/<collection>/admin/health` or `solr/<core>/admin/health`).
 
+This endpoint also accepts additional request parameters. Please see {solr-javadocs}/solr-core/org/apache/solr/handler/admin/HealthCheckHandler.html[Javadocs] for details.
+
 === Analysis Handlers
 
 [horizontal]


[lucene-solr] 02/02: SOLR-14210: Fix precommit for javadocs

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janhoy pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 75de058d4b78a4153db671e03fc547ecdd47fd51
Author: Jan Høydahl <ja...@apache.org>
AuthorDate: Tue Apr 14 16:26:43 2020 +0200

    SOLR-14210: Fix precommit for javadocs
---
 .../core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java b/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
index 741faf0..2d16f43 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/HealthCheckHandler.java
@@ -46,12 +46,12 @@ import static org.apache.solr.common.params.CommonParams.STATUS;
  * <p>
  *   By default the handler returns status <code>200 OK</code> if all checks succeed, else it returns
  *   status <code>503 UNAVAILABLE</code>:
+ * </p>
  *   <ol>
  *     <li>Cores container is active.</li>
  *     <li>Node connected to zookeeper.</li>
  *     <li>Node listed in <code>live_nodes</code> in zookeeper.</li>
  *   </ol>
- * </p>
  *
  * <p>
  *   The handler takes an optional request parameter <code>requireHealthyCores=true</code>