Package org.jmxtrans.agent

Class JmxTransExporterConfiguration

java.lang.Object

org.jmxtrans.agent.JmxTransExporterConfiguration

public class JmxTransExporterConfiguration
extends Object

Author:

Cyrille Le Clerc, Kristoffer Erlandsson

Field Summary

Fields

Modifier and Type	Field	Description
protected int	collectInterval
protected TimeUnit	collectIntervalTimeUnit
protected List<Invocation>	invocations	visible for test
protected OutputWriter	outputWriter	visible for test
protected List<Query>	queries	visible for test
protected ResultNameStrategy	resultNameStrategy

Constructor Summary

Constructors

Constructor	Description
JmxTransExporterConfiguration(Document document)

Method Summary

Modifier and Type	Method	Description
void	destroy()
int	getCollectInterval()
TimeUnit	getCollectIntervalTimeUnit()
Integer	getConfigReloadInterval()
Document	getDocument()
List<Invocation>	getInvocations()
OutputWriter	getOutputWriter()
List<Query>	getQueries()
ResultNameStrategy	getResultNameStrategy()
String	toString()
JmxTransExporterConfiguration	withCollectInterval(int collectInterval, TimeUnit collectIntervalTimeUnit)
JmxTransExporterConfiguration	withConfigReloadInterval(int configReloadInterval)
JmxTransExporterConfiguration	withDiscoveryQuery(String objectName, List<String> attributes, String key, Integer position, String type, String resultAlias, Integer collectInterval)
JmxTransExporterConfiguration	withInvocation(String objectName, String operation, String resultAlias, Integer collectInterval, String type)
JmxTransExporterConfiguration	withOutputWriter(OutputWriter outputWriter)
JmxTransExporterConfiguration	withQuery(String objectName, List<String> attributes, String resultAlias)
JmxTransExporterConfiguration	withQuery(String objectName, List<String> attributes, String key, Integer position, String type, String resultAlias, Integer collectInterval)

Methods inherited from class java.lang.Object

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

Field Details

queries

protected List<Query> queries

visible for test

invocations

protected List<Invocation> invocations

visible for test

outputWriter

protected OutputWriter outputWriter

visible for test

resultNameStrategy

protected ResultNameStrategy resultNameStrategy

collectInterval

protected int collectInterval

collectIntervalTimeUnit

protected TimeUnit collectIntervalTimeUnit

Constructor Details

JmxTransExporterConfiguration

public JmxTransExporterConfiguration(Document document)

Parameters:

document - The document used when creating this configuration. Will be used to detect configuration changes in the underlying configuration file. No configuration will be read from this document - configuration has to be explicitly set with the withXxx methods.

Method Details

withQuery

public JmxTransExporterConfiguration withQuery(@Nonnull
String objectName,
@Nonnull
List<String> attributes,
@Nullable
String resultAlias)

withQuery

public JmxTransExporterConfiguration withQuery(@Nonnull
String objectName,
@Nonnull
List<String> attributes,
@Nullable
String key,
@Nullable
Integer position,
@Nullable
String type,
@Nullable
String resultAlias,
@Nullable
Integer collectInterval)

withInvocation

public JmxTransExporterConfiguration withInvocation(@Nonnull
String objectName,
@Nonnull
String operation,
@Nullable
String resultAlias,
@Nullable
Integer collectInterval,
@Nullable
String type)

withOutputWriter

public JmxTransExporterConfiguration withOutputWriter(OutputWriter outputWriter)

withCollectInterval

public JmxTransExporterConfiguration withCollectInterval(int collectInterval,
@Nonnull
TimeUnit collectIntervalTimeUnit)

withConfigReloadInterval

public JmxTransExporterConfiguration withConfigReloadInterval(int configReloadInterval)

getQueries

public List<Query> getQueries()

getInvocations

public List<Invocation> getInvocations()

getOutputWriter

public OutputWriter getOutputWriter()

getResultNameStrategy

public ResultNameStrategy getResultNameStrategy()

getCollectInterval

public int getCollectInterval()

getCollectIntervalTimeUnit

public TimeUnit getCollectIntervalTimeUnit()

toString

public String toString()

Overrides:

toString in class Object

getConfigReloadInterval

public Integer getConfigReloadInterval()

getDocument

public Document getDocument()

destroy

public void destroy()

withDiscoveryQuery

public JmxTransExporterConfiguration withDiscoveryQuery(@Nonnull
String objectName,
@Nonnull
List<String> attributes,
@Nullable
String key,
@Nullable
Integer position,
@Nullable
String type,
@Nullable
String resultAlias,
@Nullable
Integer collectInterval)