Class InterfaceStatisticsFilter
The InterfaceStatistics Filter represents the specifications needed to
monitor for an interface statistics event on a given Network
Interface.
Comparison value is specified in the filter which will be compared
against the actual value of the parameter at poll intervals.
When poll_interval expires, the monitor compares the interface
parameter value against the specified entry value in this filter. If
poll_interval is not specified, default value for monitor interval is 300
seconds.
Comparison operations can be specified using OnepOperatorType.
Comparison value can be qualified by means of InterfaceStatisticsType indicating how the value field
should be interpreted. i.e. absolute value or rate of increase or
incremental increase/decrease since last event.
Events will start occurring when the criteria is met. Such criteria is
considered as entry criteria. After the entry criteria is met, at each
poll interval the event will keep triggering unless the entry criteria no
longer qualifies. Eg. Send event if tx_load utilization is more than 50
and keep sending events until it drops below this threshold every
minute.
However, in some cases like bursts, where the utilization may spike
momentarily, admin may need notification when the threshold is crossed
and no event until the normal level is reached. This would avoid event
noise as well as identify each spike separately This can be achieved by
means of exit criteria.
Exit criteria can optionally be specified. If specified once entry
criteria is met, event monitoring will stop until the exit criteria is
satisfied. Once exit criteria is met, it re-arms the event monitor i.e.
after exit criteria is met, the monitor will now compare against entry
criteria until entry criteria is met and when it does event is sent. And
the cycle will continue.
Exit criteria can be combined with exit_time, which specifies the time
interval after which the monitor will be re-armed.
|
__init__(self,
parameter,
entryop,
entryvalue,
entrytype)
Constructor for Interface Statistics All the other conditions than
following input parameters are set to appropriate default values. |
|
|
Inherited from object :
__delattr__ ,
__format__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__sizeof__ ,
__str__ ,
__subclasshook__
|
Enum
|
InterfaceStatisticsType = enum('ONEP_INTERFACE_STATISTICS_TYPE...
Enum indicating statistics comparison criteria types.
|
|
MAX_AVERAGEFACTOR = 64
|
|
MIN_AVERAGEFACTOR = 1
|
|
parameter = property(_get_parameter, _set_parameter, None, _doc)
|
|
poll_interval = property(_get_poll_interval, _set_poll_interva...
|
|
entry_value = property(_get_entry_value, _set_entry_value, Non...
|
|
entry_op = property(_get_entry_op, _set_entry_op, None, _doc)
|
|
entry_type = property(_get_entry_type, _set_entry_type, None, ...
|
|
exit_value = property(_get_exit_value, _set_exit_value, None, ...
|
|
exit_op = property(_get_exit_op, _set_exit_op, None, _doc)
|
|
exit_type = property(_get_exit_type, _set_exit_type, None, _doc)
|
|
exit_combination = property(_get_exit_combination, _set_exit_c...
|
|
exit_time = property(_get_exit_time, _set_exit_time, None, _doc)
|
|
exit_event = property(_get_exit_event, _set_exit_event, None, ...
|
|
average_factor = property(_get_average_factor, _set_average_fa...
|
|
is_exit_value_set = property(_is_exit_value_set, None, None, _...
|
Inherited from object :
__class__
|
__init__(self,
parameter,
entryop,
entryvalue,
entrytype)
(Constructor)
|
|
Constructor for Interface Statistics All the other conditions than
following input parameters are set to appropriate default values. Poll
interval is set to 300 seconds.
Default filter settings depict scenario where parameter value will be
checked against entryValue and if qualifies the specified operator
comparison event will be generated.
- Parameters:
- Raises:
- Overrides:
object.__init__
|
InterfaceStatisticsType
Enum indicating statistics comparison criteria types.
ONEP_INTERFACE_STATISTICS_TYPE_VALUE: Compare the parameter actual
value with entry-val argument according to the operator type specified in
operator-type argument.
ONEP_INTERFACE_STATISTICS_TYPE_INCREMENT: Increment uses the entry-val
field as an incremental difference and the entry-val is compared with the
difference between the current counter value and the value when the event
was last triggered (or the first polled sample if this is a new
event).
ONEP_INTERFACE_STATISTICS_TYPE_RATE: Rate is defined as the average
rate of change over a period of time. The time period is the
average-factor value multiplied by the poll-interval value. At each poll
interval the difference between the current sample and the previous
sample is taken and recorded as an absolute value. An average of the
previous average-factor value samples is taken to be the rate of
change.
- Type:
- Enum
- Value:
enum('ONEP_INTERFACE_STATISTICS_TYPE_VALUE', 'ONEP_INTERFACE_STATISTIC
S_TYPE_INCREMENT', 'ONEP_INTERFACE_STATISTICS_TYPE_RATE')
|
|
poll_interval
- Value:
property(_get_poll_interval, _set_poll_interval, None, _doc)
|
|
entry_value
- Value:
property(_get_entry_value, _set_entry_value, None, _doc)
|
|
entry_type
- Value:
property(_get_entry_type, _set_entry_type, None, _doc)
|
|
exit_value
- Value:
property(_get_exit_value, _set_exit_value, None, _doc)
|
|
exit_combination
- Value:
property(_get_exit_combination, _set_exit_combination, None, _doc)
|
|
exit_event
- Value:
property(_get_exit_event, _set_exit_event, None, _doc)
|
|
average_factor
- Value:
property(_get_average_factor, _set_average_factor, None, _doc)
|
|
is_exit_value_set
- Value:
property(_is_exit_value_set, None, None, _doc)
|
|