ApexMetricsTowerControl (apex-core-java 1.2 API)

java.lang.Object
- blasd.apex.core.metrics.ApexMetricsTowerControl

All Implemented Interfaces:

IApexMetricsTowerControl, org.springframework.beans.factory.InitializingBean
```
@ManagedResource
public class ApexMetricsTowerControl
extends Object
implements IApexMetricsTowerControl, org.springframework.beans.factory.InitializingBean
```
This class centralized events which should end being available in the JConsole, to provide details about number of events, size of events, active events

Author:

Benoit Lacelle

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.google.common.cache.LoadingCache<StartMetricEvent,org.joda.time.LocalDateTime>`	`activeTasks` Cache the `StartMetricEvent` which have not ended yet.
`protected IApexThreadDumper`	`apexThreadDumper`
`static int`	`CACHE_MAX_SIZE` Do not maintain more than this amount of active tasks
`static int`	`CACHE_TIMEOUT_MINUTES` A `StartMetricEvent` event will be discarded if we don't receive its `EndMetricEvent` event after this amount of time
`static int`	`DEFAULT_LONGRUNNINGCHECK_SECONDS`
`protected static org.slf4j.Logger`	`LOGGER`
`protected ScheduledExecutorService`	`logLongRunningES`
`protected int`	`longRunningCheckSeconds`
`static String`	`PATH_JOINER` MetricRegistry uses a String as Key.
`protected AtomicReference<ScheduledFuture<?>>`	`scheduledFuture`
`protected com.google.common.cache.LoadingCache<StartMetricEvent,StartMetricEvent>`	`verySlowTasks`

Constructor Summary

Constructors
Constructor and Description

ApexMetricsTowerControl(IApexThreadDumper apexThreadDumper)

Constructors
Constructor and Description
`ApexMetricsTowerControl(IApexThreadDumper apexThreadDumper)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected NavigableMap<Date,String>`	`convertToMapDateString(ConcurrentMap<?,org.joda.time.LocalDateTime> asMap)`
`NavigableMap<Date,String>`	`getActiveTasks()`
`long`	`getActiveTasksSize()`
`String`	`getAllThreads(boolean withoutMonitors)` This ThreadDump tends to be faster as by default, it does not collect monitors
`int`	`getLongRunningCheckSeconds()`
`long`	`getRootActiveTasksSize()`
`protected void`	`invalidate(StartMetricEvent startEvent)`
`boolean`	`invalidateActiveTasks(String name)` In some cases, we may have ghosts active tasks.
`protected void`	`invalidateStartEvent(StartMetricEvent startEvent)`
`protected void`	`logLongRunningTasks()`
`protected void`	`logOnDetectingVeryLongTask(StartMetricEvent startEvent)`
`protected void`	`logOnEndEvent(StartMetricEvent startEvent)`
`protected void`	`logOnFarTooMuchLongTask(StartMetricEvent startEvent)`
`protected Object`	`noNewLine(StartMetricEvent key)`
`void`	`onEndEvent(EndMetricEvent endEvent)`
`void`	`onStartEvent(StartMetricEvent startEvent)` It also starts a Timer
`void`	`onThrowable(Throwable t)`
`protected void`	`scheduleLogLongRunningTasks()`
`void`	`setDoRememberStack(boolean doRememberStack)`
`void`	`setLongRunningCheckSeconds(int longRunningCheckSeconds)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
  - PATH_JOINER
```
public static final String PATH_JOINER
```
    MetricRegistry uses a String as Key. PATH_JOINER is used to Convert from List to String
    
    See Also:
    
    Constant Field Values
  - CACHE_TIMEOUT_MINUTES
```
public static final int CACHE_TIMEOUT_MINUTES
```
    A StartMetricEvent event will be discarded if we don't receive its EndMetricEvent event after this amount of time
    
    See Also:
    
    Constant Field Values
  - CACHE_MAX_SIZE
```
public static final int CACHE_MAX_SIZE
```
    Do not maintain more than this amount of active tasks
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LONGRUNNINGCHECK_SECONDS
```
public static final int DEFAULT_LONGRUNNINGCHECK_SECONDS
```
    See Also:
    
    Constant Field Values
  - longRunningCheckSeconds
```
protected int longRunningCheckSeconds
```
  - activeTasks
```
protected final com.google.common.cache.LoadingCache<StartMetricEvent,org.joda.time.LocalDateTime> activeTasks
```
    Cache the StartMetricEvent which have not ended yet.
  - verySlowTasks
```
protected final com.google.common.cache.LoadingCache<StartMetricEvent,StartMetricEvent> verySlowTasks
```
  - scheduledFuture
