org.jmxtrans.embedded

Class Query

java.lang.Object

org.jmxtrans.embedded.Query

All Implemented Interfaces:

QueryMBean

public class Query
extends Object
implements QueryMBean

Describe a JMX query on which metrics are collected and hold the query and export business logic (collectMetrics() and exportCollectedMetrics()).

Author:

Cyrille Le Clerc, Jon Stevens

Constructor Summary

Constructors

Constructor and Description
Query(ObjectName objectName) Creates a Query on the given objectName.
Query(String objectName) Creates a Query on the given objectName.

Method Summary

Modifier and Type	Method and Description
Query	addAttribute(QueryAttribute attribute) Add the given attribute to the list attributes of this query and maintains the reverse relation (see QueryAttribute.getQuery()).
Query	addAttribute(String attributeName) Create a basic QueryAttribute, add it to the list attributes of this query and maintains the reverse relation (see QueryAttribute.getQuery()).
void	collectMetrics() Collect the values for this query and store them as QueryResult in the queryResults queue
int	exportCollectedMetrics() Export the collected metrics to the OutputWriters associated with this Query (see getEffectiveOutputWriters()).
int	getCollectedMetricsCount()
int	getCollectionCount()
long	getCollectionDurationInNanos()
int	getDiscardedResultsCount() Returns the number of discarded elements in the queryResults queue or -1 if the queue is not a DiscardingBlockingQueue.
List<OutputWriter>	getEffectiveOutputWriters() Return the outputWriters to which the collected metrics of this Query are exported, the outputWriters declared at query level or a the parent level.
EmbeddedJmxTrans	getEmbeddedJmxTrans()
int	getExportCount()
long	getExportDurationInNanos()
int	getExportedMetricsCount()
String	getId()
ObjectName	getObjectName()
List<OutputWriter>	getOutputWriters()
Collection<QueryAttribute>	getQueryAttributes()
String	getResultAlias()
BlockingQueue<QueryResult>	getResults()
void	setEmbeddedJmxTrans(EmbeddedJmxTrans embeddedJmxTrans)
void	setId(String id)
void	setResultAlias(String resultAlias)
void	setResultsQueue(BlockingQueue<QueryResult> queryResultQueue) WARNING: queryResults queue should not be changed at runtime as the operation is not thread safe.
void	start() Start all the OutputWriters attached to this Query
void	stop() Stop all the OutputWriters attached to this Query
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(@Nonnull
             String objectName)

Creates a Query on the given objectName.

Parameters:

objectName - ObjectName to query, can contain wildcards ('*' or '?')

Query

public Query(@Nonnull
             ObjectName objectName)

Creates a Query on the given objectName.

Parameters:

objectName - ObjectName to query, can contain wildcards ('*' or '?')

Method Detail

collectMetrics

public void collectMetrics()

Collect the values for this query and store them as QueryResult in the queryResults queue

Specified by:

collectMetrics in interface QueryMBean

exportCollectedMetrics

public int exportCollectedMetrics()

Export the collected metrics to the OutputWriters associated with this Query (see getEffectiveOutputWriters()). Metrics are batched according to EmbeddedJmxTrans.getExportBatchSize()

Specified by:

exportCollectedMetrics in interface QueryMBean

Returns:

the number of exported QueryResult

start

@PostConstruct
public void start()
                          throws Exception

Start all the OutputWriters attached to this Query

Throws:

Exception

stop

@PreDestroy
public void stop()
                      throws Exception

Stop all the OutputWriters attached to this Query

Throws:

Exception

getObjectName

@Nonnull
public ObjectName getObjectName()

Specified by:

getObjectName in interface QueryMBean

getQueryAttributes

@Nonnull
public Collection<QueryAttribute> getQueryAttributes()

addAttribute

@Nonnull
public Query addAttribute(@Nonnull
                                   QueryAttribute attribute)

Add the given attribute to the list attributes of this query and maintains the reverse relation (see QueryAttribute.getQuery()).

Parameters:

attribute - attribute to add

Returns:

this

addAttribute

@Nonnull
public Query addAttribute(@Nonnull
                                   String attributeName)

Create a basic QueryAttribute, add it to the list attributes of this query and maintains the reverse relation (see QueryAttribute.getQuery()).

Parameters:

attributeName - attribute to add

Returns:

this

getResults

@Nonnull
public BlockingQueue<QueryResult> getResults()

setResultsQueue

public void setResultsQueue(@Nonnull
                            BlockingQueue<QueryResult> queryResultQueue)

WARNING: queryResults queue should not be changed at runtime as the operation is not thread safe.

setResultAlias

public void setResultAlias(@Nullable
                           String resultAlias)

getEmbeddedJmxTrans

public EmbeddedJmxTrans getEmbeddedJmxTrans()

setEmbeddedJmxTrans

public void setEmbeddedJmxTrans(EmbeddedJmxTrans embeddedJmxTrans)

getEffectiveOutputWriters

@Nonnull
public List<OutputWriter> getEffectiveOutputWriters()

Return the outputWriters to which the collected metrics of this Query are exported, the outputWriters declared at query level or a the parent level.

See Also:

getOutputWriters(), EmbeddedJmxTrans.getOutputWriters()

getOutputWriters

@Nonnull
public List<OutputWriter> getOutputWriters()

getResultAlias

@Nullable
public String getResultAlias()

Specified by:

getResultAlias in interface QueryMBean

toString

public String toString()

Overrides:

toString in class Object

getCollectedMetricsCount

public int getCollectedMetricsCount()

Specified by:

getCollectedMetricsCount in interface QueryMBean

getCollectionDurationInNanos

public long getCollectionDurationInNanos()

Specified by:

getCollectionDurationInNanos in interface QueryMBean

getCollectionCount

public int getCollectionCount()

Specified by:

getCollectionCount in interface QueryMBean

getExportedMetricsCount

public int getExportedMetricsCount()

Specified by:

getExportedMetricsCount in interface QueryMBean

getExportDurationInNanos

public long getExportDurationInNanos()

Specified by:

getExportDurationInNanos in interface QueryMBean

getExportCount

public int getExportCount()

Specified by:

getExportCount in interface QueryMBean

getId

public String getId()

Specified by:

getId in interface QueryMBean

setId

public void setId(String id)

getDiscardedResultsCount

public int getDiscardedResultsCount()

Returns the number of discarded elements in the queryResults queue or -1 if the queue is not a DiscardingBlockingQueue.

Specified by:

getDiscardedResultsCount in interface QueryMBean