Creating a Custom Metric Family › Understanding the Metric Family XML Structure › AttributeGroup (Metric Family) › Polled and Baseline Attributes

Polled and Baseline Attributes

The following information describes the polled and baseline attribute elements:

Baseline

Indicates whether to calculate a mean value for this attribute. If it is set to true, a corresponding BaselineList definition must be defined.

Note: The Baseline attribute requires that the StandardDeviation attribute is set to true.

Can be updated: Yes

Possible values: true, false

Effect of updating: Baseline values are calculated when true.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Maximum

Indicates whether to calculate the maximum of this attribute during the rollup. Creates a 'max_' column in the database table. If RollupStrategy is defined, this attribute must also be defined.

Can be updated: Yes

Possible values: true, false

Effect of updating: True provides a calculation of, and a reporting field for, “Maximum.”

When does the update take effect: Next poll

Required actions for updates to take effect: None

Minimum

Indicates whether to calculate the minimum of this attribute during the rollup. Creates a 'min_' column in the database table. If RollupStrategy is defined, this attribute must also be defined.

Can be updated: Yes

Possible values: true, false

Effect of updating: True provides a calculation of, and a reporting field for, “Minimum.”

When does the update take effect: Next poll

Required actions for updates to take effect: None

StandardDeviation

Indicates whether to calculate the standard deviation of this attribute during the rollup. Creates a 'std_' column in the database table. If RollupStrategy is defined, this attribute must also be defined.

Can be updated: Yes

Possible values: true, false

Effect of updating: True provides a calculation of, and a reporting field for, “Standard Deviation.”

When does the update take effect: Next poll

Required actions for updates to take effect: None

DeviationFromBaseline

Requires that the Baseline attribute is set to true. Provides two extra reporting fields, “Average Baseline” and “Percent Deviation,” calculated using baseline data. These fields are not available for building custom views. No changes are made to the database table.

Can be updated: Yes

Possible values: true, false

Effect of updating: True provides the “Average Baseline” and “Percent Deviation” fields for the internal report development.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Percentile

Indicates whether to calculate the 95^th percentile of this attribute during the rollup. Creates a 'pct_' column in the database table. If RollupStrategy is defined, this attribute must also be defined.

Can be updated: Yes

Possible values: 0 (zero), 95

Effect of updating: A value of 95 provides a calculation of, and a reporting field for, “95^th Percentile.” Zero means that no calculation is performed, and the reporting field is not available.

When does the update take effect: Next poll

Required actions for updates to take effect: None

RollupStrategy

Specifies the operation that is performed every cycle during the rollup of the individually polled values. When Polled and IsDbColumn are set to true, this element is required.

Can be updated: Yes

Possible values: Sum (a summation for counters), Avg (an average for gauges)

Effect of updating: The specified strategy is used to perform rollup calculations.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Rate

Provides an extra reporting field, “Average Rate,” calculated as AVG (metric value / time). No changes are made to the database table.

Note: The Rate is available for reporting but not for use when monitoring the profile event rules.

Can be updated: Yes

Possible values: true, false

Effect of updating: Provides the “Average Rate” field for reporting.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Units

Specifies the name of the units label used in reports. The actual label that is displayed is translated according to the language setting of the report.

Can be updated: Yes

Possible values: Percent, Packets, PacketsPerSecond, DiscardedPackets, DiscardedPacketsPerSecond, ErroredPackets, ErroredPacketsPerSecond, Bits, BitsPerSecond, Bytes, BytesPerSecond, Microseconds, Milliseconds, UnixTime

Effect of updating: The specified units label is displayed in reports.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Example: Using polled and baseline attribute elements

<Attribute name="Utilization" type="double">

<AttributeDisplayName>Utilization</AttributeDisplayName>
<AttributeAbbreviation>Utilization</AttributeAbbreviation>
<IsDbColumn>true</IsDbColumn>
<Baseline>true</Baseline>
<Minimum>true</Minimum>
<Maximum>true</Maximum>
<RollupStrategy>Avg</RollupStrategy>
<StandardDeviation>true</StandardDeviation>
<DeviationFromBaseline>true</DeviationFromBaseline>
<Percentile>95</Percentile>
<Polled>true</Polled>
<Units>Percent</Units>

</Attribute>