BrooklynGarbageCollector (Apache Brooklyn)

java.lang.Object
- brooklyn.management.internal.BrooklynGarbageCollector

```
public class BrooklynGarbageCollector
extends java.lang.Object
```
Deletes record of old tasks, to prevent space leaks and the eating up of more and more memory. The deletion policy is configurable:
- Period - how frequently to look at the existing tasks to delete some, if required
- Max task age - the time after which a completed task will be automatically deleted (i.e. any root task completed more than maxTaskAge ago will be deleted)
- Max tasks per - the maximum number of tasks to be kept for a given tag, split into categories based on what is seeming to be useful
The default is to check with a period of one minute, deleting tasks after 30 days, and keeping at most 100000 tasks in the system, max 1000 tasks per entity, 50 per effector within that entity, and 50 per other non-effector tag within that entity (or global if not attached to an entity).

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.Boolean>`	`CHECK_SUBTASK_SUBMITTERS` should we check for tasks which are submitted by another but backgrounded, i.e.
`static ConfigKey<java.lang.Boolean>`	`DO_SYSTEM_GC`
`static ConfigKey<Duration>`	`GC_PERIOD`
`static ConfigKey<Duration>`	`MAX_TASK_AGE`
`static ConfigKey<java.lang.Integer>`	`MAX_TASKS_GLOBAL`
`static ConfigKey<java.lang.Integer>`	`MAX_TASKS_PER_ENTITY`
`static ConfigKey<java.lang.Integer>`	`MAX_TASKS_PER_TAG`

Constructor Summary

Constructors
Constructor and Description
`BrooklynGarbageCollector(BrooklynProperties brooklynProperties, BasicExecutionManager executionManager, BrooklynStorage storage)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`deleteTasksForEntity(Entity entity)`
`void`	`gcIteration()` force a round of Brooklyn garbage collection
`java.lang.String`	`getUsageString()`
`void`	`logUsage(java.lang.String prefix)`
`static java.lang.String`	`makeBasicUsageString()`
`void`	`onTaskDone(Task<?> task)`
`void`	`onUnmanaged(Entity entity)`
`void`	`onUnmanaged(Location loc)`
`boolean`	`shouldDeleteTask(Task<?> task)` Deprecated. since 0.7.0, method moved internal until semantics are clarified; see also `shouldDeleteTaskImmediately(Task)`
`void`	`shutdownNow()`

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

Field Detail

GC_PERIOD

public static final ConfigKey<Duration> GC_PERIOD

DO_SYSTEM_GC

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

CHECK_SUBTASK_SUBMITTERS
```
@Beta
public static final ConfigKey<java.lang.Boolean> CHECK_SUBTASK_SUBMITTERS
```
should we check for tasks which are submitted by another but backgrounded, i.e. not a child of that task? default to yes, despite it can be some extra loops, to make sure we GC them promptly.

Since:

0.7.0

MAX_TASKS_PER_TAG

public static final ConfigKey<java.lang.Integer> MAX_TASKS_PER_TAG

MAX_TASKS_PER_ENTITY

public static final ConfigKey<java.lang.Integer> MAX_TASKS_PER_ENTITY

MAX_TASKS_GLOBAL

public static final ConfigKey<java.lang.Integer> MAX_TASKS_GLOBAL

MAX_TASK_AGE

public static final ConfigKey<Duration> MAX_TASK_AGE

Constructor Detail

BrooklynGarbageCollector

public BrooklynGarbageCollector(BrooklynProperties brooklynProperties,
                        BasicExecutionManager executionManager,
                        BrooklynStorage storage)

Method Detail

gcIteration
```
public void gcIteration()
```
force a round of Brooklyn garbage collection

logUsage

public void logUsage(java.lang.String prefix)

makeBasicUsageString

public static java.lang.String makeBasicUsageString()

getUsageString

public java.lang.String getUsageString()

shutdownNow
```
public void shutdownNow()
```

onUnmanaged

public void onUnmanaged(Entity entity)

deleteTasksForEntity

public void deleteTasksForEntity(Entity entity)

onUnmanaged

public void onUnmanaged(Location loc)

onTaskDone
```
public void onTaskDone(Task<?> task)
```

shouldDeleteTask
```
@Deprecated
public boolean shouldDeleteTask(Task<?> task)
```
Deprecated. since 0.7.0, method moved internal until semantics are clarified; see also shouldDeleteTaskImmediately(Task)

Class BrooklynGarbageCollector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GC_PERIOD

DO_SYSTEM_GC

CHECK_SUBTASK_SUBMITTERS

MAX_TASKS_PER_TAG

MAX_TASKS_PER_ENTITY

MAX_TASKS_GLOBAL

MAX_TASK_AGE

Constructor Detail

BrooklynGarbageCollector

Method Detail

gcIteration

logUsage

makeBasicUsageString

getUsageString

shutdownNow

onUnmanaged

deleteTasksForEntity

onUnmanaged

onTaskDone

shouldDeleteTask