public class HealthCheckHandler extends RequestHandlerBase
By default the handler returns status 200 OK
if all checks succeed, else it returns
status 503 UNAVAILABLE
:
live_nodes
in zookeeper.
The handler takes an optional request parameter requireHealthyCores=true
which will also require that all local cores that are part of an active shard
are done initializing, i.e. not in states RECOVERING
or DOWN
.
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.
SolrInfoBean.Category, SolrInfoBean.Group
appends, defaults, httpCaching, initArgs, invariants, solrMetricsContext
TYPE
Constructor and Description |
---|
HealthCheckHandler(CoreContainer coreContainer) |
Modifier and Type | Method and Description |
---|---|
SolrInfoBean.Category |
getCategory()
Category of this component
|
CoreContainer |
getCoreContainer() |
String |
getDescription()
Simple one or two line description
|
void |
handleRequestBody(SolrQueryRequest req,
SolrQueryResponse rsp) |
void |
init(NamedList args)
Initializes the
SolrRequestHandler by creating three SolrParams named. |
Boolean |
registerV2()
Whether this request handler must be made available at the /v2/ path
|
getApis, getInitArgs, getMetricNames, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, initializeMetrics, setPluginInfo
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMetricRegistry, getMetricsSnapshot, registerMetricName
close, getUniqueMetricTag, initializeMetrics
registerV1
public HealthCheckHandler(CoreContainer coreContainer)
public final void init(NamedList args)
RequestHandlerBase
SolrRequestHandler
by creating three SolrParams
named.
Name | Description |
---|---|
defaults | Contains all of the named arguments contained within the list element named "defaults". |
appends | Contains all of the named arguments contained within the list element named "appends". |
invariants | Contains all of the named arguments contained within the list element named "invariants". |
Example:
<lst name="defaults"> <str name="echoParams">explicit</str> <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str> <str name="mm">2<-1 5<-2 6<90%</str> <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str> </lst> <lst name="appends"> <str name="fq">inStock:true</str> </lst> <lst name="invariants"> <str name="facet.field">cat</str> <str name="facet.field">manu_exact</str> <str name="facet.query">price:[* TO 500]</str> <str name="facet.query">price:[500 TO *]</str> </lst>
init
in interface SolrRequestHandler
init
in class RequestHandlerBase
args
- The NamedList
to initialize fromRequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
,
RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
,
SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)
,
See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).
public CoreContainer getCoreContainer()
public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception
handleRequestBody
in class RequestHandlerBase
Exception
public String getDescription()
SolrInfoBean
getDescription
in interface SolrInfoBean
getDescription
in class RequestHandlerBase
public SolrInfoBean.Category getCategory()
SolrInfoBean
getCategory
in interface SolrInfoBean
getCategory
in class RequestHandlerBase
public Boolean registerV2()
ApiSupport
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.