org.jmxtrans.agent

Class JmxTransExporterConfiguration

java.lang.Object

org.jmxtrans.agent.JmxTransExporterConfiguration

public class JmxTransExporterConfiguration
extends java.lang.Object

Author:

Cyrille Le Clerc, Kristoffer Erlandsson

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
JmxTransExporterConfiguration(org.w3c.dom.Document document)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

queries

protected java.util.List<Query> queries

visible for test

invocations

protected java.util.List<Invocation> invocations

visible for test

outputWriter

protected OutputWriter outputWriter

visible for test

resultNameStrategy

protected ResultNameStrategy resultNameStrategy

collectInterval

protected int collectInterval

collectIntervalTimeUnit

protected java.util.concurrent.TimeUnit collectIntervalTimeUnit

Constructor Detail

JmxTransExporterConfiguration

public JmxTransExporterConfiguration(org.w3c.dom.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 Detail

withQuery

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

withQuery

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

withInvocation

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

withOutputWriter

public JmxTransExporterConfiguration withOutputWriter(OutputWriter outputWriter)

withCollectInterval

public JmxTransExporterConfiguration withCollectInterval(int collectInterval,
                                                         @Nonnull
                                                         java.util.concurrent.TimeUnit collectIntervalTimeUnit)

withConfigReloadInterval

public JmxTransExporterConfiguration withConfigReloadInterval(int configReloadInterval)

getQueries

public java.util.List<Query> getQueries()

getInvocations

public java.util.List<Invocation> getInvocations()

getOutputWriter

public OutputWriter getOutputWriter()

getResultNameStrategy

public ResultNameStrategy getResultNameStrategy()

getCollectInterval

public int getCollectInterval()

getCollectIntervalTimeUnit

public java.util.concurrent.TimeUnit getCollectIntervalTimeUnit()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getConfigReloadInterval

public java.lang.Integer getConfigReloadInterval()

getDocument

public org.w3c.dom.Document getDocument()

destroy

public void destroy()

withDiscoveryQuery

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