LoadAverage (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.utils.LoadAverage

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

JCRSessionLoadAverage, RequestLoadAverage, ThreadLoadAverage
```
public abstract class LoadAverage
extends Object
implements Runnable
```
This class makes it easy to calculate a load average, using an average calculation like the following formula: load(t) = load(t – 1) e^(-5/60m) + n (1 – e^(-5/60m)) where n = what we are evaluating over time (number of active threads, requests, etc...) and m = time in minutes over which to perform the average

Field Summary

Fields
Modifier and Type Field and Description

protected double fifteenMinuteLoad

protected double fiveMinuteLoad

protected org.slf4j.Logger logger

protected double oneMinuteLoad

Fields
Modifier and Type	Field and Description
`protected double`	`fifteenMinuteLoad`
`protected double`	`fiveMinuteLoad`
`protected org.slf4j.Logger`	`logger`
`protected double`	`oneMinuteLoad`

Constructor Summary

Constructors
Constructor and Description

LoadAverage(String threadName)

Constructors
Constructor and Description
`LoadAverage(String threadName)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract double`	`getCount()`
`String`	`getDisplayName()`
`double`	`getFifteenMinuteLoad()`
`double`	`getFiveMinuteLoad()`
`String`	`getInfo()`
`double`	`getLoggingTriggerValue()`
`double`	`getOneMinuteLoad()`
`double`	`getThreadDumpTriggerValue()`
`boolean`	`isThreadDumpOnHighLoad()`
`void`	`run()`
`void`	`setCalcFrequencyInMillisec(long millisec)` Sets the frequency, in milliseconds, at which the calculation of averages occurs.
`void`	`setDisplayName(String displayName)`
`void`	`setLoggingTriggerValue(double loggingTriggerValue)` Sets the value above which logging will be triggered for load averages.
`void`	`setThreadDumpOnHighLoad(boolean threadDumpOnHighLoad)`
`void`	`setThreadDumpTriggerValue(double threadDumpTriggerValue)`
`void`	`start()`
`void`	`stop()`
`void`	`tickCallback()`

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

- Field Detail
  - logger
```
protected final org.slf4j.Logger logger
```
  - oneMinuteLoad
```
protected double oneMinuteLoad
```
  - fiveMinuteLoad
```
protected double fiveMinuteLoad
```
  - fifteenMinuteLoad
```
protected double fifteenMinuteLoad
```
- Constructor Detail
  - LoadAverage
```
public LoadAverage(String threadName)
```
- Method Detail
  - setLoggingTriggerValue
```
public void setLoggingTriggerValue(double loggingTriggerValue)
```
    Sets the value above which logging will be triggered for load averages.
    
    Parameters:
    
    loggingTriggerValue - the value above which logging will be triggered
  - getLoggingTriggerValue
```
public double getLoggingTriggerValue()
```
  - setCalcFrequencyInMillisec
```
public void setCalcFrequencyInMillisec(long millisec)
```
    Sets the frequency, in milliseconds, at which the calculation of averages occurs.
    
    Parameters:
    
    millisec - how many milliseconds between average calculations
  - getCount
```
public abstract double getCount()
```
  - tickCallback
```
public void tickCallback()
```
  - getInfo
```
public String getInfo()
```
  - start
```
public void start()
```
  - stop
```
public void stop()
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - getOneMinuteLoad
```
public double getOneMinuteLoad()
```
  - getFiveMinuteLoad
```
public double getFiveMinuteLoad()
```
  - getFifteenMinuteLoad
```
public double getFifteenMinuteLoad()
```
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    the displayName
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Parameters:
    
    displayName - the displayName to set
  - isThreadDumpOnHighLoad
```
public boolean isThreadDumpOnHighLoad()
```
    Returns:
    
    the threadDumpOnHighLoad
  - setThreadDumpOnHighLoad
```
public void setThreadDumpOnHighLoad(boolean threadDumpOnHighLoad)
```
    Parameters:
    
    threadDumpOnHighLoad - the threadDumpOnHighLoad to set
  - getThreadDumpTriggerValue
```
public double getThreadDumpTriggerValue()
```
    Returns:
    
    the threadDumpTriggerValue
  - setThreadDumpTriggerValue
```
public void setThreadDumpTriggerValue(double threadDumpTriggerValue)
```
    Parameters:
    
    threadDumpTriggerValue - the threadDumpTriggerValue to set

Class LoadAverage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

oneMinuteLoad

fiveMinuteLoad

fifteenMinuteLoad

Constructor Detail

LoadAverage

Method Detail

setLoggingTriggerValue

getLoggingTriggerValue

setCalcFrequencyInMillisec

getCount

tickCallback

getInfo

start

stop

run

getOneMinuteLoad

getFiveMinuteLoad

getFifteenMinuteLoad

getDisplayName

setDisplayName

isThreadDumpOnHighLoad

setThreadDumpOnHighLoad

getThreadDumpTriggerValue

setThreadDumpTriggerValue