org.jmxtrans.embedded

Class EmbeddedJmxTrans

java.lang.Object

org.jmxtrans.embedded.EmbeddedJmxTrans

All Implemented Interfaces:

EmbeddedJmxTransMBean

Direct Known Subclasses:

SpringEmbeddedJmxTrans

public class EmbeddedJmxTrans
extends Object
implements EmbeddedJmxTransMBean

JMX Queries

If the JMX query returns several mbeans (thanks to '*' or '?' wildcards), then the configured attributes are collected on all the returned mbeans.

Output Writers

OutputWriters can be defined at the query level or globally at the EmbeddedJmxTrans level. The OutputWriters that are effective for a Query are accessible via Query.getEffectiveOutputWriters()

Collected Metrics / Query Results

Default behavior is to store the query results at the query level (see Query.queryResults) to resolve the effective OutputWriters at result export time (Query.getEffectiveOutputWriters()).
The drawback is to limit the benefits of batching result to a backend (see Query.exportCollectedMetrics()) and the size limit of the results list to prevent OutOfMemoryError in case of export slowness.

An optimization would be, if only one OutputWriter is defined in the whole EmbeddedJmxTrans, to replace all the query-local result queues by one global result-queue.

Author:

Cyrille Le Clerc, Jon Stevens

Constructor Summary

Constructors

Constructor and Description
EmbeddedJmxTrans()
EmbeddedJmxTrans(MBeanServer mbeanServer)

Method Summary

Methods

Modifier and Type	Method and Description
void	addQuery(Query query)
void	collectMetrics() Exposed for manual / JMX invocation
void	exportCollectedMetrics() Exposed for manual / JMX invocation
int	getCollectedMetricsCount()
int	getCollectionCount()
long	getCollectionDurationInMillis()
long	getCollectionDurationInNanos()
int	getDiscardedResultsCount()
int	getExportBatchSize() Max number of QueryResult exported at each call of OutputWriter.write(Iterable)
int	getExportCount()
long	getExportDurationInMillis()
long	getExportDurationInNanos()
int	getExportedMetricsCount()
int	getExportIntervalInSeconds()
MBeanServer	getMbeanServer()
int	getNumExportThreads()
int	getNumQueryThreads()
Set<OutputWriter>	getOutputWriters()
List<Query>	getQueries()
int	getQueryIntervalInSeconds()
void	setExportBatchSize(int exportBatchSize)
void	setExportIntervalInSeconds(int exportIntervalInSeconds)
void	setNumExportThreads(int numExportThreads)
void	setNumQueryThreads(int numQueryThreads)
void	setQueryIntervalInSeconds(int queryIntervalInSeconds)
void	start() Start the exporter: initialize underlying queries, start scheduled executors, register shutdown hook
void	stop() Stop scheduled executors and collect-and-export metrics one last time.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedJmxTrans

public EmbeddedJmxTrans()

EmbeddedJmxTrans

public EmbeddedJmxTrans(MBeanServer mbeanServer)

Method Detail

start

@PostConstruct
public void start()
           throws Exception

Start the exporter: initialize underlying queries, start scheduled executors, register shutdown hook

Throws:

Exception

stop

@PreDestroy
public void stop()
          throws Exception

Stop scheduled executors and collect-and-export metrics one last time.

Throws:

Exception

collectMetrics

public void collectMetrics()

Exposed for manual / JMX invocation

Specified by:

collectMetrics in interface EmbeddedJmxTransMBean

exportCollectedMetrics

public void exportCollectedMetrics()

Exposed for manual / JMX invocation

Specified by:

exportCollectedMetrics in interface EmbeddedJmxTransMBean

getQueries

@Nonnull
public List<Query> getQueries()

addQuery

public void addQuery(@Nonnull
            Query query)

toString

public String toString()

Overrides:

toString in class Object

getNumQueryThreads

public int getNumQueryThreads()

Specified by:

getNumQueryThreads in interface EmbeddedJmxTransMBean

setNumQueryThreads

public void setNumQueryThreads(int numQueryThreads)

getQueryIntervalInSeconds

public int getQueryIntervalInSeconds()

Specified by:

getQueryIntervalInSeconds in interface EmbeddedJmxTransMBean

setQueryIntervalInSeconds

public void setQueryIntervalInSeconds(int queryIntervalInSeconds)

getExportIntervalInSeconds

public int getExportIntervalInSeconds()

Specified by:

getExportIntervalInSeconds in interface EmbeddedJmxTransMBean

setExportIntervalInSeconds

public void setExportIntervalInSeconds(int exportIntervalInSeconds)

getNumExportThreads

public int getNumExportThreads()

Specified by:

getNumExportThreads in interface EmbeddedJmxTransMBean

setNumExportThreads

public void setNumExportThreads(int numExportThreads)

getOutputWriters

@Nonnull
public Set<OutputWriter> getOutputWriters()

getExportBatchSize

public int getExportBatchSize()

Max number of QueryResult exported at each call of OutputWriter.write(Iterable)

setExportBatchSize

public void setExportBatchSize(int exportBatchSize)

getMbeanServer

@Nonnull
public MBeanServer getMbeanServer()

getCollectedMetricsCount

public int getCollectedMetricsCount()

Specified by:

getCollectedMetricsCount in interface EmbeddedJmxTransMBean

getCollectionDurationInNanos

public long getCollectionDurationInNanos()

Specified by:

getCollectionDurationInNanos in interface EmbeddedJmxTransMBean

getCollectionDurationInMillis

public long getCollectionDurationInMillis()

Specified by:

getCollectionDurationInMillis in interface EmbeddedJmxTransMBean

getCollectionCount

public int getCollectionCount()

Specified by:

getCollectionCount in interface EmbeddedJmxTransMBean

getExportedMetricsCount

public int getExportedMetricsCount()

Specified by:

getExportedMetricsCount in interface EmbeddedJmxTransMBean

getExportDurationInNanos

public long getExportDurationInNanos()

Specified by:

getExportDurationInNanos in interface EmbeddedJmxTransMBean

getExportDurationInMillis

public long getExportDurationInMillis()

Specified by:

getExportDurationInMillis in interface EmbeddedJmxTransMBean

getExportCount

public int getExportCount()

Specified by:

getExportCount in interface EmbeddedJmxTransMBean

getDiscardedResultsCount

public int getDiscardedResultsCount()

Specified by:

getDiscardedResultsCount in interface EmbeddedJmxTransMBean