Package org.apache.flink.runtime.util.config.memory

Interface FlinkMemory

All Superinterfaces:
Serializable
All Known Implementing Classes:
JobManagerFlinkMemory, TaskExecutorFlinkMemory
public interface FlinkMemory extends Serializable
Memory components which constitute the Total Flink Memory.

The relationships of Flink JVM and rest memory components are shown below. 

               ┌ ─ ─  Total Flink Memory - ─ ─ ┐
                 ┌───────────────────────────┐
               | │       JVM Heap Memory     │ |
                 └───────────────────────────┘
               |┌ ─ ─ - - - Off-Heap  - - ─ ─ ┐|
                │┌───────────────────────────┐│
               │ │     JVM Direct Memory     │ │
                │└───────────────────────────┘│
               │ ┌───────────────────────────┐ │
                ││   Rest Off-Heap Memory    ││
               │ └───────────────────────────┘ │
                └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
               └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘

The JVM and rest memory components can consist of further concrete Flink memory components depending on the process type. The Flink memory components can be derived from either its total size or a subset of configured required fine-grained components. Check the implementations for details about the concrete components.

  • Method Details

    • getJvmHeapMemorySize

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

    • getJvmDirectMemorySize

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

    • getTotalFlinkMemorySize

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