com.newrelic.agent.jmx.metrics

Class BaseJmxValue

java.lang.Object

com.newrelic.agent.jmx.metrics.BaseJmxValue

public class BaseJmxValue
extends java.lang.Object

This is the base class for storing a jmx metrics.

Since:

Mar 6, 2013

Constructor Summary

Constructors

Constructor and Description
BaseJmxValue(java.lang.String pObjectName, java.lang.String pObjectMetricName, JmxAttributeFilter attributeFilter, JmxMetric[] pMetrics)
BaseJmxValue(java.lang.String pObjectName, java.lang.String pObjectMetricName, JmxAttributeFilter attributeFilter, JmxMetricModifier pModifier, JMXMetricType pType, JmxMetric[] pMetrics)
BaseJmxValue(java.lang.String pObjectName, java.lang.String pObjectMetricName, JmxMetric[] pMetrics)
BaseJmxValue(java.lang.String pObjectName, java.lang.String pObjectMetricName, JmxMetricModifier pModifier, JmxMetric[] pMetrics)

Method Summary

Modifier and Type	Method and Description
JmxAttributeFilter	getAttributeFilter()
java.util.List<JmxMetric>	getMetrics() Gets the field metrics.
JmxMetricModifier	getModifier()
java.lang.String	getObjectMetricName() Gets the field objectMetricName.
java.lang.String	getObjectNameString() Gets the field objectNameString.
JMXMetricType	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseJmxValue

public BaseJmxValue(java.lang.String pObjectName,
                    java.lang.String pObjectMetricName,
                    JmxMetric[] pMetrics)

Parameters:

pObjectName - The object name query string used to search for JMX MBeans

pObjectMetricName - A format string for agent metrics that matches against an MBean's object name. An example format would be:

  "TheRoot/Wahoo/{type}/{for:key[1::.]}/{otherKey}"
  

In the format we have placeholders such as:

• {name} which matches against a key in an object name and replaces it with a value.
• {for:%[start:end:delimiter]%} which matches against an iterated sequence of keys starting from a non-negative number start and ending it exclusively with end or unbounded if end is empty. The placeholder is replaced with an iterated set of values each separated by the delimiter or if empty "/" by default to follow the agent metric format. For example: {for:key[1::]} and {for:keyStart[1:3:.]keyEnd}

pMetrics -

BaseJmxValue

public BaseJmxValue(java.lang.String pObjectName,
                    java.lang.String pObjectMetricName,
                    JmxAttributeFilter attributeFilter,
                    JmxMetric[] pMetrics)

Parameters:

pObjectName - The object name query string used to search for JMX MBeans

pObjectMetricName - A format string for agent metrics that matches against an MBean's object name. An example format would be:

  "TheRoot/Wahoo/{type}/{for:key[1::.]}/{otherKey}"
  

In the format we have placeholders such as:

• {name} which matches against a key in an object name and replaces it with a value.
• {for:%[start:end:delimiter]%} which matches against an iterated sequence of keys starting from a non-negative number start and ending it exclusively with end or unbounded if end is empty. The placeholder is replaced with an iterated set of values each separated by the delimiter or if empty "/" by default to follow the agent metric format. For example: {for:key[1::]} and {for:keyStart[1:3:.]keyEnd}

attributeFilter -

pMetrics -

BaseJmxValue

public BaseJmxValue(java.lang.String pObjectName,
                    java.lang.String pObjectMetricName,
                    JmxMetricModifier pModifier,
                    JmxMetric[] pMetrics)

Parameters:

pObjectName - The object name query string used to search for JMX MBeans

pObjectMetricName - A format string for agent metrics that matches against an MBean's object name. An example format would be:

  "TheRoot/Wahoo/{type}/{for:key[1::.]}/{otherKey}"
  

In the format we have placeholders such as:

• {name} which matches against a key in an object name and replaces it with a value.
• {for:%[start:end:delimiter]%} which matches against an iterated sequence of keys starting from a non-negative number start and ending it exclusively with end or unbounded if end is empty. The placeholder is replaced with an iterated set of values each separated by the delimiter or if empty "/" by default to follow the agent metric format. For example: {for:key[1::]} and {for:keyStart[1:3:.]keyEnd}

pModifier -

pMetrics -

BaseJmxValue

public BaseJmxValue(java.lang.String pObjectName,
                    java.lang.String pObjectMetricName,
                    JmxAttributeFilter attributeFilter,
                    JmxMetricModifier pModifier,
                    JMXMetricType pType,
                    JmxMetric[] pMetrics)

Parameters:

pObjectName - The object name query string used to search for JMX MBeans

pObjectMetricName - A format string for agent metrics that matches against an MBean's object name. An example format would be:

  "TheRoot/Wahoo/{type}/{for:key[1::.]}/{otherKey}"
  

In the format we have placeholders such as:

• {name} which matches against a key in an object name and replaces it with a value.
• {for:%[start:end:delimiter]%} which matches against an iterated sequence of keys starting from a non-negative number start and ending it exclusively with end or unbounded if end is empty. The placeholder is replaced with an iterated set of values each separated by the delimiter or if empty "/" by default to follow the agent metric format. For example: {for:key[1::]} and {for:keyStart[1:3:.]keyEnd}

attributeFilter -

pModifier -

pType -

pMetrics -

Method Detail

getObjectNameString

public java.lang.String getObjectNameString()

Gets the field objectNameString.

Returns:

the objectNameString

getObjectMetricName

public java.lang.String getObjectMetricName()

Gets the field objectMetricName.

Returns:

the objectMetricName

getMetrics

public java.util.List<JmxMetric> getMetrics()

Gets the field metrics.

Returns:

the metrics

getAttributeFilter

public JmxAttributeFilter getAttributeFilter()

getType

public JMXMetricType getType()

getModifier

public JmxMetricModifier getModifier()