Definitions
Event
An event is based on Event dictionary (see above) and is defined by the dictionary name, and the identifier.
Any event defined in any dictionary used by the application (shipped in Fulfillment Provisioning components and in customer components) can be used for a counter.
Period manager
A period manager manages counting periods with a duration in seconds.
It can be linked to several counters. All counters linked to the same period manager are synchronized on the same counting periods.
A period manager can be started, stopped, displayed and removed.
A period manager cannot be specialized.
Data saver
A data saver manages saving of sampled counterDatas (the interval between 2 saving is in minutes).
It can be linked to several counters.
A data saver can be started, stopped, displayed and removed.
A data saver must be specialized.
Specialized data savers are provided to save counterData values in files.
Counter
A counter manages a list of counterDatas, and it is linked to one period manager and to one data saver.
A simple counter (dynamic = no) is defined to be used as one instance.
A dynamic counter (dynamic = yes) is a template from which instances are created according to a dynamic value (called a key). This key comes from the originator or a parameter of events.
A dynamic instance counter is an instance created from a dynamic counter when an event with a new value for the key occured. The name of a dynamic instance counter is made with the name of the dynamic counter and with the value of the key.
A counter can be started, stopped, displayed and removed.
There is 2 kinds of counter display:
-
Configuration display, which lists parameters of the counter and its counterDatas, filters, thresholds, dispatchers
-
Values display, which lists current values of counterDatas managed by the counter.
A counter cannot be specialized.
Raw counterData
A raw counterData is a positive integer (of type unsigned long long) updated in real time by events.
A basic raw counterData is updated with information on the received events. It can filter the received events through configuration of a filter to apply.
A computed raw counterData is updated by computing of values from other raw counterDatas.
For each raw counterData created in a counter, a basic sampled counterData with the same name is created in the same counter.
A raw counterData can only be read.
Raw counterDatas are displayed with counter configuration display.
Values of raw counterDatas are displayed with counter values display.
A basic raw counterData must be specialized. Specialized basic raw counterDatas are provided.
A computed raw counterData must be specialized. Specialized computed raw counterDatas are provided.
Sampled counterData
A sampled counterData is a positive integer (of type unsigned long long) updated at each end of counting period.
A basic sampled counterData is automatically created with the same name as a raw counterData, and it is updated with the value of this raw counterData.
A computed sampled counterData is updated by computing of values from other sampled counterDatas and/or any other data.
Sampled counterDatas can be read, and thresholds can be defined on them.
Sampled counterDatas are displayed with counter configuration display.
Values of sampled counterDatas are displayed with counter values display.
A basic sampled counterData cannot be specialized.
A computed sampled counterData must be specialized. Specialized computed sampled counterDatas are provided.
Filter
A filter allows to choose if an event received by a basic raw counterData has to be used or not.
Only one filter can be applied to one basic raw counterData.
Filters are displayed with counter configuration display.
A filter must be specialized. Specialized filters are provided.
Threshold
A threshold is applied to a sampled counterData. When the counterData value crossed the waterMarkValue of the threshold, an action is done.
With the Threshold entity provided, the action done is to publish an event.
Several thresholds can be applied to one sampled counterData.
A threshold can be started, stopped and removed.
Thresholds are displayed with counter configuration display.
A threshold can be specialized to change the action done when it is crossed.
Dispatcher
A dispatcher is applied to a dynamic counter, to calculate a key value on an event.
Several dispatchers can be applied to one dynamic counter. In fact, one dipatcher must be applied for each event used by the basic raw counterDatas defined on the dynamic counter.
Dispatchers are displayed with dynamic counter configuration display.
A dispatcher must be specialized. Specialized dispatchers are provided.