org.apache.flink.runtime.clusterframework

Class TaskExecutorProcessSpec

java.lang.Object

org.apache.flink.runtime.clusterframework.TaskExecutorProcessSpec

All Implemented Interfaces:

Serializable

public class TaskExecutorProcessSpec
extends Object
implements Serializable

Describe the specifics of different resource dimensions of the TaskExecutor process.

A TaskExecutor's memory consists of the following components.

• Framework Heap Memory
• Framework Off-Heap Memory
• Task Heap Memory
• Task Off-Heap Memory
• Network Memory
• Managed Memory
• JVM Metaspace
• JVM Overhead

Among all the components, Framework Heap Memory and Task Heap Memory use on heap memory, while the rest use off heap memory. We use Total Process Memory to refer to all the memory components, while Total Flink Memory refering to all the components except JVM Metaspace and JVM Overhead.

The relationships of TaskExecutor memory components are shown below.

               ┌ ─ ─ Total Process Memory  ─ ─ ┐
                ┌ ─ ─ Total Flink Memory  ─ ─ ┐
               │ ┌───────────────────────────┐ │
                ││   Framework Heap Memory   ││  ─┐
               │ └───────────────────────────┘ │  │
               │ ┌───────────────────────────┐ │  │
            ┌─  ││ Framework Off-Heap Memory ││   ├─ On-Heap
            │  │ └───────────────────────────┘ │  │
            │   │┌───────────────────────────┐│   │
            │  │ │     Task Heap Memory      │ │ ─┘
            │   │└───────────────────────────┘│
            │  │ ┌───────────────────────────┐ │
            ├─  ││   Task Off-Heap Memory    ││
            │  │ └───────────────────────────┘ │
            │   │┌───────────────────────────┐│
            ├─ │ │      Network Memory       │ │
            │   │└───────────────────────────┘│
            │  │ ┌───────────────────────────┐ │
  Off-Heap ─┼─   │      Managed Memory       │
            │  ││└───────────────────────────┘││
            │   └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
            │  │┌─────────────────────────────┐│
            ├─  │        JVM Metaspace        │
            │  │└─────────────────────────────┘│
            │   ┌─────────────────────────────┐
            └─ ││        JVM Overhead         ││
                └─────────────────────────────┘
               └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

TaskExecutorProcessSpec(org.apache.flink.api.common.resources.CPUResource cpuCores, org.apache.flink.configuration.MemorySize frameworkHeapSize, org.apache.flink.configuration.MemorySize frameworkOffHeapSize, org.apache.flink.configuration.MemorySize taskHeapSize, org.apache.flink.configuration.MemorySize taskOffHeapSize, org.apache.flink.configuration.MemorySize networkMemSize, org.apache.flink.configuration.MemorySize managedMemorySize, org.apache.flink.configuration.MemorySize jvmMetaspaceSize, org.apache.flink.configuration.MemorySize jvmOverheadSize)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.common.resources.CPUResource	getCpuCores()
org.apache.flink.configuration.MemorySize	getFrameworkHeapSize()
org.apache.flink.configuration.MemorySize	getFrameworkOffHeapMemorySize()
org.apache.flink.configuration.MemorySize	getJvmDirectMemorySize()
org.apache.flink.configuration.MemorySize	getJvmHeapMemorySize()
org.apache.flink.configuration.MemorySize	getJvmMetaspaceSize()
org.apache.flink.configuration.MemorySize	getJvmOverheadSize()
org.apache.flink.configuration.MemorySize	getManagedMemorySize()
org.apache.flink.configuration.MemorySize	getNetworkMemSize()
org.apache.flink.configuration.MemorySize	getTaskHeapSize()
org.apache.flink.configuration.MemorySize	getTaskOffHeapSize()
org.apache.flink.configuration.MemorySize	getTotalFlinkMemorySize()
org.apache.flink.configuration.MemorySize	getTotalProcessMemorySize()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskExecutorProcessSpec

public TaskExecutorProcessSpec(org.apache.flink.api.common.resources.CPUResource cpuCores,
                               org.apache.flink.configuration.MemorySize frameworkHeapSize,
                               org.apache.flink.configuration.MemorySize frameworkOffHeapSize,
                               org.apache.flink.configuration.MemorySize taskHeapSize,
                               org.apache.flink.configuration.MemorySize taskOffHeapSize,
                               org.apache.flink.configuration.MemorySize networkMemSize,
                               org.apache.flink.configuration.MemorySize managedMemorySize,
                               org.apache.flink.configuration.MemorySize jvmMetaspaceSize,
                               org.apache.flink.configuration.MemorySize jvmOverheadSize)

Method Detail

getCpuCores

public org.apache.flink.api.common.resources.CPUResource getCpuCores()

getFrameworkHeapSize

public org.apache.flink.configuration.MemorySize getFrameworkHeapSize()

getFrameworkOffHeapMemorySize

public org.apache.flink.configuration.MemorySize getFrameworkOffHeapMemorySize()

getTaskHeapSize

public org.apache.flink.configuration.MemorySize getTaskHeapSize()

getTaskOffHeapSize

public org.apache.flink.configuration.MemorySize getTaskOffHeapSize()

getNetworkMemSize

public org.apache.flink.configuration.MemorySize getNetworkMemSize()

getManagedMemorySize

public org.apache.flink.configuration.MemorySize getManagedMemorySize()

getJvmMetaspaceSize

public org.apache.flink.configuration.MemorySize getJvmMetaspaceSize()

getJvmOverheadSize

public org.apache.flink.configuration.MemorySize getJvmOverheadSize()

getTotalFlinkMemorySize

public org.apache.flink.configuration.MemorySize getTotalFlinkMemorySize()

getTotalProcessMemorySize

public org.apache.flink.configuration.MemorySize getTotalProcessMemorySize()

getJvmHeapMemorySize

public org.apache.flink.configuration.MemorySize getJvmHeapMemorySize()

getJvmDirectMemorySize

public org.apache.flink.configuration.MemorySize getJvmDirectMemorySize()

toString

public String toString()

Overrides:

toString in class Object