org.apache.brooklyn.policy.enricher

Class RollingMeanEnricher<T extends java.lang.Number>

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

org.apache.brooklyn.enricher.stock.AbstractTypeTransformingEnricher<T,java.lang.Double>

org.apache.brooklyn.policy.enricher.RollingMeanEnricher<T>

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, SensorEventListener<T>, BrooklynObjectInternal

public class RollingMeanEnricher<T extends java.lang.Number>
extends AbstractTypeTransformingEnricher<T,java.lang.Double>

Transforms a sensor into a rolling average based on a fixed window size. This is useful for smoothing sample type metrics, such as latency or CPU time

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

SUPPRESS_DUPLICATES

Fields inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

HIGHLIGHT_NAME_LAST_ACTION, HIGHLIGHT_NAME_LAST_CONFIRMATION, HIGHLIGHT_NAME_LAST_VIOLATION, HIGHLIGHT_NAME_TRIGGERS

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

NOOP

Constructor Summary

Constructors

Constructor and Description
RollingMeanEnricher()
RollingMeanEnricher(Entity producer, AttributeSensor<T> source, AttributeSensor<java.lang.Double> target, int windowSize) Deprecated. since 0.12.0; use EnricherSpec

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getAverage()
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
void	onEvent(SensorEvent<T> event) The SensorEvent handler method.

Methods inherited from class org.apache.brooklyn.enricher.stock.AbstractTypeTransformingEnricher

setEntity

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

getEnricherType, getRebindSupport, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, destroy, getAdjunctType, getConfig, getDisplayName, getEntity, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, isRunning, setDisplayName, setHighlights, subscriptions, tags, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, rebind, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher

getId

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct

getHighlights, getUniqueTag, isDestroyed, isRunning

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

RollingMeanEnricher

public RollingMeanEnricher()

RollingMeanEnricher

@Deprecated
public RollingMeanEnricher(Entity producer,
                                       AttributeSensor<T> source,
                                       AttributeSensor<java.lang.Double> target,
                                       int windowSize)

Deprecated. since 0.12.0; use EnricherSpec

Method Detail

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractBrooklynObject

getAverage

public java.lang.Double getAverage()

onEvent

public void onEvent(SensorEvent<T> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.