org.datadog.jmxfetch

Class Instance

java.lang.Object

org.datadog.jmxfetch.Instance

public class Instance
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE
static String	JVM_DIRECT
static String	PROCESS_NAME_REGEX

Constructor Summary

Constructors

Constructor and Description
Instance(Instance instance, AppConfig appConfig) Constructor, instantiates Instance based of a previous instance and appConfig.
Instance(Map<String,Object> instanceMap, Map<String,Object> initConfig, String checkName, AppConfig appConfig, ServiceNameProvider serviceNameProvider) Default constructor, builds an Instance from the provided instance map and init configs.

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Clean up config and close connection.
void	cleanUpAsync() Asynchronoush cleanup of instance, including connection.
List<String>	getBeansScopes() Returns a list of strings listing the bean scopes.
boolean	getCanonicalRateConfig() Returns a boolean describing if the canonical rate config is enabled.
String	getCheckName() Returns the check name.
Connection	getConnection(Map<String,Object> connectionParams, boolean forceNewConnection) Returns the instance connection, creates one if not already connected.
int	getMaxNumberOfMetrics() Returns the maximum number of metrics an instance may collect.
List<Metric>	getMetrics() Returns a map of metrics collected.
String	getName() Returns the instance name.
String	getServiceCheckPrefix() Returns the check prefix.
String[]	getServiceCheckTags() Returns a string array listing the service check tags.
void	init(boolean forceNewConnection) Initializes the instance.
static boolean	isDirectInstance(Map<String,Object> configInstance)
boolean	isLimitReached() Returns whether or not the instance has reached the maximum bean collection limit.
boolean	isPeriodDue(long refTime, Integer refPeriod) Returns whather or not the given period has elapsed since reference time.
boolean	timeToCollect() Returns whather or not its time to collect metrics for the instance.
String	toString() Returns a string representation for the instance.

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_NAME_REGEX

public static final String PROCESS_NAME_REGEX

See Also:

Constant Field Values

JVM_DIRECT

public static final String JVM_DIRECT

See Also:

Constant Field Values

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Instance

public Instance(Instance instance,
                AppConfig appConfig)

Constructor, instantiates Instance based of a previous instance and appConfig.

Instance

public Instance(Map<String,Object> instanceMap,
                Map<String,Object> initConfig,
                String checkName,
                AppConfig appConfig,
                ServiceNameProvider serviceNameProvider)

Default constructor, builds an Instance from the provided instance map and init configs.

Method Detail

isDirectInstance

public static boolean isDirectInstance(Map<String,Object> configInstance)

getCanonicalRateConfig

public boolean getCanonicalRateConfig()

Returns a boolean describing if the canonical rate config is enabled.

getConnection

public Connection getConnection(Map<String,Object> connectionParams,
                                boolean forceNewConnection)
                         throws IOException

Returns the instance connection, creates one if not already connected.

Throws:

IOException

init

public void init(boolean forceNewConnection)
          throws IOException,
                 FailedLoginException,
                 SecurityException

Initializes the instance. May force a new connection..

Throws:

IOException

FailedLoginException

SecurityException

toString

public String toString()

Returns a string representation for the instance.

Overrides:

toString in class Object

getMetrics

public List<Metric> getMetrics()
                        throws IOException

Returns a map of metrics collected.

Throws:

IOException

isPeriodDue

public boolean isPeriodDue(long refTime,
                           Integer refPeriod)

Returns whather or not the given period has elapsed since reference time.

timeToCollect

public boolean timeToCollect()

Returns whather or not its time to collect metrics for the instance.

getBeansScopes

public List<String> getBeansScopes()

Returns a list of strings listing the bean scopes.

getServiceCheckTags

public String[] getServiceCheckTags()

Returns a string array listing the service check tags.

getName

public String getName()

Returns the instance name.

getCheckName

public String getCheckName()

Returns the check name.

getServiceCheckPrefix

public String getServiceCheckPrefix()

Returns the check prefix.

getMaxNumberOfMetrics

public int getMaxNumberOfMetrics()

Returns the maximum number of metrics an instance may collect.

isLimitReached

public boolean isLimitReached()

Returns whether or not the instance has reached the maximum bean collection limit.

cleanUp

public void cleanUp()

Clean up config and close connection.

cleanUpAsync

public void cleanUpAsync()

Asynchronoush cleanup of instance, including connection.