IMonitoringGroup

All Known Implementing Classes:

AbstractMultipleRecorderElement, BlockingRecorderElement, ContributingRecorderElement, DefaultRecorderElement, InstanceRecorderElement, MultipleRecorderElement, RecorderElement
```
public interface IMonitoringGroup
```
Provides a read-only interface to the data collected for a monitoring group or a configuration (active set of monitoring groups). This interface is intended for use in the listener interfaces of SPASS-meter. Therefore, this interface does currently not provide access to (possible) subelements as they are reported via separate listener methods.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCpuTimeTicks()` Returns the entire number of CPU time ticks recorded for this instance.
`long`	`getFileIn()` Returns the number of bytes read from files.
`long`	`getFileOut()` Returns the number of bytes written to files.
`RecorderElement`	`getInstanceRecorderElement(long instanceId)` Returns an instance recorder element for recording how the data in this recorder element is composed.
`long`	`getIoRead()` Returns the number of bytes read from files or network.
`long`	`getIoWrite()` Returns the number of bytes written to files or network.
`long`	`getMemAllocated()` Returns the amount of memory allocated for this instance.
`long`	`getMemUse()` Returns the amount of memory currently being used, i.e. difference between allocated and unallocated memory.
`long`	`getNetIn()` Returns the number of bytes read from network.
`long`	`getNetOut()` Returns the number of bytes written to network.
`long`	`getSystemTimeTicks()` Returns the entire number of system time ticks recorded for this instance.
`java.lang.Iterable<LongHashMap.MapElement<RecorderElement>>`	`instanceRecorderElements()` Returns all instance recorder elements.
`long[]`	`instanceRecorderIds()` Returns all instance recorder keys.
`boolean`	`wasRecorded()` Returns if data on this instance was recorded or if it a dummy instance created e.g. for some unused (automatic detected) variants.

- Method Detail
  - wasRecorded
```
boolean wasRecorded()
```
    Returns if data on this instance was recorded or if it a dummy instance created e.g. for some unused (automatic detected) variants.
    
    Returns:
    
    true if valid data was recorded, false else
    
    Since:
    
    1.00
  - getSystemTimeTicks
```
long getSystemTimeTicks()
```
    Returns the entire number of system time ticks recorded for this instance.
    
    Returns:
    
    the number of system time ticks
    
    Since:
    
    1.00
  - getCpuTimeTicks
```
long getCpuTimeTicks()
```
    Returns the entire number of CPU time ticks recorded for this instance.
    
    Returns:
    
    the number of CPU time ticks
    
    Since:
    
    1.00
  - getMemAllocated
```
long getMemAllocated()
```
    Returns the amount of memory allocated for this instance.
    
    Returns:
    
    the amount of allocated memory
  - getMemUse
```
long getMemUse()
```
    Returns the amount of memory currently being used, i.e. difference between allocated and unallocated memory.
    
    Returns:
    
    the amount of memory being used
  - getIoRead
```
long getIoRead()
```
    Returns the number of bytes read from files or network.
    
    Returns:
    
    the number of bytes read from files or network
    
    Since:
    
    1.00
  - getIoWrite
```
long getIoWrite()
```
    Returns the number of bytes written to files or network.
    
    Returns:
    
    the number of bytes written to files or network
    
    Since:
    
    1.00
  - getNetIn
```
long getNetIn()
```
    Returns the number of bytes read from network.
    
    Returns:
    
    the number of bytes read from network
    
    Since:
    
    1.00
  - getNetOut
```
long getNetOut()
```
    Returns the number of bytes written to network.
    
    Returns:
    
    the number of bytes written to network
    
    Since:
    
    1.00
  - getFileIn
```
long getFileIn()
```
    Returns the number of bytes read from files.
    
    Returns:
    
    the number of bytes read from files
    
    Since:
    
    1.00
  - getFileOut
```
long getFileOut()
```
    Returns the number of bytes written to files.
    
    Returns:
    
    the number of bytes written to files
    
    Since:
    
    1.00
  - getInstanceRecorderElement
```
RecorderElement getInstanceRecorderElement(long instanceId)
```
    Returns an instance recorder element for recording how the data in this recorder element is composed.
    
    Parameters:
    
    instanceId - the instance identifier
    
    Returns:
    
    the instance recorder element
    
    Since:
    
    1.20
  - instanceRecorderElements
```
java.lang.Iterable<LongHashMap.MapElement<RecorderElement>> instanceRecorderElements()
```
    Returns all instance recorder elements.
    
    Returns:
    
    the instance recorder elements
    
    Since:
    
    1.20
  - instanceRecorderIds
```
long[] instanceRecorderIds()
```
    Returns all instance recorder keys.
    
    Returns:
    
    the instance recorder keys
    
    Since:
    
    1.20

Interface IMonitoringGroup

Method Summary

Method Detail

wasRecorded

getSystemTimeTicks

getCpuTimeTicks

getMemAllocated

getMemUse

getIoRead

getIoWrite

getNetIn

getNetOut

getFileIn

getFileOut

getInstanceRecorderElement

instanceRecorderElements

instanceRecorderIds