Chat now with support
Chat with Support

Foglight for JMX 5.9.8 - User Guide

Foglight for JMX System Requirements Installing Foglight for JMX Managing JMX Agents Managing MBean Server Models Monitoring and Investigating JMX Data

Creating MBean Server Models

In order to collect MBean data you must first create an MBean Server Model to define the metrics, attributes, and MBean relationships. Foglight for JMX includes a set of default server models that you can use as a basis for your configuration.

If you are adding a new MBean server that has the same or similar structure as one of your other monitored MBean servers, you can use an existing server model to collect the same type of data. To do so, use the same procedure as for creating a server model based on a template. For more information, see Server Model Templates.

Alternatively, you can create a completely custom server model if your MBean server has different data to collect.

To create an MBean server model:
1
On the navigation panel, under Dashboards, click Application Servers> Administration > JMX.
2
On the JMX view, click Create Server Model...
3
Type an identifier (ID) for the server model you are creating. The ID can contain alphanumeric characters and underscores. Special characters are not supported.
4
Optional — Type a name for the server model in the Name box. If no name is specified, the name defaults to the ID.
5
Optional — Type a description for the server model in the Description box.
 
* 
NOTE: You can change these values later, if necessary. For more information see “Editing Server Model Properties” on page 36.
6
Assign the server model to a server group. A group is typically used to represent the domain, cluster, or any other logical or administrative grouping, to which an MBean server belongs.
Do one of the following:
•
Assign the model to the Default MBean Server Group. This is the default option.
•
Define a new server group. In the Assigned Server Group list, select Define new group. Type a name for the group in the Name box.
•
Select an existing group. In the Assigned Server Group list, select the server group you want the server model to belong to.
7
Click Create.
8
In the progress dialog box that opens, click OK.
Next Steps:

To view the details of, or edit the server model, use the Server Model Editor dashboard. You can access this dashboard by clicking the server model name on the JMX Administration dashboard. For more information, see:

•
Adding a Root Type to an MBean Server Model
•
Editing MBean Server Models

Adding a Root Type to an MBean Server Model

Before the agent can collect metrics using the newly-created server model, you must add at least one root type, and configure the monitored MBean instances. Server models that are based on one of the Server Model Templates have pre-defined root types. If you are creating a server model that is not based on a template, you must manually add at least one root type.

To add a root type to an MBean server model:
1
On the navigation panel, under Dashboards, click Application Servers> Administration > JMX.
2
On the JMX view, click the name of the newly created Server Model.
3
In the list that opens, select Edit.
4
On the Server Model Editor dashboard, click Add Root Type.
 
* 
NOTE: Adding at least one type is required in order to collect metrics.
The Add Root MBean Type wizard opens.
5
On the MBean Type page, select a type to make available as root type.
a
Select a type from the list.
b
Optional — Click Rediscover Types and select a connected server to inspect it for any newly added or previously undiscovered types.
•
Select one or more connected servers and click Rediscover.
•
When finished, click OK to close the dialog box.
c
If you do not want to define monitored instances, collected attributes, and exposed relationships, click Finish.
Otherwise, click Next.
6
On the Monitored Instances page, define the instances to monitor by default.
Select one of the following options:
•
Do not monitor — Select this option to disable collection for the selected MBean type.
•
Monitor all available instances — Select this option to monitor all instances that are available for the MBean type.
•
Monitor some available instances as follows — Select this option to specify which instances to monitor by defining one of the following options:
•
Click Add Object Name Query to include or exclude instances that match the results of an object name query. In the Match Instances dialog box, type a query for the object name in the box, then click Set. Matching instances are included by default. To exclude them, clear the Include check box.
•
Click Add Regular Expression to include or exclude instances that match regular expression text. In the Match Instances dialog box, type the regular expression text in the box, then click Set. Instances with matching text are included by default. To exclude them, clear the Include check box.
Click Next.
7
On the Collected Attributes page, select and configure the attributes you want to collect.
In the Attributes table, click Edit in the row for that attribute. The Attribute dialog box opens.
 
* 
NOTE: The appearance of this dialog box changes depending on the type of the selected attribute. For example, a boolean attribute only allows you to change the Storage Type (Single Value or Observation).
For example, for an integer (int) type attribute, the following options are available:
d
To change the Unit Name, click Select and select a new unit name from the list.
 
* 
NOTE: The selected Foglight for JMX unit should be equivalent to the unit provided by the source attribute or statistic.
e
Set the Storage Type to either Single Value (for static values or configuration items) or Metric (for attributes that change frequently).
 
* 
NOTE: The data unit must match the MBean attribute unit.
If the attribute value is Metric, you can select one of the following options:
•
Unspecified: Leave the metric type unspecified. As a result, default display settings are used.
•
Running Total: Value is ever-increasing, such as Sessions Created. For a running total metric, you can also choose to calculate the following derived metrics: Delta and Rate (real numbers).
•
Instantaneous: Value varies (increases/decreases) such as Active Sessions, and Heap Used.
•
Bounded Instantaneous: Same as instantaneous (value varies) but with fixed upper and lower limits. For example: Heap Used (the upper limit is defined by the allocated memory), or Cache Hits (the upper limit is the cache access count). You can also calculate the following derived metric: Percentage.
•
High Watermark: Value represents the highest value reached so far.
•
Low Watermark: Value represents the lowest value reached so far.
f
Click OK to return to the wizard.
g
Click Next.
8
On the Exposed Relationships page, expose one or more named relationships.
An MBean relationship may be ignored, exposed as a reference relationship, or exposed as a containment relationship. References are usually made between objects that are siblings. Containing relationships are usually made between a parent and child. Containment is useful when the parent's health is impacted by the health of its children.
a
Click the text in the Relationship column of the attribute for which you want to expose a relationship. In the list that opens, select one of:
•
Ignore relationship
•
Expose as containment relationship
•
Expose as reference relationship
b
Click Next.
9
On the Display Name page, customize the display names for MBeans of this type.
a
Select one of the following options:
•
Use the default display name (equivalent to the ObjectName of an MBean instance)
•
Use a groovy script to customize the display name (type the script in the box)
For more information on how to change the display name, see Changing the Display Name of an MBean Type .
b
Click Finish.
The MBean Type appears in the Configured MBean Types table.

Editing Server Model Properties

You can change the name or description, but not the ID, of an existing server model.

To edit server model properties:
1
On the JMX view, click the name of the server model you want to edit.
2
In the list that opens, click Properties.
3
Optional — Type a new name or edit the existing one for the server model in the Name box.
4
Optional — Type a new description or update the existing one in the Description box.
5
Optional — Change the assigned server group. Use the Assigned Server Group list to select an existing group, or select Define new group and then type a new group name in the box that appears. For more information, see Creating MBean Server Models.
6
Click OK.

Exporting a Server Model

If you have an MBean server model that you want to share with others or if you want to make a back up copy, you can export the model. The file is saved in .zip format.

To export a server model:
1
On the JMX view, click the name of the server model you want to export.
2
In the list that opens, click Export.
3
In the dialog box that opens, select Save File and click OK. The file download starts automatically.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating