MBean configuration XML reference
Object name reference
For MBean definitions, standard JMX object name wildcard patterns * and ? are supported for the domain
and properties
attributes. See the Oracle documentation for more information.
If no values are specified for the domain
and properties
attributes, the value defaults to the * wildcard.
The add-on's modular input writes out the MBean's canonical object name to Splunk Enterprise.
Attribute polling reference
You can set the dumpAllAttributes
value to true
to extract all of an MBean's Attributes.
For example, to extract all the Attributes in the java.lang domain:
mbean domain="java.lang" properties="*" dumpAllAttributes="true"
For example, to extract all the attributes in all of the cassandra domains:
mbean domain="org.apache.cassandra." properties="" dumpAllAttributes="true"
Or, you can specify each individual attribute you want to extract using the attribute
element.
For Attributes that are multi-level (composite and tabular Attributes) use ":" delimited notation for specifying the Attribute name. See examples of this in the config.xml
included in $SPLUNK_HOME/apps/Splunk_TA_jmx/bin/config/examples
.
Operation invocation reference
The add-on supports MBean Operation invocation. You can declare Operations that return a result or not, or that take arguments or not, and index the return value. Operation overloading is supported for methods of the same name with different signatures.
The following parameter types are supported :
- int
- float
- double
- long
- short
- byte
- boolean
- char
- string
Internally these get autoboxed into their respective Object counterparts.
See config_operations_example.xml in $SPLUNK_HOME/apps/Splunk_TA_jmx/bin/config/examples
for usage scenarios.
MBean notification reference
MBean notification listening is supported simply by adding a notificationListener
element as a child of any MBean.
See config_notifications.xml
in $SPLUNK_HOME/apps/Splunk_TA_jmx/bin/config/examples
for an example configuration.
Supported return data types for operations and attributes
Single, composite, and tabular MBean Attributes are supported.
The value obtained from the Attribute or as the return type of an Operation can be:
Any primitive type (object-wrapped):
- String
- Array
- List
- Map
- Set
Collection types are recursively deeply inspected, so you can have Collections of Collections, etc.
Configure inputs for the Splunk Add-on for JMX using .conf files | Troubleshoot the Splunk Add-on for JMX |
This documentation applies to the following versions of Splunk® Supported Add-ons: released, released
Feedback submitted, thanks!