tillrohrmann commented on a change in pull request #9760:
[FLINK-13982][runtime] Implement memory calculation logics
URL: https://github.com/apache/flink/pull/9760#discussion_r328688810
##########
File path:
flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java
##########
@@ -260,6 +260,178 @@
text("\"ip\" - uses host's ip address
as binding address"))
.build());
+ //
------------------------------------------------------------------------
+ // Memory Options
+ //
------------------------------------------------------------------------
+
+ /**
+ * Total Process Memory size for the TaskExecutors.
+ */
+ public static final ConfigOption<String> TOTAL_PROCESS_MEMORY =
+ key("taskmanager.memory.total-process.size")
+ .noDefaultValue()
+ .withDescription("Total Process Memory size for the
TaskExecutors. This includes all the memory that a"
+ + " TaskExecutor consumes, consisting of Total
Flink Memory, JVM Metaspace, and JVM Overhead. On"
+ + " containerized setups, this value is
automatically configured to the size of the container.");
+
+ /**
+ * Total Flink Memory size for the TaskExecutors.
+ */
+ @Documentation.CommonOption(position =
Documentation.CommonOption.POSITION_MEMORY)
+ public static final ConfigOption<String> TOTAL_FLINK_MEMORY =
+ key("taskmanager.memory.total-flink.size")
+ .noDefaultValue()
+ .withDeprecatedKeys(TASK_MANAGER_HEAP_MEMORY.key())
+ .withDescription("Total Flink Memory size for the
TaskExecutors. This includes all the memory that a"
+ + " TaskExecutor consumes, except for JVM Metaspace and
JVM Overhead. It consists of Framework Heap Memory,"
+ + " Task Heap Memory, Task Off-Heap Memory, Managed
Memory, and Shuffle Memory.");
+
+ /**
+ * Framework Heap Memory size for TaskExecutors.
+ */
+ public static final ConfigOption<String> FRAMEWORK_HEAP_MEMORY =
+ key("taskmanager.memory.framework.heap.size")
+ .defaultValue("128m")
+ .withDescription("Framework Heap Memory size for
TaskExecutors. This is the size of JVM heap memory reserved"
+ + " for TaskExecutor framework, which will not
be allocated to task slots.");
+
+ /**
+ * Task Heap Memory size for TaskExecutors.
+ */
+ public static final ConfigOption<String> TASK_HEAP_MEMORY =
+ key("taskmanager.memory.task.heap.size")
+ .noDefaultValue()
+ .withDescription("Task Heap Memory size for
TaskExecutors. This is the size of JVM heap memory reserved for"
+ + " user code. If not specified, it will be
derived as Total Flink Memory minus (On-Heap and Off-Heap)"
+ + " Managed Memory and Shuffle Memory.");
Review comment:
I guess it should also say that `FRAMEWORK_HEAP_MEMORY` is subtracted from
`Total Flink Memory`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
