MemoryUsageMonitor (Jenkins core 2.366 API)

java.lang.Object
- java.util.TimerTask
- - hudson.triggers.SafeTimerTask
  - - hudson.model.PeriodicWork
    - - hudson.diagnosis.MemoryUsageMonitor

All Implemented Interfaces:

ExtensionPoint, Runnable
```
@Extension
@Symbol("memoryUsage")
public final class MemoryUsageMonitor
extends PeriodicWork
```
Monitors the memory usage of the system in OS specific way.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MemoryUsageMonitor.MemoryGroup
A memory group is conceptually a set of memory pools.
- Nested classes/interfaces inherited from class hudson.triggers.SafeTimerTask
  SafeTimerTask.ExceptionRunnable
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type Field Description

MemoryUsageMonitor.MemoryGroup heap

MemoryUsageMonitor.MemoryGroup nonHeap
- Fields inherited from class hudson.model.PeriodicWork
  DAY, HOUR, logger, MIN

Constructor Summary

Constructors
Constructor Description

MemoryUsageMonitor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doRun()`
`long`	`getRecurrencePeriod()`	Gets the number of milliseconds between successive executions.

Methods inherited from class hudson.model.PeriodicWork
all, getInitialDelay, init

Methods inherited from class hudson.triggers.SafeTimerTask
getLogsRoot, of, run

Methods inherited from class java.util.TimerTask
cancel, scheduledExecutionTime

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

- Field Detail
  - heap
```
public final MemoryUsageMonitor.MemoryGroup heap
```
  - nonHeap
```
public final MemoryUsageMonitor.MemoryGroup nonHeap
```
- Constructor Detail
  - MemoryUsageMonitor
```
public MemoryUsageMonitor()
```
- Method Detail
  - getRecurrencePeriod
```
public long getRecurrencePeriod()
```
    Description copied from class: PeriodicWork
    
    Gets the number of milliseconds between successive executions.
    Hudson calls this method once to set up a recurring timer, instead of calling this each time after the previous execution completed. So this class cannot be used to implement a non-regular recurring timer.
    IOW, the method should always return the same value.
    
    Specified by:
    
    getRecurrencePeriod in class PeriodicWork
  - doRun
```
protected void doRun()
```
    Specified by:
    
    doRun in class SafeTimerTask