Package org.apache.solr.store.hdfs

Class HdfsLocalityReporter

java.lang.Object

org.apache.solr.store.hdfs.HdfsLocalityReporter

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer

@Deprecated
public class HdfsLocalityReporter
extends Object
implements SolrInfoBean, SolrMetricProducer

Deprecated.

since 8.6

Nested Class Summary

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	LOCALITY_BLOCKS_LOCAL	Deprecated.
static String	LOCALITY_BLOCKS_RATIO	Deprecated.
static String	LOCALITY_BLOCKS_TOTAL	Deprecated.
static String	LOCALITY_BYTES_LOCAL	Deprecated.
static String	LOCALITY_BYTES_RATIO	Deprecated.
static String	LOCALITY_BYTES_TOTAL	Deprecated.

Constructor Summary

Constructors

Constructor	Description
HdfsLocalityReporter()	Deprecated.

Method Summary

Modifier and Type	Method	Description
SolrInfoBean.Category	getCategory()	Deprecated. Category of this component
String	getDescription()	Deprecated. Simple one or two line description
Set<String>	getMetricNames()	Deprecated. Modifiable set of metric names that this component reports (default is null, which means none).
com.codahale.metrics.MetricRegistry	getMetricRegistry()	Deprecated. An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).
String	getName()	Deprecated. Simple common usage name, e.g.
SolrMetricsContext	getSolrMetricsContext()	Deprecated. Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
void	initializeMetrics(SolrMetricsContext parentContext, String scope)	Deprecated. Provide statistics on HDFS block locality, both in terms of bytes and block counts.
void	registerDirectory(HdfsDirectory dir)	Deprecated. Add a directory for block locality reporting.
void	setHost(String hostname)	Deprecated. Set the host name to use when determining locality

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.core.SolrInfoBean

getMetricsSnapshot, registerMetricName

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

close, initializeMetrics

Field Detail

LOCALITY_BYTES_TOTAL

public static final String LOCALITY_BYTES_TOTAL

Deprecated.

See Also:

Constant Field Values

LOCALITY_BYTES_LOCAL

public static final String LOCALITY_BYTES_LOCAL

Deprecated.

See Also:

Constant Field Values

LOCALITY_BYTES_RATIO

public static final String LOCALITY_BYTES_RATIO

Deprecated.

See Also:

Constant Field Values

LOCALITY_BLOCKS_TOTAL

public static final String LOCALITY_BLOCKS_TOTAL

Deprecated.

See Also:

Constant Field Values

LOCALITY_BLOCKS_LOCAL

public static final String LOCALITY_BLOCKS_LOCAL

Deprecated.

See Also:

Constant Field Values

LOCALITY_BLOCKS_RATIO

public static final String LOCALITY_BLOCKS_RATIO

Deprecated.

See Also:

Constant Field Values

Constructor Detail

HdfsLocalityReporter

public HdfsLocalityReporter()

Deprecated.

Method Detail

setHost

public void setHost(String hostname)

Deprecated.

Set the host name to use when determining locality

Parameters:

hostname - The name of this host; should correspond to what HDFS Data Nodes think this is.

getName

public String getName()

Deprecated.

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()

Deprecated.

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Deprecated.

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Deprecated.

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Deprecated.

Description copied from interface: SolrInfoBean

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

Specified by:

getMetricRegistry in interface SolrInfoBean

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Deprecated.

Description copied from interface: SolrMetricProducer

Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
                              String scope)

Deprecated.

Provide statistics on HDFS block locality, both in terms of bytes and block counts.

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context using SolrMetricsContext.getChildContext(Object) passing this as the child.

scope - component scope

registerDirectory

public void registerDirectory(HdfsDirectory dir)

Deprecated.

Add a directory for block locality reporting. This directory will continue to be checked until its close method has been called.

Parameters:

dir - The directory to keep metrics on.