Package org.apache.solr.handler.admin

Class MetricsHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.MetricsHandler

All Implemented Interfaces:

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

public class MetricsHandler
extends RequestHandlerBase
implements PermissionNameProvider

Request handler to return metrics

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 final String	ALL
static final String	CATEGORY_PARAM
static final String	COLLECTION_PARAM
static final String	COMPACT_PARAM
static final String	CORE_PARAM
static final String	EXPR_PARAM
static final String	GROUP_PARAM
static final String	KEY_PARAM
static final String	METRIC_NAME_PARAM
static final String	OPEN_METRICS_WT
static final String	PREFIX_PARAM
static final String	PROMETHEUS_METRICS_WT
static final String	PROPERTY_PARAM
static final String	REGEX_PARAM
static final String	REGISTRY_PARAM
static final String	REPLICA_TYPE_PARAM
static final String	SHARD_PARAM
static final String	TYPE_PARAM

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

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

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

ANY, NULL, values

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

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

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

TYPE

Constructor Summary

Constructors

Constructor	Description
MetricsHandler(CoreContainer coreContainer)
MetricsHandler(SolrMetricManager metricManager)

Method Summary

Modifier and Type	Method	Description
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
boolean	isEnabled()

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

getApis, getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, 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 Details

COMPACT_PARAM

public static final String COMPACT_PARAM

See Also:

• Constant Field Values

PREFIX_PARAM

public static final String PREFIX_PARAM

See Also:

• Constant Field Values

REGEX_PARAM

public static final String REGEX_PARAM

See Also:

• Constant Field Values

PROPERTY_PARAM

public static final String PROPERTY_PARAM

See Also:

• Constant Field Values

REGISTRY_PARAM

public static final String REGISTRY_PARAM

See Also:

• Constant Field Values

GROUP_PARAM

public static final String GROUP_PARAM

See Also:

• Constant Field Values

KEY_PARAM

public static final String KEY_PARAM

See Also:

• Constant Field Values

EXPR_PARAM

public static final String EXPR_PARAM

See Also:

• Constant Field Values

TYPE_PARAM

public static final String TYPE_PARAM

See Also:

• Constant Field Values

CATEGORY_PARAM

public static final String CATEGORY_PARAM

See Also:

• Constant Field Values

CORE_PARAM

public static final String CORE_PARAM

See Also:

• Constant Field Values

COLLECTION_PARAM

public static final String COLLECTION_PARAM

See Also:

• Constant Field Values

SHARD_PARAM

public static final String SHARD_PARAM

See Also:

• Constant Field Values

REPLICA_TYPE_PARAM

public static final String REPLICA_TYPE_PARAM

See Also:

• Constant Field Values

METRIC_NAME_PARAM

public static final String METRIC_NAME_PARAM

See Also:

• Constant Field Values

PROMETHEUS_METRICS_WT

public static final String PROMETHEUS_METRICS_WT

See Also:

• Constant Field Values

OPEN_METRICS_WT

public static final String OPEN_METRICS_WT

See Also:

• Constant Field Values

ALL

public static final String ALL

See Also:

• Constant Field Values

Constructor Details

MetricsHandler

public MetricsHandler(CoreContainer coreContainer)

MetricsHandler

public MetricsHandler(SolrMetricManager metricManager)

Method Details

isEnabled

public boolean isEnabled()

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)

Specified by:

getPermissionName in interface PermissionNameProvider

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

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class RequestHandlerBase