org.swisspush.gateleen.monitoring

Class MonitoringHandler

java.lang.Object

org.swisspush.gateleen.monitoring.MonitoringHandler

public class MonitoringHandler
extends Object

Handler to monitor the server state using the Metrics library. The recorded informations are accessible through JMX MBeans.

Author:

https://github.com/mcweba [Marc-Andre Weber]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MonitoringHandler.MonitoringCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_QUEUE_COUNT_METRIC
static String	DEQUEUE_METRIC
static String	ENQUEUE_METRIC
static String	LAST_USED_QUEUE_SIZE_METRIC
static String	MARK
static int	MAX_AGE_MILLISECONDS Deprecated.
static String	METRIC_ACTION
static String	METRIC_NAME
static String	PENDING_REQUESTS_METRIC
static String	QUEUES_KEY_PREFIX Deprecated.
static long	REQUEST_PER_RULE_DEFAULT_EXPIRY
static long	REQUEST_PER_RULE_DEFAULT_SAMPLING
static String	REQUEST_PER_RULE_EXPIRY_PROPERTY
static String	REQUEST_PER_RULE_PREFIX
static String	REQUEST_PER_RULE_PROPERTY
static String	REQUEST_PER_RULE_SAMPLING_PROPERTY
static String	REQUESTS_BACKENDS_NAME
static String	REQUESTS_CLIENT_NAME
static String	SET

Constructor Summary

Constructors

Constructor and Description
MonitoringHandler(io.vertx.core.Vertx vertx, io.vertx.redis.RedisClient redisClient, ResourceStorage storage, String prefix) Deprecated. use MonitoringHandler(Vertx, ResourceStorage, String) instead
MonitoringHandler(io.vertx.core.Vertx vertx, io.vertx.redis.RedisClient redisClient, ResourceStorage storage, String prefix, String requestPerRulePath) Deprecated. use MonitoringHandler(Vertx, ResourceStorage, String, String) instead
MonitoringHandler(io.vertx.core.Vertx vertx, ResourceStorage storage, String prefix)
MonitoringHandler(io.vertx.core.Vertx vertx, ResourceStorage storage, String prefix, String requestPerRulePath)

Method Summary

Modifier and Type	Method and Description
protected String	getMonitoringAddress() Get the event bus address of the monitoring.
protected String	getRedisquesAddress() Get the event bus address of redisques.
long	getRequestPerRuleExpiry()
String	getRequestPerRuleMonitoringPath()
long	getRequestPerRuleSampling()
boolean	isRequestPerRuleMonitoringActive()
long	startRequestMetricTracking(String metricName, String targetUri) Start the metric tracking for the requests defined with the metricName (routing rule)
void	stopRequestMetricTracking(String metricName, long startTime, String targetUri) Stop the metric tracking for the requests defined with the metricName (routing rule)
void	updateDequeue()
void	updateEnqueue()
void	updateIncomingRequests(io.vertx.core.http.HttpServerRequest request)
void	updateLastUsedQueueSizeInformation(String queue) Reads the size from the last used Queue from redis and stores it to JMX
void	updateQueueCountInformation() Update the count of active queues.
void	updateQueuesSizesInformation(int numQueues, boolean showEmptyQueues, MonitoringHandler.MonitoringCallback callback) Updates the information about the sizes of the top (numQueues) sized queues.
void	updateRequestPerRuleMonitoring(io.vertx.core.http.HttpServerRequest request, String metricName)
void	updateRequestsMeter(String target, String uri) Update the meter values for requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METRIC_NAME

public static final String METRIC_NAME

See Also:

Constant Field Values

METRIC_ACTION

public static final String METRIC_ACTION

See Also:

Constant Field Values

MARK

public static final String MARK

See Also:

Constant Field Values

SET

public static final String SET

See Also:

Constant Field Values

REQUESTS_CLIENT_NAME

public static final String REQUESTS_CLIENT_NAME

See Also:

Constant Field Values

REQUESTS_BACKENDS_NAME

public static final String REQUESTS_BACKENDS_NAME

See Also:

Constant Field Values

PENDING_REQUESTS_METRIC

public static final String PENDING_REQUESTS_METRIC

See Also:

Constant Field Values

ACTIVE_QUEUE_COUNT_METRIC

public static final String ACTIVE_QUEUE_COUNT_METRIC

See Also:

Constant Field Values

LAST_USED_QUEUE_SIZE_METRIC

public static final String LAST_USED_QUEUE_SIZE_METRIC

See Also:

Constant Field Values

ENQUEUE_METRIC

public static final String ENQUEUE_METRIC

See Also:

Constant Field Values

DEQUEUE_METRIC

public static final String DEQUEUE_METRIC

See Also:

Constant Field Values

QUEUES_KEY_PREFIX

@Deprecated
public static final String QUEUES_KEY_PREFIX

Deprecated.

See Also:

Constant Field Values

