Package org.apache.solr.handler.admin

Class MetricsCollectorHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.MetricsCollectorHandler

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider

public class MetricsCollectorHandler
extends RequestHandlerBase

Handler to collect and aggregate metric reports. Each report indicates the target registry where metrics values should be collected and aggregated. Metrics with the same names are aggregated using AggregateMetric instances, which track the source of updates and their count, as well as providing simple statistics over collected values.

Each report consists of SolrInputDocument-s that are expected to contain the following fields:

• SolrReporter.GROUP_ID - (required) specifies target registry name where metrics will be grouped.
• SolrReporter.REPORTER_ID - (required) id of the reporter that sent this update. This can be eg. node name or replica name or other id that uniquely identifies the source of metrics values.
• MetricUtils.METRIC_NAME - (required) metric name (in the source registry)
• SolrReporter.LABEL_ID - (optional) label to prepend to metric names in the target registry.
• SolrReporter.REGISTRY_ID - (optional) name of the source registry.

Remaining fields are assumed to be single-valued, and to contain metric attributes and their values. Example:

   <doc>
     <field name="_group_">solr.core.collection1.shard1.leader</field>
     <field name="_reporter_">core_node3</field>
     <field name="metric">INDEX.merge.errors</field>
     <field name="value">0</field>
   </doc>
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.handler.RequestHandlerBase

RequestHandlerBase.HandlerMetrics

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static String	HANDLER_PATH

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, solrMetricsContext

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.request.SolrRequestHandler

TYPE

Constructor Summary

Constructors

Constructor	Description
MetricsCollectorHandler(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Simple one or two line description
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void	init(org.apache.solr.common.util.NamedList<?> initArgs)	Initializes the SolrRequestHandler by creating three SolrParams named.

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getApis, getCategory, getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, initializeMetrics, isInternalShardRequest, normalizeReceivedException, processErrorMetricsOnException, setPluginInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.api.ApiSupport

getJerseyResources, registerV1, registerV2

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close

Field Detail

HANDLER_PATH

public static final String HANDLER_PATH

See Also:

Constant Field Values

Constructor Detail

MetricsCollectorHandler

public MetricsCollectorHandler(CoreContainer coreContainer)

Method Detail

init

public void init(org.apache.solr.common.util.NamedList<?> initArgs)

Description copied from class: RequestHandlerBase

Initializes the SolrRequestHandler by creating three SolrParams named.

table of parameters

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>
 

Specified by:

init in interface SolrRequestHandler

Overrides:

init in class RequestHandlerBase

Parameters:

initArgs - The NamedList to initialize from

See Also:

RequestHandlerBase.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).

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)