org.jmxtrans.agent

Class Query

java.lang.Object

org.jmxtrans.agent.Query

All Implemented Interfaces:

Collector

Direct Known Subclasses:

DiscoveryQuery

public class Query
extends Object
implements Collector

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	attributes The attribute(s) to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String)) If empty, will fetch all attributes of the MBean.
protected String	key If the MBean attribute value is a CompositeData, the key to lookup.
protected ObjectName	objectName
protected Integer	position If the returned value is a Collectionor an array, the position of the entry to lookup.
protected String	resultAlias
protected ResultNameStrategy	resultNameStrategy

Constructor Summary

Constructors

Constructor and Description
Query(String objectName, List<String> attributes, String key, Integer position, String type, String resultAlias, ResultNameStrategy resultNameStrategy, Integer collectInterval) Creates a query that accepts a list of attributes to collect.
Query(String objectName, String attribute, int position, ResultNameStrategy resultNameStrategy)
Query(String objectName, String attribute, ResultNameStrategy resultNameStrategy)
Query(String objectName, String attribute, String key, Integer position, String type, String resultAlias, ResultNameStrategy resultNameStrategy) Creates a Query with no collectInterval overide.
Query(String objectName, String attribute, String key, Integer position, String type, String resultAlias, ResultNameStrategy resultNameStrategy, Integer collectInterval)
Query(String objectName, String attribute, String resultAlias, ResultNameStrategy resultNameStrategy)

Method Summary

Modifier and Type	Method and Description
void	collectAndExport(MBeanServer mbeanServer, OutputWriter outputWriter)
List<String>	getAttributes()
Integer	getCollectIntervalOverrideOrNull()
String	getKey()
ObjectName	getObjectName()
Integer	getPosition()
String	getResultAlias()
String	getType()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

resultNameStrategy

@Nonnull
protected ResultNameStrategy resultNameStrategy

objectName

@Nonnull
protected final ObjectName objectName

attributes

@Nonnull
protected List<String> attributes

The attribute(s) to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String)) If empty, will fetch all attributes of the MBean.

resultAlias

@Nullable
protected final String resultAlias

key

@Nullable
protected final String key

If the MBean attribute value is a CompositeData, the key to lookup.

See Also:

CompositeData.get(String)

position

@Nullable
protected final Integer position

If the returned value is a Collectionor an array, the position of the entry to lookup.

Constructor Detail

Query

public Query(@Nonnull
             String objectName,
             @Nullable
             String attribute,
             @Nonnull
             ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
             String objectName,
             @Nullable
             String attribute,
             int position,
             @Nonnull
             ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
             String objectName,
             @Nullable
             String attribute,
             @Nullable
             String resultAlias,
             @Nonnull
             ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
             String objectName,
             @Nullable
             String attribute,
             @Nullable
             String key,
             @Nullable
             Integer position,
             @Nullable
             String type,
             @Nullable
             String resultAlias,
             @Nonnull
             ResultNameStrategy resultNameStrategy)

Creates a Query with no collectInterval overide.

Query

public Query(@Nonnull
             String objectName,
             @Nullable
             String attribute,
             @Nullable
             String key,
             @Nullable
             Integer position,
             @Nullable
             String type,
             @Nullable
             String resultAlias,
             @Nonnull
             ResultNameStrategy resultNameStrategy,
             @Nullable
             Integer collectInterval)

Parameters:

objectName - The ObjectName to search for (MBeanServer.queryMBeans(javax.management.ObjectName, javax.management.QueryExp)), can contain wildcards and return several entries.

attribute - The attribute to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String))

key - if the MBean attribute value is a CompositeData, the key to lookup.

position - if the returned value is a Collection or an array, the position of the entry to lookup.

type - type of the metric ('counter', 'gauge', ...)

resultAlias -

resultNameStrategy - the ResultNameStrategy used during the collectAndExport(javax.management.MBeanServer, OutputWriter) phase.

Query

public Query(@Nonnull
             String objectName,
             @Nonnull
             List<String> attributes,
             @Nullable
             String key,
             @Nullable
             Integer position,
             @Nullable
             String type,
             @Nullable
             String resultAlias,
             @Nonnull
             ResultNameStrategy resultNameStrategy,
             @Nullable
             Integer collectInterval)

Creates a query that accepts a list of attributes to collect. If the list is empty, all attributes will be collected.

Parameters:

collectInterval -

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Method Detail

collectAndExport

public void collectAndExport(@Nonnull
                             MBeanServer mbeanServer,
                             @Nonnull
                             OutputWriter outputWriter)

Specified by:

collectAndExport in interface Collector

toString

public String toString()

Overrides:

toString in class Object

getObjectName

@Nonnull
public ObjectName getObjectName()

getResultAlias

@Nullable
public String getResultAlias()

getAttributes

@Nullable
public List<String> getAttributes()

getKey

@Nullable
public String getKey()

getPosition

@Nullable
public Integer getPosition()

getType

@Nullable
public String getType()

getCollectIntervalOverrideOrNull

@Nullable
public Integer getCollectIntervalOverrideOrNull()