---

rmLeakyBucketConfiguration Struct Reference

#include <ResourceMonitorTypes.h>

List of all members.

Public Attributes
rmValue	bucketSize
	container for the maximum bucket level. More...
rmValue	fillValue
	container for the periodic fill value. More...
posix_log_severity_t	eventSeverity
	used to log a leaky bucket event to the event log, see POSIX event log draft standard See also: ME_EVENT_TYPE_BASE ME_ThresholdEventLogMessageFormat. More...

---

Detailed Description

• Description A "leaky bucket" monitors the rate of increase of a counter statistic. The rate a counter increases (the rate the bucket leaks) is measured against the an acceptable rate of increase (the rate the bucket is filled). An exception occurs when over a variable period of time the bucket size <= period * (counter increase/period - fill value/sample interval).

• Algorithm The bucket level is initially filled to it's maximum level or bucketSize. The bucket level is decremented by the difference between the current statistic reading and the previous reading. Readings are taken at the sampling frequency defined by the monitoringRate parameter in rmMonitorControl. The bucket is also filled with the fillValue on every sample before being decremented, but the bucket level can never exceed the bucketSize. Leaky Bucket Exceptions occur when the bucket level goes to zero. An event log record is then logged with a severity of eventSeverity, the bucket is refilled to its maximum level of bucketSize, and monitoring continues. Stated another way, an exception will occur if the bucketSize <= the change in the counter during a time period - (fillValue / monitoringRate) * time period.

• Reporting For daemon monitors the eventing can be throttled by the rmMonitorControl parameters. All leaky bucket configuration parameters can be modified after a daemon monitor is created. If fillValue is >= bucketSize, ResourceMonitor::rmSetMonitorConfiguration and ResourceMonitor::rmCreateMonitor returns an ERANGE error.

  See also:

  rmMonitorConfiguration rmLeakyBucketControl RMbucketSize RMfillValue , RMleakyBucketEventSeverity ResourceMonitor::rmSetMonitorConfiguration

  Note:

  Since statistic transforms effectively turn any statistic into a guage, the Leaky Bucket monitor should no be used with transforms because it only works predictably with counters.

---

Member Data Documentation

rmValue rmLeakyBucketConfiguration::bucketSize

container for the maximum bucket level.

posix_log_severity_t rmLeakyBucketConfiguration::eventSeverity

used to log a leaky bucket event to the event log, see POSIX event log draft standard See also: ME_EVENT_TYPE_BASE ME_ThresholdEventLogMessageFormat.

rmValue rmLeakyBucketConfiguration::fillValue

container for the periodic fill value.

---

The documentation for this struct was generated from the following file:

• /root/resourcemonitord/resourcemonitord/ResourceMonitorTypes.h

---