Package org.jmxtrans.embedded

Class QueryAttribute

java.lang.Object

org.jmxtrans.embedded.QueryAttribute

public class QueryAttribute
extends Object

Describe a JMX MBean attribute to collect and hold the attribute collection logic. Collected values are sent to a BlockingQueue for later export to the target monitoring systems (see collectMetrics(javax.management.ObjectName, Object, long, java.util.Queue)).

Author:

Cyrille Le Clerc, Jon Stevens

Field Summary

Fields

Modifier and Type	Field	Description
protected ResultNameStrategy	resultNameStrategy

Constructor Summary

Constructors

Constructor	Description
QueryAttribute(String name, String type, String resultAlias)
QueryAttribute(String name, String type, String resultAlias, Collection<String> keys)

Method Summary

Modifier and Type	Method	Description
QueryAttribute	addKeys(Collection<String> newKeys)
int	collectMetrics(ObjectName objectName, Object value, long epochInMillis, Queue<QueryResult> results)
String	getName()
Query	getQuery()	Not null once this QueryAttribute has been added to its parent Query.
String	getResultAlias()
String	getType()
void	setQuery(Query query)
String	toString()
QueryAttribute	withResultNameStrategy(ResultNameStrategy strategy)

Methods inherited from class java.lang.Object

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

Field Details

resultNameStrategy

protected ResultNameStrategy resultNameStrategy

Constructor Details

QueryAttribute

public QueryAttribute(@Nonnull
String name,
@Nullable
String type,
@Nullable
String resultAlias)

Parameters:

name - name of the JMX attribute

type - type of the metric (e.g. "counter", "gauge", ...)

resultAlias - name of the result that will be exported

QueryAttribute

public QueryAttribute(@Nonnull
String name,
@Nullable
String type,
@Nullable
String resultAlias,
@Nullable
Collection<String> keys)

Parameters:

name - name of the JMX attribute

type - type of the metric (e.g. "counter", "gauge", ...)

resultAlias - name of the result that will be exported

keys - of the CompositeData to collect

Method Details

getQuery

public Query getQuery()

Not null once this QueryAttribute has been added to its parent Query.

Returns:

parent query

See Also:

Query.addAttribute(QueryAttribute)

setQuery

public void setQuery(Query query)

getName

@Nonnull
public String getName()

getResultAlias

@Nullable
public String getResultAlias()

getType

@Nullable
public String getType()

withResultNameStrategy

public QueryAttribute withResultNameStrategy(ResultNameStrategy strategy)

collectMetrics

public int collectMetrics(@Nonnull
ObjectName objectName,
@Nonnull
Object value,
long epochInMillis,
@Nonnull
Queue<QueryResult> results)

Parameters:

objectName - objectName on which the attribute was obtained.

value - value of the given attribute. A 'simple' value (String, Number, Date) or a CompositeData

epochInMillis - time at which the metric was collected

results - queue to which the the computed result(s) must be added

Returns:

collected metrics count

addKeys

@Nonnull
public QueryAttribute addKeys(@Nullable
Collection<String> newKeys)

Returns:

this

toString

public String toString()

Overrides:

toString in class Object