Package org.apache.solr.cluster.placement

Interface AttributeFetcher

All Known Implementing Classes:

AttributeFetcherImpl

public interface AttributeFetcher

Instances of this interface are used to fetch various attributes from nodes (and other sources) in the cluster.

Method Summary

Modifier and Type	Method	Description
AttributeValues	fetchAttributes()	Fetches all requested node attributes from all nodes passed to fetchFrom(Set) as well as non-node attributes (those requested using e.g.
AttributeFetcher	fetchFrom(Set<Node> nodes)	The set of nodes from which to fetch all node related attributes.
AttributeFetcher	requestCollectionMetrics(SolrCollection solrCollection, Set<ReplicaMetric<?>> metrics)	Request collection-level metrics.
AttributeFetcher	requestNodeMetric(NodeMetric<?> metric)	Request a node metric from each node.
AttributeFetcher	requestNodeSystemProperty(String name)	Request a given system property on each node.

Method Detail

requestNodeSystemProperty

AttributeFetcher requestNodeSystemProperty(String name)

Request a given system property on each node. To get the value use AttributeValues.getSystemProperty(Node, String)

Parameters:

name - system property name

requestNodeMetric

AttributeFetcher requestNodeMetric(NodeMetric<?> metric)

Request a node metric from each node. To get the value use AttributeValues.getNodeMetric(Node, NodeMetric)

Parameters:

metric - metric to retrieve (see NodeMetric)

requestCollectionMetrics

AttributeFetcher requestCollectionMetrics(SolrCollection solrCollection,
                                          Set<ReplicaMetric<?>> metrics)

Request collection-level metrics. To get the values use AttributeValues.getCollectionMetrics(String). Note that this request will fetch information from nodes that are relevant to the collection replicas and not the ones specified in fetchFrom(Set) (though they may overlap).

Parameters:

solrCollection - request metrics for this collection

metrics - metrics to retrieve (see ReplicaMetric)

fetchFrom

AttributeFetcher fetchFrom(Set<Node> nodes)

The set of nodes from which to fetch all node related attributes. Calling this method is mandatory if any of the requestNode* methods got called.

Parameters:

nodes - nodes to fetch from

fetchAttributes

AttributeValues fetchAttributes()

Fetches all requested node attributes from all nodes passed to fetchFrom(Set) as well as non-node attributes (those requested using e.g. requestCollectionMetrics(SolrCollection, Set).

Returns:

An instance allowing retrieval of all attributes that could be fetched.