org.apache.flink.runtime.profiling.types

Class InstanceProfilingEvent

java.lang.Object

org.apache.flink.runtime.event.job.AbstractEvent

org.apache.flink.runtime.profiling.types.ProfilingEvent

org.apache.flink.runtime.profiling.types.InstanceProfilingEvent

All Implemented Interfaces:

IOReadableWritable, ManagementEvent

Direct Known Subclasses:

InstanceSummaryProfilingEvent, SingleInstanceProfilingEvent

public abstract class InstanceProfilingEvent
extends ProfilingEvent

Instance profiling events are a special subclass of profiling events. They contain profiling information about the utilization of a particular instance during a job execution.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
InstanceProfilingEvent() Default constructor for serialization/deserialization.
InstanceProfilingEvent(int profilingInterval, int ioWaitCPU, int idleCPU, int userCPU, int systemCPU, int hardIrqCPU, int softIrqCPU, long totalMemory, long freeMemory, long bufferedMemory, long cachedMemory, long cachedSwapMemory, long receivedBytes, long transmittedBytes, JobID jobID, long timestamp, long profilingTimestamp) Constructs a new instance profiling event.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getBufferedMemory() Returns the amount of memory, in bytes, used for file buffers.
long	getCachedMemory() Returns the amount of memory, in bytes, used as cache memory.
long	getCachedSwapMemory() Returns the amount of swap, in bytes, used as cache memory.
long	getFreeMemory() Returns the amount of free memory of the corresponding instance.
int	getHardIrqCPU() Returns the percentage of time the CPU(s) spent in state HARD_IRQ during the profiling interval.
int	getIdleCPU() Returns the percentage of time the CPU(s) spent in state IDLE during the profiling interval.
int	getIOWaitCPU() Returns the percentage of time the CPU(s) spent in state IOWAIT during the profiling interval.
int	getProfilingInterval() Returns the interval of time this profiling event covers in milliseconds.
long	getReceivedBytes() Returns the number of bytes received via network during the profiling interval.
int	getSoftIrqCPU() Returns the percentage of time the CPU(s) spent in state SOFT_IRQ during the profiling interval.
int	getSystemCPU() Returns the percentage of time the CPU(s) spent in state SYSTEM during the profiling interval.
long	getTotalMemory() Returns the total amount of memory of the corresponding instance.
long	getTransmittedBytes() Returns the number of bytes transmitted via network during the profiling interval.
int	getUserCPU() Returns the percentage of time the CPU(s) spent in state USER during the profiling interval.
int	hashCode()
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class org.apache.flink.runtime.profiling.types.ProfilingEvent

getJobID, getProfilingTimestamp

Methods inherited from class org.apache.flink.runtime.event.job.AbstractEvent

getSequenceNumber, getTimestamp, timestampToString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstanceProfilingEvent

public InstanceProfilingEvent(int profilingInterval,
                      int ioWaitCPU,
                      int idleCPU,
                      int userCPU,
                      int systemCPU,
                      int hardIrqCPU,
                      int softIrqCPU,
                      long totalMemory,
                      long freeMemory,
                      long bufferedMemory,
                      long cachedMemory,
                      long cachedSwapMemory,
                      long receivedBytes,
                      long transmittedBytes,
                      JobID jobID,
                      long timestamp,
                      long profilingTimestamp)

Constructs a new instance profiling event.

Parameters:

profilingInterval - the interval of time this profiling event covers in milliseconds

ioWaitCPU - the percentage of time the CPU(s) spent in state IOWAIT during the profiling interval

idleCPU - the percentage of time the CPU(s) spent in state IDLE during the profiling interval

userCPU - the percentage of time the CPU(s) spent in state USER during the profiling interval

systemCPU - the percentage of time the CPU(s) spent in state SYSTEM during the profiling interval

hardIrqCPU - the percentage of time the CPU(s) spent in state HARD_IRQ during the profiling interval