```
protected final AtomicReference<ScheduledFuture<?>> scheduledFuture
```
  - logLongRunningES
```
protected final ScheduledExecutorService logLongRunningES
```
  - apexThreadDumper
```
protected final IApexThreadDumper apexThreadDumper
```
- Constructor Detail
  - ApexMetricsTowerControl
```
public ApexMetricsTowerControl(IApexThreadDumper apexThreadDumper)
```
- Method Detail
  - logOnFarTooMuchLongTask
```
protected void logOnFarTooMuchLongTask(StartMetricEvent startEvent)
```
  - logOnDetectingVeryLongTask
```
protected void logOnDetectingVeryLongTask(StartMetricEvent startEvent)
```
  - logOnEndEvent
```
protected void logOnEndEvent(StartMetricEvent startEvent)
```
  - getLongRunningCheckSeconds
```
@ManagedAttribute
public int getLongRunningCheckSeconds()
```
    Specified by:
    
    getLongRunningCheckSeconds in interface IApexMetricsTowerControl
  - setLongRunningCheckSeconds
```
@ManagedAttribute
public void setLongRunningCheckSeconds(int longRunningCheckSeconds)
```
    Specified by:
    
    setLongRunningCheckSeconds in interface IApexMetricsTowerControl
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - scheduleLogLongRunningTasks
```
protected void scheduleLogLongRunningTasks()
```
  - logLongRunningTasks
```
protected void logLongRunningTasks()
```
  - noNewLine
```
protected Object noNewLine(StartMetricEvent key)
```
  - onStartEvent
```
public void onStartEvent(StartMetricEvent startEvent)
```
    It also starts a Timer
    
    Parameters:
    
    startEvent -
  - onEndEvent
```
public void onEndEvent(EndMetricEvent endEvent)
```
    Parameters:
    
    endEvent - mark the task associated to this event as completed
  - onThrowable
```
public void onThrowable(Throwable t)
```
  - invalidateStartEvent
```
protected void invalidateStartEvent(StartMetricEvent startEvent)
```
  - getActiveTasksSize
```
@ManagedAttribute
public long getActiveTasksSize()
```
    Specified by:
    
    getActiveTasksSize in interface IApexMetricsTowerControl
  - getRootActiveTasksSize
```
@ManagedAttribute
public long getRootActiveTasksSize()
```
    Specified by:
    
    getRootActiveTasksSize in interface IApexMetricsTowerControl
  - getActiveTasks
```
@ManagedAttribute
public NavigableMap<Date,String> getActiveTasks()
```
    Specified by:
    
    getActiveTasks in interface IApexMetricsTowerControl
    
    Returns:
    
    a Map from the start date of the currently running operation, to the name of the operation
  - convertToMapDateString
```
protected NavigableMap<Date,String> convertToMapDateString(ConcurrentMap<?,org.joda.time.LocalDateTime> asMap)
```
  - invalidateActiveTasks
```
@ManagedOperation
public boolean invalidateActiveTasks(String name)
```
    In some cases, we may have ghosts active tasks. One can invalidate them manually through this method
    
    Parameters:
    
    name - the full name of the activeTask to invalidate
    
    Returns:
    
    true if we succeeded removing this entry
  - invalidate
```
protected void invalidate(StartMetricEvent startEvent)
```
  - setDoRememberStack
```
@ManagedOperation
public void setDoRememberStack(boolean doRememberStack)
```
  - getAllThreads
```
@ManagedOperation
public String getAllThreads(boolean withoutMonitors)
```
    This ThreadDump tends to be faster as by default, it does not collect monitors
    
    Parameters:
    
    withoutMonitors - if true (default JConsole behavior),it skips monitors and synchronizers which is much faster and prevent freezing the JVM
    
    Returns:
    
    a formatted thread-dump

Class ApexMetricsTowerControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

PATH_JOINER

CACHE_TIMEOUT_MINUTES

CACHE_MAX_SIZE

DEFAULT_LONGRUNNINGCHECK_SECONDS

longRunningCheckSeconds

activeTasks

verySlowTasks

scheduledFuture

logLongRunningES

apexThreadDumper

Constructor Detail

ApexMetricsTowerControl

Method Detail

logOnFarTooMuchLongTask

logOnDetectingVeryLongTask

logOnEndEvent

getLongRunningCheckSeconds

setLongRunningCheckSeconds

afterPropertiesSet

scheduleLogLongRunningTasks

logLongRunningTasks

noNewLine

onStartEvent

onEndEvent

onThrowable

invalidateStartEvent

getActiveTasksSize

getRootActiveTasksSize

getActiveTasks

convertToMapDateString

invalidateActiveTasks

invalidate

setDoRememberStack

getAllThreads