Kieker 1.8

kieker.common.record.system
Class CPUUtilizationRecord

java.lang.Object
  extended by kieker.common.record.AbstractMonitoringRecord
      extended by kieker.common.record.system.CPUUtilizationRecord
All Implemented Interfaces:
Serializable, Comparable<IMonitoringRecord>, IMonitoringRecord, IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

public class CPUUtilizationRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory, IMonitoringRecord.BinaryFactory

Since:
1.3
Author:
Andre van Hoorn, Jan Waller
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord
IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory
 
Field Summary
static int SIZE
           
static Class<?>[] TYPES
           
 
Constructor Summary
CPUUtilizationRecord(ByteBuffer buffer, IRegistry<String> stringRegistry)
          This constructor converts the given array into a record.
CPUUtilizationRecord(long timestamp, String hostname, String cpuID, double user, double system, double wait, double nice, double irq, double totalUtilization, double idle)
          Constructs a new CPUUtilizationRecord with the given values.
CPUUtilizationRecord(Object[] values)
          This constructor converts the given array into a record.
 
Method Summary
 String getCpuID()
           
 String getHostname()
           
 double getIdle()
           
 double getIrq()
           
 double getNice()
           
 int getSize()
          This method should deliver the size of a binary representation of this record.
 double getSystem()
           
 long getTimestamp()
           
 double getTotalUtilization()
           
 double getUser()
           
 Class<?>[] getValueTypes()
          This method should deliver an array with the classes of the single values for the record.
 double getWait()
           
 void initFromArray(Object[] values)
          Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
 void initFromBytes(ByteBuffer buffer, IRegistry<String> stringRegistry)
          Deprecated. This record uses the IMonitoringRecord.BinaryFactory mechanism. Hence, this method is not implemented.
 Object[] toArray()
          This method should deliver an array containing the content of the record.
 void writeBytes(ByteBuffer buffer, IRegistry<String> stringRegistry)
          This method should deliver an byte array containing the content of the record.
 
Methods inherited from class kieker.common.record.AbstractMonitoringRecord
checkArray, classForName, compareTo, createFromArray, createFromByteBuffer, createFromStringArray, equals, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, setLoggingTimestamp, toString, typesForClass
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SIZE

public static final int SIZE
See Also:
Constant Field Values

TYPES

public static final Class<?>[] TYPES
Constructor Detail

CPUUtilizationRecord

public CPUUtilizationRecord(long timestamp,
                            String hostname,
                            String cpuID,
                            double user,
                            double system,
                            double wait,
                            double nice,
                            double irq,
                            double totalUtilization,
                            double idle)
Constructs a new CPUUtilizationRecord with the given values. If certain String values shall remain undefined, use the constant DEFAULT_VALUE.

Parameters:
timestamp - The timestamp for the record.
hostname - The name of the host.
cpuID - The ID of the CPU.
user - The fraction of time during which the CPU was used for user-space processes.
system - The fraction of time during which the CPU was used by the kernel.
wait - The fraction of CPU wait time.
nice - The fraction of time during which the CPU was used by user space processes with a high nice value.
irq - The fraction of time during which the CPU was used by user space processes with a high nice value.
totalUtilization - The fraction of time during which the CPU was utilized.
idle - The fraction of time during which the CPU was idle

CPUUtilizationRecord

public CPUUtilizationRecord(Object[] values)
This constructor converts the given array into a record. It is recommended to use the array which is the result of a call to toArray().

Parameters:
values - The values for the record.

CPUUtilizationRecord

public CPUUtilizationRecord(ByteBuffer buffer,
                            IRegistry<String> stringRegistry)
                     throws BufferUnderflowException
This constructor converts the given array into a record.

Parameters:
buffer - The bytes for the record.
Throws:
BufferUnderflowException - if buffer not sufficient
Method Detail

toArray

public Object[] toArray()
This method should deliver an array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:
toArray in interface IMonitoringRecord
Returns:
An array with the values of the record.

writeBytes

public void writeBytes(ByteBuffer buffer,
                       IRegistry<String> stringRegistry)
                throws BufferOverflowException
This method should deliver an byte array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:
writeBytes in interface IMonitoringRecord
Parameters:
buffer - The used ByteBuffer with sufficient capacity
stringRegistry - Usually the associated MonitoringController
Throws:
BufferOverflowException - if buffer not sufficient

initFromArray

@Deprecated
public final void initFromArray(Object[] values)
Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.toArray().

Specified by:
initFromArray in interface IMonitoringRecord
Parameters:
values - The values for the record.

initFromBytes

@Deprecated
public final void initFromBytes(ByteBuffer buffer,
                                           IRegistry<String> stringRegistry)
                         throws BufferUnderflowException
Deprecated. This record uses the IMonitoringRecord.BinaryFactory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.writeBytes(ByteBuffer, IRegistry).

Specified by:
initFromBytes in interface IMonitoringRecord
Parameters:
buffer - The bytes for the record.
stringRegistry - The Registry storing the strings.
Throws:
BufferUnderflowException - if buffer not sufficient

getValueTypes

public Class<?>[] getValueTypes()
This method should deliver an array with the classes of the single values for the record.

Specified by:
getValueTypes in interface IMonitoringRecord
Returns:
The types of the values. This returned array should be treated readonly.
See Also:
IMonitoringRecord.toArray()

getSize

public int getSize()
This method should deliver the size of a binary representation of this record.

Specified by:
getSize in interface IMonitoringRecord
Returns:
The size.

getTimestamp

public final long getTimestamp()
Returns:
the timestamp

getHostname

public final String getHostname()
Returns:
the hostname

getCpuID

public final String getCpuID()
Returns:
the cpuID

getUser

public final double getUser()
Returns:
the user

getSystem

public final double getSystem()
Returns:
the system

getWait

public final double getWait()
Returns:
the wait

getNice

public final double getNice()
Returns:
the nice

getIrq

public final double getIrq()
Returns:
the irq

getTotalUtilization

public final double getTotalUtilization()
Returns:
the totalUtilization

getIdle

public final double getIdle()
Returns:
the idle

Kieker 1.8

Copyright 2013 Kieker Project, http://kieker-monitoring.net