org.apache.brooklyn.policy.enricher

Class HttpLatencyDetector

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

org.apache.brooklyn.policy.enricher.HttpLatencyDetector

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, BrooklynObjectInternal

public class HttpLatencyDetector
extends AbstractEnricher
implements Enricher

An Enricher which computes latency in accessing a URL. See comments on the methods in the static builder() this exposes.

This is currently tested against relatively simple GET requests, optionally returned from sensors. It does not currently support POST and has limited support for https.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpLatencyDetector.Builder

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

Modifier and Type	Field and Description
static Duration	LATENCY_WINDOW_DEFAULT_PERIOD
static ConfigKey<Duration>	PERIOD
static AttributeSensor<java.lang.Double>	REQUEST_LATENCY_IN_SECONDS_IN_WINDOW
static AttributeSensor<java.lang.Double>	REQUEST_LATENCY_IN_SECONDS_MOST_RECENT
static ConfigKey<java.lang.Boolean>	REQUIRE_SERVICE_UP
static ConfigKey<Duration>	ROLLUP_WINDOW_SIZE
static ConfigKey<?>	URL
static ConfigKey<<any>>	URL_POST_PROCESSING
static ConfigKey<AttributeSensor<?>>	URL_SENSOR

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

Constructor Summary

Constructors

Constructor and Description
HttpLatencyDetector()

Method Summary

Modifier and Type	Method and Description
static HttpLatencyDetector.Builder	builder()
void	destroy() Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method
void	setEntity(EntityLocal entity)
void	updateEnablement() refreshes whether the latency detection feed should be enabled, based on e.g.

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, 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, init, 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

getEnricherType, getId, getRebindSupport, relations

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

Field Detail

LATENCY_WINDOW_DEFAULT_PERIOD

public static final Duration LATENCY_WINDOW_DEFAULT_PERIOD

URL

public static final ConfigKey<?> URL

URL_SENSOR

public static final ConfigKey<AttributeSensor<?>> URL_SENSOR

URL_POST_PROCESSING

public static final ConfigKey<<any>> URL_POST_PROCESSING

ROLLUP_WINDOW_SIZE

public static final ConfigKey<Duration> ROLLUP_WINDOW_SIZE

REQUIRE_SERVICE_UP

public static final ConfigKey<java.lang.Boolean> REQUIRE_SERVICE_UP

PERIOD

public static final ConfigKey<Duration> PERIOD

REQUEST_LATENCY_IN_SECONDS_MOST_RECENT

public static final AttributeSensor<java.lang.Double> REQUEST_LATENCY_IN_SECONDS_MOST_RECENT

REQUEST_LATENCY_IN_SECONDS_IN_WINDOW

public static final AttributeSensor<java.lang.Double> REQUEST_LATENCY_IN_SECONDS_IN_WINDOW

Constructor Detail

HttpLatencyDetector

public HttpLatencyDetector()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEnricher

updateEnablement

public void updateEnablement()

refreshes whether the latency detection feed should be enabled, based on e.g. service up, the URL sensor, etc

destroy

public void destroy()

Description copied from class: AbstractEntityAdjunct

Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method

Overrides:

destroy in class AbstractEntityAdjunct

builder

public static HttpLatencyDetector.Builder builder()