Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 7 MM Metrics and Features Configuration : Specifying the Path to an Alert Metric Value (and a Reference Value)

Specifying the Path to an Alert Metric Value (and a Reference Value)
When you configure an alert, you specify two values to compare, and a threshold:
The Alert Value  This field provides the path to the metric you are interested in being notified about. The path is structured as follows:
PaneType/SeriesName/CategoryValue/ValueIndex
The Reference Value  This field provides a comparison value. It can be a constant (such as a threshold number) or a different metric value on the same pane. Because it is on the same pane, you don’t have to provide the full path. The path for reference is structured as follows
SeriesName/CategoryValue/ValueIndex
The parts of the path shown above are explained in Table 28.
PaneType/SeriesName/...
To set an alert on a value in one series of a multi-series chart, specify the series name that appears in the chart in the SeriesName position of the path.
PaneType/SeriesName/CategoryValue/...
In a chart, each chart element such as a bar or a line represents a category of information. For example, in the Thread Pool Best Performers chart each thread is a category (shown as a green bar). Use the name that appears for the chart element, or in the tooltip if the full name does not display.
In a table, each row represents a category of information. The value in the first (that is, left-most) column of the row is the name of the category. Use the name of the first column as the category value.
Not used for time-based panes. (See Table 30, Pane Type Details for a listing of which panes are time based.)
To use all category values, you can use an asterisk (*) as a wild card character in the CategoryValue position. For example, "gc/$default/*/2"
If the category value is not found or is defined as "all," then all the categories in the specified series are considered for condition checking.
ElementTypePath/PaneType/SeriesName/CategoryValue/ValueIndex
Only used for tables (not for charts). (See Table 30, Pane Type Details for a listing of which panes use charts and which use tables.)
For tables, use the index of the column from which the value is taken. The first column is ignored. (It is used as the category value). The indexing begins with the second column from the left. The second column index is 0, the third column index is 1, and so on.
Specifying the Alert Message
An alert message can be a simple text string, or it can use parameters. Below are two examples showing parameter-based messages:
"{0}''s garbage collection time {2} for {1} has crossed 10% of {3} up time"
"{0}''s used memory {2} has crossed 95% of {3} max memory at {1,date,short} {1,time,short}"
The message supports the following substitutions (using Java Message Format syntax).
Specified by the condition/getproperty@path attribute.
Specified by the PaneType/SeriesName/CategoryValue/... part of the condition/getproperty@name path.
Specified by the condition/getproperty@reference attribute.

Copyright © TIBCO Software Inc. All Rights Reserved