MAX_AGE_MILLISECONDS

@Deprecated
public static final int MAX_AGE_MILLISECONDS

Deprecated.

See Also:

Constant Field Values

REQUEST_PER_RULE_PREFIX

public static final String REQUEST_PER_RULE_PREFIX

See Also:

Constant Field Values

REQUEST_PER_RULE_PROPERTY

public static final String REQUEST_PER_RULE_PROPERTY

See Also:

Constant Field Values

REQUEST_PER_RULE_SAMPLING_PROPERTY

public static final String REQUEST_PER_RULE_SAMPLING_PROPERTY

See Also:

Constant Field Values

REQUEST_PER_RULE_EXPIRY_PROPERTY

public static final String REQUEST_PER_RULE_EXPIRY_PROPERTY

See Also:

Constant Field Values

REQUEST_PER_RULE_DEFAULT_SAMPLING

public static final long REQUEST_PER_RULE_DEFAULT_SAMPLING

See Also:

Constant Field Values

REQUEST_PER_RULE_DEFAULT_EXPIRY

public static final long REQUEST_PER_RULE_DEFAULT_EXPIRY

See Also:

Constant Field Values

Constructor Detail

MonitoringHandler

@Deprecated
public MonitoringHandler(io.vertx.core.Vertx vertx,
                                     io.vertx.redis.RedisClient redisClient,
                                     ResourceStorage storage,
                                     String prefix)

Deprecated. use MonitoringHandler(Vertx, ResourceStorage, String) instead

Constructor

MonitoringHandler

@Deprecated
public MonitoringHandler(io.vertx.core.Vertx vertx,
                                     io.vertx.redis.RedisClient redisClient,
                                     ResourceStorage storage,
                                     String prefix,
                                     String requestPerRulePath)

Deprecated. use MonitoringHandler(Vertx, ResourceStorage, String, String) instead

Constructor

MonitoringHandler

public MonitoringHandler(io.vertx.core.Vertx vertx,
                         ResourceStorage storage,
                         String prefix)

MonitoringHandler

public MonitoringHandler(io.vertx.core.Vertx vertx,
                         ResourceStorage storage,
                         String prefix,
                         String requestPerRulePath)

Method Detail

getMonitoringAddress

protected String getMonitoringAddress()

Get the event bus address of the monitoring. Override this method when you want to use a custom monitoring address

Returns:

the event bus address of monitoring

getRedisquesAddress

protected String getRedisquesAddress()

Get the event bus address of redisques. Override this method when you want to use a custom redisques address

Returns:

the event bus address of redisques

getRequestPerRuleMonitoringPath

public String getRequestPerRuleMonitoringPath()

isRequestPerRuleMonitoringActive

public boolean isRequestPerRuleMonitoringActive()

getRequestPerRuleSampling

public long getRequestPerRuleSampling()

getRequestPerRuleExpiry

public long getRequestPerRuleExpiry()

updateIncomingRequests

public void updateIncomingRequests(io.vertx.core.http.HttpServerRequest request)

updateRequestPerRuleMonitoring

public void updateRequestPerRuleMonitoring(io.vertx.core.http.HttpServerRequest request,
                                           String metricName)

updateRequestsMeter

public void updateRequestsMeter(String target,
                                String uri)

Update the meter values for requests. Requests from clients and requests to other backends are measured separately.

Parameters:

target - the target url of the request

uri - uri

startRequestMetricTracking

public long startRequestMetricTracking(String metricName,
                                       String targetUri)

Start the metric tracking for the requests defined with the metricName (routing rule)

Parameters:

metricName - the name of the metric. This name will be used as name of the JMX MBean. metricNames are defined in routing rules with the property "metricName"

targetUri - targetUri

Returns:

long

stopRequestMetricTracking

public void stopRequestMetricTracking(String metricName,
                                      long startTime,
                                      String targetUri)

Stop the metric tracking for the requests defined with the metricName (routing rule)

Parameters:

metricName - the name of the metric. This name will be used as name of the JMX MBean. metricNames are defined in routing rules with the property "metricName"

startTime - start time

targetUri - target uri

updateQueueCountInformation

public void updateQueueCountInformation()

Update the count of active queues. Reads the count from redis and stores it to JMX.

updateLastUsedQueueSizeInformation

public void updateLastUsedQueueSizeInformation(String queue)

Reads the size from the last used Queue from redis and stores it to JMX

Parameters:

queue - the name of the queue the last update was made

updateQueuesSizesInformation

public void updateQueuesSizesInformation(int numQueues,
                                         boolean showEmptyQueues,
                                         MonitoringHandler.MonitoringCallback callback)

Updates the information about the sizes of the top (numQueues) sized queues.

Parameters:

numQueues - the number of queues

showEmptyQueues - show empty queues or not

callback - the callback returning the result

updateEnqueue

public void updateEnqueue()

updateDequeue

public void updateDequeue()