Package org.apache.solr.metrics

Class MetricsMap

java.lang.Object

org.apache.solr.metrics.MetricsMap

All Implemented Interfaces:

com.codahale.metrics.Gauge<Map<String,Object>>, com.codahale.metrics.Metric, DynamicMBean, org.apache.solr.common.MapSerializable, org.apache.solr.common.MapWriter, org.apache.solr.common.NavigableObject

public class MetricsMap
extends Object
implements com.codahale.metrics.Gauge<Map<String,Object>>, org.apache.solr.common.MapWriter, DynamicMBean

Dynamically constructed map of metrics, intentionally different from MetricSet where each metric had to be known in advance and registered separately in MetricRegistry.

Note: this awkwardly extends Gauge and not Metric because awkwardly Metric instances are not supported by MetricRegistryListener :(

Note 2: values added to this metric map should belong to the list of types supported by JMX: OpenType.ALLOWED_CLASSNAMES_LIST, otherwise only their toString() representation will be shown in JConsole.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

org.apache.solr.common.MapWriter.EntryWriter

Field Summary

Fields inherited from interface org.apache.solr.common.MapWriter

EMPTY

Constructor Summary

Constructors

Constructor	Description
MetricsMap(BiConsumer<Boolean,Map<String,Object>> mapInitializer)	Deprecated. use MetricsMap(MapWriter) instead.
MetricsMap(org.apache.solr.common.MapWriter initializer)	Create an instance that reports values to a MapWriter.

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String attribute)
AttributeList	getAttributes(String[] attributes)
MBeanInfo	getMBeanInfo()
Map<String,Object>	getValue()
Map<String,Object>	getValue(boolean detailed)
Object	invoke(String actionName, Object[] params, String[] signature)
void	setAttribute(Attribute attribute)
AttributeList	setAttributes(AttributeList attributes)
String	toString()
void	writeMap(org.apache.solr.common.MapWriter.EntryWriter ew)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.common.MapWriter

append, jsonStr, toMap

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

Constructor Detail

MetricsMap

@Deprecated(since="8.7")
public MetricsMap(BiConsumer<Boolean,Map<String,Object>> mapInitializer)

Deprecated.

use MetricsMap(MapWriter) instead.

Create an instance that reports values to a Map.

Parameters:

mapInitializer - function to populate the Map result.

MetricsMap

public MetricsMap(org.apache.solr.common.MapWriter initializer)

Create an instance that reports values to a MapWriter.

Parameters:

initializer - function to populate the MapWriter result.

Method Detail

getValue

public Map<String,Object> getValue()

Specified by:

getValue in interface com.codahale.metrics.Gauge<Map<String,Object>>

getValue

public Map<String,Object> getValue(boolean detailed)

toString

public String toString()

Overrides:

toString in class Object

getAttribute

public Object getAttribute(String attribute)
                    throws AttributeNotFoundException,
                           MBeanException,
                           ReflectionException

Specified by:

getAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

MBeanException

ReflectionException

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

Specified by:

setAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

InvalidAttributeValueException

MBeanException

ReflectionException

getAttributes

public AttributeList getAttributes(String[] attributes)

Specified by:

getAttributes in interface DynamicMBean

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Specified by:

setAttributes in interface DynamicMBean

invoke

public Object invoke(String actionName,
                     Object[] params,
                     String[] signature)
              throws MBeanException,
                     ReflectionException

Specified by:

invoke in interface DynamicMBean

Throws:

MBeanException

ReflectionException

getMBeanInfo

public MBeanInfo getMBeanInfo()

Specified by:

getMBeanInfo in interface DynamicMBean

writeMap

public void writeMap(org.apache.solr.common.MapWriter.EntryWriter ew)
              throws IOException

Specified by:

writeMap in interface org.apache.solr.common.MapWriter

Throws:

IOException