Sonic Management API

com.sonicsw.mf.common.metrics
Interface IValueType


public interface IValueType

Metric values are one of the types described in this interface. A given metric's value type can be obtained from the metric's meta-data (see IMetricInfo).


Field Summary
static short AVERAGE
          A metric of this type repesents the average of all the values in a set of historical values.
static short COUNT
          A metric of this type repesents the number of times a value is updated.
static java.lang.String[] DESCRIPTIONS
          A textual description of the value type may be obtained using a value type as an index into the array.
static short MAXIMUM
          A metric of this type repesents the maximum value from a set of historical values.
static short MINIMUM
          A metric of this type repesents the minimum value from a set of historical values.
static int NUM_VALUE_TYPES
          The number of default value types
static short PEAK_PER_HOUR_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 3600000
static short PEAK_PER_MINUTE_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 60000
static short PEAK_PER_SECOND_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 1000
static short PEAK_UTILIZATION
          A metric of this type repesents:   (a / b) * c where:   a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 100
static short PER_HOUR_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 3600000
static short PER_MINUTE_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 60000
static short PER_SECOND_RATE
          A metric of this type repesents:   (a / b) * c where:   a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 1000
static short TOTAL
          A metric of this type repesents the total of all the values in a set of historical values.
static short UTILIZATION
          A metric of this type repesents:   (a / b) * c where:   a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 100
static short VALUE
          A metric of this type repesents a value captured at a point in time.
 

Field Detail

AVERAGE

static final short AVERAGE
A metric of this type repesents the average of all the values in a set of historical values.

See Also:
Constant Field Values

COUNT

static final short COUNT
A metric of this type repesents the number of times a value is updated.

See Also:
Constant Field Values

DESCRIPTIONS

static final java.lang.String[] DESCRIPTIONS
A textual description of the value type may be obtained using a value type as an index into the array.

See Also:
IMetricInfo.getValueType()

MAXIMUM

static final short MAXIMUM
A metric of this type repesents the maximum value from a set of historical values.

See Also:
Constant Field Values

MINIMUM

static final short MINIMUM
A metric of this type repesents the minimum value from a set of historical values.

See Also:
Constant Field Values

NUM_VALUE_TYPES

static final int NUM_VALUE_TYPES
The number of default value types

See Also:
Constant Field Values

PEAK_PER_HOUR_RATE

static final short PEAK_PER_HOUR_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 3600000

See Also:
Constant Field Values

PEAK_PER_MINUTE_RATE

static final short PEAK_PER_MINUTE_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 60000

See Also:
Constant Field Values

PEAK_PER_SECOND_RATE

static final short PEAK_PER_SECOND_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 1000

See Also:
Constant Field Values

PEAK_UTILIZATION

static final short PEAK_UTILIZATION
A metric of this type repesents:

  (a / b) * c

where:

  a = the maximum value from a set of historical values
  b = the elapsed time (milliseconds) over which the max value was collected
  c = 100

See Also:
Constant Field Values

PER_HOUR_RATE

static final short PER_HOUR_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 3600000

See Also:
Constant Field Values

PER_MINUTE_RATE

static final short PER_MINUTE_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 60000

See Also:
Constant Field Values

PER_SECOND_RATE

static final short PER_SECOND_RATE
A metric of this type repesents:

  (a / b) * c

where:

  a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 1000

See Also:
Constant Field Values

TOTAL

static final short TOTAL
A metric of this type repesents the total of all the values in a set of historical values.

See Also:
Constant Field Values

UTILIZATION

static final short UTILIZATION
A metric of this type repesents:

  (a / b) * c

where:

  a = the total of all the values in a set of historical values
  b = the elapsed time (milliseconds)
  c = 100

See Also:
Constant Field Values

VALUE

static final short VALUE
A metric of this type repesents a value captured at a point in time.

See Also:
Constant Field Values

Sonic Management API

Copyright © 2001-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.