Package org.apache.solr.cloud

Class OverseerTaskProcessor

java.lang.Object

org.apache.solr.cloud.OverseerTaskProcessor

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, SolrInfoBean, SolrMetricProducer

Direct Known Subclasses:

OverseerCollectionConfigSetProcessor

public class OverseerTaskProcessor
extends Object
implements SolrInfoBean, Runnable, Closeable

A generic processor run in the Overseer, used for handling items added to a distributed work queue. Has support for handling exclusive tasks (i.e. tasks that should not run in parallel with each other).

An OverseerTaskProcessor.OverseerMessageHandlerSelector determines which OverseerMessageHandler handles specific messages in the queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OverseerTaskProcessor.OverseerMessageHandlerSelector	An interface to determine which OverseerMessageHandler handles a given message.
protected class	OverseerTaskProcessor.Runner

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 int	MAX_BLOCKED_TASKS
static final int	MAX_PARALLEL_TASKS	Maximum number of overseer collection operations which can be executed concurrently
protected OverseerTaskProcessor.OverseerMessageHandlerSelector	selector
ExecutorService	tpe

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

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

Constructor Summary

Constructors

Constructor	Description
OverseerTaskProcessor(org.apache.solr.common.cloud.ZkStateReader zkStateReader, String myId, Stats stats, OverseerTaskProcessor.OverseerMessageHandlerSelector selector, OverseerNodePrioritizer prioritizer, OverseerTaskQueue workQueue, DistributedMap runningMap, DistributedMap completedMap, DistributedMap failureMap, SolrMetricsContext solrMetricsContext)

Method Summary

Modifier and Type	Method	Description
protected org.apache.solr.cloud.Overseer.LeaderStatus	amILeader()
void	close()	Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered.
protected OverseerTaskProcessor.Runner	createRunner(OverseerMessageHandler messageHandler, org.apache.solr.common.cloud.ZkNodeProps message, String operation, OverseerTaskQueue.QueueEvent head, OverseerMessageHandler.Lock lock)	Create a runner instance to execute a single task.
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
static String	getLeaderId(org.apache.solr.common.cloud.SolrZkClient zkClient)
static String	getLeaderNode(org.apache.solr.common.cloud.SolrZkClient zkClient)
String	getName()	Simple common usage name, e.g.
SolrMetricsContext	getSolrMetricsContext()	Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
static List<String>	getSortedElectionNodes(org.apache.solr.common.cloud.SolrZkClient zk, String path)
static List<String>	getSortedOverseerNodeNames(org.apache.solr.common.cloud.SolrZkClient zk)
void	initializeMetrics(SolrMetricsContext parentContext, io.opentelemetry.api.common.Attributes attributes)	Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component
boolean	isClosed()
void	run()

Methods inherited from class java.lang.Object

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

Field Details

MAX_PARALLEL_TASKS

public static final int MAX_PARALLEL_TASKS

Maximum number of overseer collection operations which can be executed concurrently

See Also:

• Constant Field Values

MAX_BLOCKED_TASKS

public static final int MAX_BLOCKED_TASKS

See Also:

• Constant Field Values

tpe

public ExecutorService tpe

selector

protected OverseerTaskProcessor.OverseerMessageHandlerSelector selector

Constructor Details

OverseerTaskProcessor

public OverseerTaskProcessor(org.apache.solr.common.cloud.ZkStateReader zkStateReader,
 String myId,
 Stats stats,
 OverseerTaskProcessor.OverseerMessageHandlerSelector selector,
 OverseerNodePrioritizer prioritizer,
 OverseerTaskQueue workQueue,
 DistributedMap runningMap,
 DistributedMap completedMap,
 DistributedMap failureMap,
 SolrMetricsContext solrMetricsContext)

Method Details

run

public void run()

Specified by:

run in interface Runnable

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
 io.opentelemetry.api.common.Attributes attributes)

Description copied from interface: SolrMetricProducer

Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - The registry that the component will initialize metrics to

attributes - Base set of attributes that will be bound to all metrics for that component

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component. This should be the child context if one was created, or null if the parent context was used.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer

close

public void close()

Description copied from interface: SolrMetricProducer

Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered. This prevents obscure memory leaks.

from: https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html While this interface method is declared to throw Exception, implementers are strongly encouraged to declare concrete implementations of the close method to throw more specific exceptions, or to throw no exception at all if the close operation cannot fail.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SolrMetricProducer

getSortedOverseerNodeNames

public static List<String> getSortedOverseerNodeNames(org.apache.solr.common.cloud.SolrZkClient zk)
                                               throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getSortedElectionNodes

public static List<String> getSortedElectionNodes(org.apache.solr.common.cloud.SolrZkClient zk,
 String path)
                                           throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getLeaderNode

public static String getLeaderNode(org.apache.solr.common.cloud.SolrZkClient zkClient)
                            throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getLeaderId

public static String getLeaderId(org.apache.solr.common.cloud.SolrZkClient zkClient)
                          throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

amILeader

protected org.apache.solr.cloud.Overseer.LeaderStatus amILeader()

isClosed

public boolean isClosed()

createRunner

protected OverseerTaskProcessor.Runner createRunner(OverseerMessageHandler messageHandler,
 org.apache.solr.common.cloud.ZkNodeProps message,
 String operation,
 OverseerTaskQueue.QueueEvent head,
 OverseerMessageHandler.Lock lock)

Create a runner instance to execute a single task. This method mosty exists to provide an extension point for tests.

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean