JMX plugins

1. Sign in to DESK and go to Settings > Monitoring > Monitored technologies and click Add new technology monitoring. Of the four available options, one is Monitor Java or WebSphere based technologies. Click Add JMX/PMI plugin.
2. Click Use JMX/PMI plugins editor.
3. Type the plugin name. You can only use letters A-Z, a-z, numbers 0-9, or -/_.
4. Add the metrics source.

• Select one of the available technologies.
• Based on your selection, the editor will suggest the Java process as a source for your metrics. This narrows the list of available MBeans or PMI modules you will use in the next step. The technology behind the process determines whether you'll browse JMX MBeans or PMI modules. Click Add metrics source to use a suggested source. Click to select a different process. When selecting it, you can narrow the list of available processes by choosing a particular host or Management Zone.

4. When the metrics list is downloaded, click the Add metric button to start creating your plugin.

   Domain

   Select the domain.

   Select key properties

   Key properties filter the list of available MBeans. Note that property values can contain wildcards. Select Exact match to filter MBeans list only to the entries matching the exact key property values.

   Select MBean

   Select one MBean from the list or leave All matching MBeans option. If more than one MBean is matched, this will cause the aggregation of attributes from all matching MBeans into one metric. You will define the aggregation type below.

   Select attribute

   The attributes available in the list are only the numeric ones. To see other attributes, for example attributes of the String type, select Include non-numeric attributes. Note that selected attributes must be parsable to double, or boolean type. Otherwise, DESK OneAgent will not collect any data from such a metric.

   Display name

   You can define a custom display name for the metric.

   Unit

   Select the metric unit.

   Aggregation

   Select the aggregation method if you're pulling an attribute from a number of matching Mbeans.

   Calculation

   Delta calculates the change in values of the given attribute. Rate calculates the rate of changes per seconds. When you select both, you can convert an absolute attribute (eg. Request Count) to a rate (eg. Requests per Second). Value = attribute / query interval.

   Dimension

   You can segment the metric using any MBean's key property as a dimension. Select Metric dimension and choose one of the available key properties as a dimension.

Creating the PMI plugin

Creating the PMI plugin is very similar to the JMX plugin. PMI Module translates to JMX Mbean and statistics to attributes. All other settings behave accordingly.

Saving the plugin

After you add the metric, you can still edit or delete its definition. You must click the Save button to register the plugin and start collecting data from all Java processes that contain defined MBeans. After you save the plugin, you cannot edit or delete the metrics, as this way we're able to maintain the continuity of your data. You can still add the new metrics. This time however, you won't be able to select the base Java process, because you will use a process where the plugin is already deployed.

Customizing your plugin

The DESK JMX plugins are highly customizable beyond the capabilities of the editor. You can download your plugin and edit its JSON file that describes your JMX metrics and how you want to display them. For complete instructions and examples, see the DESK JMX Extensions on GitHub.