softIrqCPU - the percentage of time the CPU(s) spent in state SOFT_IRQ during the profiling interval

totalMemory - the total amount of this instance's main memory in bytes

freeMemory - the free amount of this instance's main memory in bytes

bufferedMemory - the amount of main memory the instance uses for file buffers

cachedMemory - the amount of main memory the instance uses as cache memory

cachedSwapMemory - The amount of main memory the instance uses for cached swaps

receivedBytes - the number of bytes received via network during the profiling interval

transmittedBytes - the number of bytes transmitted via network during the profiling interval

jobID - the ID of this job this profiling event belongs to

timestamp - the time stamp of this profiling event's creation

profilingTimestamp - the time stamp relative to the beginning of the job's execution

InstanceProfilingEvent

public InstanceProfilingEvent()

Default constructor for serialization/deserialization.

Method Detail

getProfilingInterval

public final int getProfilingInterval()

Returns the interval of time this profiling event covers in milliseconds.

Returns:

the interval of time this profiling event covers in milliseconds

getTotalMemory

public final long getTotalMemory()

Returns the total amount of memory of the corresponding instance.

Returns:

the total amount of memory in bytes

getFreeMemory

public final long getFreeMemory()

Returns the amount of free memory of the corresponding instance.

Returns:

the amount of free memory in bytes.

getBufferedMemory

public final long getBufferedMemory()

Returns the amount of memory, in bytes, used for file buffers.

Returns:

the amount of memory used for file buffers in bytes

getCachedMemory

public final long getCachedMemory()

Returns the amount of memory, in bytes, used as cache memory.

Returns:

the amount of memory used as cache memory in bytes

getCachedSwapMemory

public final long getCachedSwapMemory()

Returns the amount of swap, in bytes, used as cache memory.

Returns:

the amount of, in bytes, used as cache memory

getUserCPU

public final int getUserCPU()

Returns the percentage of time the CPU(s) spent in state USER during the profiling interval.

Returns:

the percentage of time the CPU(s) spent in state USER during the profiling interval

getSystemCPU

public final int getSystemCPU()

Returns the percentage of time the CPU(s) spent in state SYSTEM during the profiling interval.

Returns:

the percentage of time the CPU(s) spent in state SYSTEM during the profiling interval

getIdleCPU

public final int getIdleCPU()

Returns the percentage of time the CPU(s) spent in state IDLE during the profiling interval. Prior to Linux 2.5.41, this includes IO-wait time.

Returns:

the percentage of time the CPU(s) spent in state IDLE during the profiling interval

getIOWaitCPU

public final int getIOWaitCPU()

Returns the percentage of time the CPU(s) spent in state IOWAIT during the profiling interval. Prior to Linux 2.5.41, included in idle.

Returns:

the percentage of time the CPU(s) spent in state IOWAIT during the profiling interval.

getHardIrqCPU

public final int getHardIrqCPU()

Returns the percentage of time the CPU(s) spent in state HARD_IRQ during the profiling interval.

Returns:

the percentage of time the CPU(s) spent in state HARD_IRQ during the profiling interval

getSoftIrqCPU

public final int getSoftIrqCPU()

Returns the percentage of time the CPU(s) spent in state SOFT_IRQ during the profiling interval.

Returns:

the percentage of time the CPU(s) spent in state SOFT_IRQ during the profiling interval

getReceivedBytes

public final long getReceivedBytes()

Returns the number of bytes received via network during the profiling interval.

Returns:

the number of bytes received via network during the profiling interval

getTransmittedBytes

public final long getTransmittedBytes()

Returns the number of bytes transmitted via network during the profiling interval.

Returns:

the number of bytes transmitted via network during the profiling interval

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Overrides:

read in class ProfilingEvent

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Overrides:

write in class ProfilingEvent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class ProfilingEvent

hashCode

public int hashCode()

Overrides:

hashCode in class ProfilingEvent