This section gives a detailed description of all components in Flink’s memory model of task executor. Check memory configuration guide for the basic memory setup.
The following table lists all memory components, depicted above, and references Flink configuration options which affect the size of the respective components:
|Framework Heap Memory||
||JVM heap memory dedicated to Flink framework (advanced option)|
|Task Heap Memory||
||JVM heap memory dedicated to Flink application to run operators and user code|
||Native memory managed by Flink, reserved for sorting, hash tables, caching of intermediate results and RocksDB state backend|
|Framework Off-heap Memory||
||Off-heap direct (or native) memory dedicated to Flink framework (advanced option)|
|Task Off-heap Memory||
||Off-heap direct (or native) memory dedicated to Flink application to run operators|
||Direct memory reserved for data record exchange between tasks (e.g. buffering for the transfer over the network), it is a capped fractionated component of the total Flink memory|
||Metaspace size of the Flink JVM process|
||Native memory reserved for other JVM overhead: e.g. thread stacks, code cache, garbage collection space etc, it is a capped fractionated component of the total process memory|
As you can see, the size of some memory components can be simply set by the respective option. Other components can be tuned using multiple options.
The framework heap memory and framework off-heap memory options are not supposed to be changed without a good reason. Adjust them only if you are sure that Flink needs more memory for some internal data structures or operations. It can be related to a particular deployment environment or job structure, like high parallelism. In addition, Flink dependencies, such as Hadoop may consume more direct or native memory in certain setups.
Note Neither heap nor off-heap versions of framework and task memory are currently isolated within Flink. The separation of framework and task memory can be used in future releases for further optimizations.
This section describes the configuration details of the following options which can be a fraction of a certain total memory:
See also detailed memory model.
The size of those components always has to be between its maximum and minimum value, otherwise Flink startup will fail. The maximum and minimum values have defaults or can be explicitly set by corresponding configuration options. For example, if only the following memory options are set:
then the network memory will be 1000Mb x 0.1 = 100Mb which is within the range 64-128Mb.
Notice if you configure the same maximum and minimum value it effectively means that its size is fixed to that value.
If the component memory is not explicitly configured, then Flink will use the fraction to calculate the memory size based on the total memory. The calculated value is capped by its corresponding min/max options. For example, if only the following memory options are set:
then the network memory will be 128Mb because the size derived from fraction is 100Mb and it is less than the minimum.
It can also happen that the fraction is ignored if the sizes of the total memory and its other components are defined. In this case, the network memory is the rest of the total memory. The derived value still has to be within its min/max range otherwise the configuration fails. For example, suppose only the following memory options are set:
All other components of the total Flink memory have default values, including the default managed memory fraction. Then the network memory is not the fraction (1000Mb x 0.1 = 100Mb) but the rest of the total Flink memory which will either be within the range 64-256Mb or fail.
Flink explicitly adds the following memory related JVM arguments while starting the task executor process, based on the configured or derived memory component sizes:
|-Xmx and -Xms||Framework + Task Heap Memory|
|-XX:MaxDirectMemorySize||Framework + Task Off-Heap + Network Memory|
See also detailed memory model.
If you start Flink locally on your machine as a single java program without creating a cluster (e.g. from your IDE) then all components are ignored except for the following:
|Memory component||Relevant options||Default value for the local execution|
All of the components listed above can be but do not have to be explicitly configured for the local execution. If they are not configured they are set to their default values. Task heap memory and task off-heap memory are considered to be infinite (Long.MAX_VALUE bytes) and managed memory has a default value of 128Mb only for the local execution mode.
Note The task heap size is not related in any way to the real heap size in this case. It can become relevant for future optimizations coming with next releases. The actual JVM heap size of the started local process is not controlled by Flink and depends on how you start the process. If you want to control the JVM heap size you have to explicitly pass the corresponding JVM arguments, e.g. -Xmx, -Xms.