You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/08/27 16:08:55 UTC
[GitHub] [flink] tillrohrmann commented on a change in pull request #13251: [FLINK-14435] Added memory configuration to TaskManagers REST endpoint
tillrohrmann commented on a change in pull request #13251:
URL: https://github.com/apache/flink/pull/13251#discussion_r478457291
##########
File path: flink-runtime/src/main/java/org/apache/flink/runtime/taskexecutor/TaskExecutorMemoryConfiguration.java
##########
@@ -0,0 +1,333 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.taskexecutor;
+
+import org.apache.flink.configuration.ConfigOption;
+import org.apache.flink.configuration.Configuration;
+import org.apache.flink.configuration.MemorySize;
+
+import org.apache.flink.shaded.guava18.com.google.common.base.MoreObjects;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_METASPACE;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_SIZE;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TOTAL_PROCESS_MEMORY;
+
+/**
+ * TaskExecutorConfiguration collects the configuration of a TaskExecutor instance.
+ */
+public class TaskExecutorMemoryConfiguration implements Serializable {
+
+ public static final String FIELD_NAME_FRAMEWORK_HEAP = "frameworkHeap";
+ public static final String FIELD_NAME_TASK_HEAP = "taskHeap";
+
+ public static final String FIELD_NAME_FRAMEWORK_OFFHEAP = "frameworkOffHeap";
+ public static final String FIELD_NAME_TASK_OFFHEAP = "taskOffHeap";
+
+ public static final String FIELD_NAME_NETWORK_MIN = "networkMin";
+ public static final String FIELD_NAME_NETWORK_MAX = "networkMax";
+ public static final String FIELD_NAME_NETWORK_FRACTION = "networkFraction";
+
+ public static final String FIELD_NAME_MANAGED_TOTAL = "managedTotal";
+ public static final String FIELD_NAME_MANAGED_FRACTION = "managedFraction";
+
+ public static final String FIELD_NAME_METASPACE_MAX = "metaspaceMax";
+
+ public static final String FIELD_NAME_OVERHEAD_MIN = "overheadMin";
+ public static final String FIELD_NAME_OVERHEAD_MAX = "overheadMax";
+ public static final String FIELD_NAME_OVERHEAD_FRACTION = "overheadFraction";
+
+ public static final String FIELD_NAME_MEMORY_TOTAL = "memoryTotal";
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_HEAP)
+ @JsonInclude
+ private final Long frameworkHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_HEAP)
+ private final Long taskHeap;
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_OFFHEAP)
+ private final Long frameworkOffHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_OFFHEAP)
+ private final Long taskOffHeap;
+
+ @JsonProperty(FIELD_NAME_NETWORK_MIN)
+ private final Long networkMemoryMin;
+ @JsonProperty(FIELD_NAME_NETWORK_MAX)
+ private final Long networkMemoryMax;
+ @JsonProperty(FIELD_NAME_NETWORK_FRACTION)
+ private final Float networkMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_MANAGED_TOTAL)
+ private final Long managedMemoryTotal;
+ @JsonProperty(FIELD_NAME_MANAGED_FRACTION)
+ private final Float managedMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_METASPACE_MAX)
+ private final Long jvmMetaspaceMax;
+
+ @JsonProperty(FIELD_NAME_OVERHEAD_MIN)
+ private final Long jvmOverheadMin;
+ @JsonProperty(FIELD_NAME_OVERHEAD_MAX)
+ private final Long jvmOverheadMax;
+ @JsonProperty(FIELD_NAME_OVERHEAD_FRACTION)
+ private final Float jvmOverheadFraction;
+
+ @JsonProperty(FIELD_NAME_MEMORY_TOTAL)
+ private final Long totalProcessMemory;
+
+ private static Long getConfigurationValue(Configuration config, ConfigOption<? extends MemorySize> option) {
+ MemorySize memorySize = config.get(option);
+ return memorySize != null ? memorySize.getBytes() : null;
+ }
+
+ /**
+ * Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.
+ * @param config The Configuration used for initializing the TaskExecutorMemoryConfiguration.
+ * @return The newly instantiated TaskExecutorMemoryConfiguration.
+ */
+ public static TaskExecutorMemoryConfiguration create(Configuration config) {
+ return new TaskExecutorMemoryConfiguration(
+ getConfigurationValue(config, FRAMEWORK_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_HEAP_MEMORY),
+ getConfigurationValue(config, FRAMEWORK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, NETWORK_MEMORY_MIN),
+ getConfigurationValue(config, NETWORK_MEMORY_MAX),
+ config.getOptional(NETWORK_MEMORY_FRACTION).orElse(NETWORK_MEMORY_FRACTION.defaultValue()),
+ getConfigurationValue(config, MANAGED_MEMORY_SIZE),
+ config.getOptional(MANAGED_MEMORY_FRACTION).orElse(MANAGED_MEMORY_FRACTION.defaultValue()),
Review comment:
Why do we need the fraction value here?
##########
File path: flink-runtime/src/main/java/org/apache/flink/runtime/taskexecutor/TaskExecutorMemoryConfiguration.java
##########
@@ -0,0 +1,333 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.taskexecutor;
+
+import org.apache.flink.configuration.ConfigOption;
+import org.apache.flink.configuration.Configuration;
+import org.apache.flink.configuration.MemorySize;
+
+import org.apache.flink.shaded.guava18.com.google.common.base.MoreObjects;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_METASPACE;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_SIZE;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TOTAL_PROCESS_MEMORY;
+
+/**
+ * TaskExecutorConfiguration collects the configuration of a TaskExecutor instance.
+ */
+public class TaskExecutorMemoryConfiguration implements Serializable {
+
+ public static final String FIELD_NAME_FRAMEWORK_HEAP = "frameworkHeap";
+ public static final String FIELD_NAME_TASK_HEAP = "taskHeap";
+
+ public static final String FIELD_NAME_FRAMEWORK_OFFHEAP = "frameworkOffHeap";
+ public static final String FIELD_NAME_TASK_OFFHEAP = "taskOffHeap";
+
+ public static final String FIELD_NAME_NETWORK_MIN = "networkMin";
+ public static final String FIELD_NAME_NETWORK_MAX = "networkMax";
+ public static final String FIELD_NAME_NETWORK_FRACTION = "networkFraction";
+
+ public static final String FIELD_NAME_MANAGED_TOTAL = "managedTotal";
+ public static final String FIELD_NAME_MANAGED_FRACTION = "managedFraction";
+
+ public static final String FIELD_NAME_METASPACE_MAX = "metaspaceMax";
+
+ public static final String FIELD_NAME_OVERHEAD_MIN = "overheadMin";
+ public static final String FIELD_NAME_OVERHEAD_MAX = "overheadMax";
+ public static final String FIELD_NAME_OVERHEAD_FRACTION = "overheadFraction";
+
+ public static final String FIELD_NAME_MEMORY_TOTAL = "memoryTotal";
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_HEAP)
+ @JsonInclude
+ private final Long frameworkHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_HEAP)
+ private final Long taskHeap;
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_OFFHEAP)
+ private final Long frameworkOffHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_OFFHEAP)
+ private final Long taskOffHeap;
+
+ @JsonProperty(FIELD_NAME_NETWORK_MIN)
+ private final Long networkMemoryMin;
+ @JsonProperty(FIELD_NAME_NETWORK_MAX)
+ private final Long networkMemoryMax;
+ @JsonProperty(FIELD_NAME_NETWORK_FRACTION)
+ private final Float networkMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_MANAGED_TOTAL)
+ private final Long managedMemoryTotal;
+ @JsonProperty(FIELD_NAME_MANAGED_FRACTION)
+ private final Float managedMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_METASPACE_MAX)
+ private final Long jvmMetaspaceMax;
+
+ @JsonProperty(FIELD_NAME_OVERHEAD_MIN)
+ private final Long jvmOverheadMin;
+ @JsonProperty(FIELD_NAME_OVERHEAD_MAX)
+ private final Long jvmOverheadMax;
+ @JsonProperty(FIELD_NAME_OVERHEAD_FRACTION)
+ private final Float jvmOverheadFraction;
+
+ @JsonProperty(FIELD_NAME_MEMORY_TOTAL)
+ private final Long totalProcessMemory;
+
+ private static Long getConfigurationValue(Configuration config, ConfigOption<? extends MemorySize> option) {
+ MemorySize memorySize = config.get(option);
+ return memorySize != null ? memorySize.getBytes() : null;
+ }
+
+ /**
+ * Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.
+ * @param config The Configuration used for initializing the TaskExecutorMemoryConfiguration.
+ * @return The newly instantiated TaskExecutorMemoryConfiguration.
+ */
+ public static TaskExecutorMemoryConfiguration create(Configuration config) {
+ return new TaskExecutorMemoryConfiguration(
+ getConfigurationValue(config, FRAMEWORK_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_HEAP_MEMORY),
+ getConfigurationValue(config, FRAMEWORK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, NETWORK_MEMORY_MIN),
+ getConfigurationValue(config, NETWORK_MEMORY_MAX),
+ config.getOptional(NETWORK_MEMORY_FRACTION).orElse(NETWORK_MEMORY_FRACTION.defaultValue()),
Review comment:
Why do we need the fraction value here? I think it is mainly used for calculating the actual budgets.
##########
File path: flink-runtime/src/main/java/org/apache/flink/runtime/taskexecutor/TaskExecutorMemoryConfiguration.java
##########
@@ -0,0 +1,333 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.taskexecutor;
+
+import org.apache.flink.configuration.ConfigOption;
+import org.apache.flink.configuration.Configuration;
+import org.apache.flink.configuration.MemorySize;
+
+import org.apache.flink.shaded.guava18.com.google.common.base.MoreObjects;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_METASPACE;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_SIZE;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TOTAL_PROCESS_MEMORY;
+
+/**
+ * TaskExecutorConfiguration collects the configuration of a TaskExecutor instance.
+ */
+public class TaskExecutorMemoryConfiguration implements Serializable {
+
+ public static final String FIELD_NAME_FRAMEWORK_HEAP = "frameworkHeap";
+ public static final String FIELD_NAME_TASK_HEAP = "taskHeap";
+
+ public static final String FIELD_NAME_FRAMEWORK_OFFHEAP = "frameworkOffHeap";
+ public static final String FIELD_NAME_TASK_OFFHEAP = "taskOffHeap";
+
+ public static final String FIELD_NAME_NETWORK_MIN = "networkMin";
+ public static final String FIELD_NAME_NETWORK_MAX = "networkMax";
+ public static final String FIELD_NAME_NETWORK_FRACTION = "networkFraction";
+
+ public static final String FIELD_NAME_MANAGED_TOTAL = "managedTotal";
+ public static final String FIELD_NAME_MANAGED_FRACTION = "managedFraction";
+
+ public static final String FIELD_NAME_METASPACE_MAX = "metaspaceMax";
+
+ public static final String FIELD_NAME_OVERHEAD_MIN = "overheadMin";
+ public static final String FIELD_NAME_OVERHEAD_MAX = "overheadMax";
+ public static final String FIELD_NAME_OVERHEAD_FRACTION = "overheadFraction";
+
+ public static final String FIELD_NAME_MEMORY_TOTAL = "memoryTotal";
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_HEAP)
+ @JsonInclude
+ private final Long frameworkHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_HEAP)
+ private final Long taskHeap;
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_OFFHEAP)
+ private final Long frameworkOffHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_OFFHEAP)
+ private final Long taskOffHeap;
+
+ @JsonProperty(FIELD_NAME_NETWORK_MIN)
+ private final Long networkMemoryMin;
+ @JsonProperty(FIELD_NAME_NETWORK_MAX)
+ private final Long networkMemoryMax;
+ @JsonProperty(FIELD_NAME_NETWORK_FRACTION)
+ private final Float networkMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_MANAGED_TOTAL)
+ private final Long managedMemoryTotal;
+ @JsonProperty(FIELD_NAME_MANAGED_FRACTION)
+ private final Float managedMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_METASPACE_MAX)
+ private final Long jvmMetaspaceMax;
+
+ @JsonProperty(FIELD_NAME_OVERHEAD_MIN)
+ private final Long jvmOverheadMin;
+ @JsonProperty(FIELD_NAME_OVERHEAD_MAX)
+ private final Long jvmOverheadMax;
+ @JsonProperty(FIELD_NAME_OVERHEAD_FRACTION)
+ private final Float jvmOverheadFraction;
+
+ @JsonProperty(FIELD_NAME_MEMORY_TOTAL)
+ private final Long totalProcessMemory;
+
+ private static Long getConfigurationValue(Configuration config, ConfigOption<? extends MemorySize> option) {
+ MemorySize memorySize = config.get(option);
+ return memorySize != null ? memorySize.getBytes() : null;
+ }
+
+ /**
+ * Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.
+ * @param config The Configuration used for initializing the TaskExecutorMemoryConfiguration.
+ * @return The newly instantiated TaskExecutorMemoryConfiguration.
+ */
+ public static TaskExecutorMemoryConfiguration create(Configuration config) {
+ return new TaskExecutorMemoryConfiguration(
+ getConfigurationValue(config, FRAMEWORK_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_HEAP_MEMORY),
+ getConfigurationValue(config, FRAMEWORK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, NETWORK_MEMORY_MIN),
+ getConfigurationValue(config, NETWORK_MEMORY_MAX),
+ config.getOptional(NETWORK_MEMORY_FRACTION).orElse(NETWORK_MEMORY_FRACTION.defaultValue()),
+ getConfigurationValue(config, MANAGED_MEMORY_SIZE),
+ config.getOptional(MANAGED_MEMORY_FRACTION).orElse(MANAGED_MEMORY_FRACTION.defaultValue()),
+ getConfigurationValue(config, JVM_METASPACE),
+ getConfigurationValue(config, JVM_OVERHEAD_MIN),
+ getConfigurationValue(config, JVM_OVERHEAD_MAX),
+ config.getOptional(JVM_OVERHEAD_FRACTION).orElse(JVM_OVERHEAD_FRACTION.defaultValue()),
+ getConfigurationValue(config, TOTAL_PROCESS_MEMORY)
+ );
+ }
+
+ @JsonCreator
+ public TaskExecutorMemoryConfiguration(
+ @JsonProperty(FIELD_NAME_FRAMEWORK_HEAP) Long frameworkHeap,
+ @JsonProperty(FIELD_NAME_TASK_HEAP) Long taskHeap,
+ @JsonProperty(FIELD_NAME_FRAMEWORK_OFFHEAP) Long frameworkOffHeap,
+ @JsonProperty(FIELD_NAME_TASK_OFFHEAP) Long taskOffHeap,
+ @JsonProperty(FIELD_NAME_NETWORK_MIN) Long networkMemoryMin,
+ @JsonProperty(FIELD_NAME_NETWORK_MAX) Long networkMemoryMax,
+ @JsonProperty(FIELD_NAME_NETWORK_FRACTION) Float networkMemoryFraction,
+ @JsonProperty(FIELD_NAME_MANAGED_TOTAL) Long managedMemoryTotal,
+ @JsonProperty(FIELD_NAME_MANAGED_FRACTION) Float managedMemoryFraction,
+ @JsonProperty(FIELD_NAME_METASPACE_MAX) Long jvmMetaspaceMax,
+ @JsonProperty(FIELD_NAME_OVERHEAD_MIN) Long jvmOverheadMin,
+ @JsonProperty(FIELD_NAME_OVERHEAD_MAX) Long jvmOverheadMax,
+ @JsonProperty(FIELD_NAME_OVERHEAD_FRACTION) Float jvmOverheadFraction,
+ @JsonProperty(FIELD_NAME_MEMORY_TOTAL) Long totalProcessMemory) {
Review comment:
I assume total flink memory has been left out because one can calculate it from the individual parts here.
##########
File path: flink-runtime/src/main/java/org/apache/flink/runtime/taskexecutor/TaskExecutorMemoryConfiguration.java
##########
@@ -0,0 +1,333 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.taskexecutor;
+
+import org.apache.flink.configuration.ConfigOption;
+import org.apache.flink.configuration.Configuration;
+import org.apache.flink.configuration.MemorySize;
+
+import org.apache.flink.shaded.guava18.com.google.common.base.MoreObjects;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.FRAMEWORK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_METASPACE;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.JVM_OVERHEAD_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.MANAGED_MEMORY_SIZE;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_FRACTION;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MAX;
+import static org.apache.flink.configuration.TaskManagerOptions.NETWORK_MEMORY_MIN;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TASK_OFF_HEAP_MEMORY;
+import static org.apache.flink.configuration.TaskManagerOptions.TOTAL_PROCESS_MEMORY;
+
+/**
+ * TaskExecutorConfiguration collects the configuration of a TaskExecutor instance.
+ */
+public class TaskExecutorMemoryConfiguration implements Serializable {
+
+ public static final String FIELD_NAME_FRAMEWORK_HEAP = "frameworkHeap";
+ public static final String FIELD_NAME_TASK_HEAP = "taskHeap";
+
+ public static final String FIELD_NAME_FRAMEWORK_OFFHEAP = "frameworkOffHeap";
+ public static final String FIELD_NAME_TASK_OFFHEAP = "taskOffHeap";
+
+ public static final String FIELD_NAME_NETWORK_MIN = "networkMin";
+ public static final String FIELD_NAME_NETWORK_MAX = "networkMax";
+ public static final String FIELD_NAME_NETWORK_FRACTION = "networkFraction";
+
+ public static final String FIELD_NAME_MANAGED_TOTAL = "managedTotal";
+ public static final String FIELD_NAME_MANAGED_FRACTION = "managedFraction";
+
+ public static final String FIELD_NAME_METASPACE_MAX = "metaspaceMax";
+
+ public static final String FIELD_NAME_OVERHEAD_MIN = "overheadMin";
+ public static final String FIELD_NAME_OVERHEAD_MAX = "overheadMax";
+ public static final String FIELD_NAME_OVERHEAD_FRACTION = "overheadFraction";
+
+ public static final String FIELD_NAME_MEMORY_TOTAL = "memoryTotal";
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_HEAP)
+ @JsonInclude
+ private final Long frameworkHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_HEAP)
+ private final Long taskHeap;
+
+ @JsonProperty(FIELD_NAME_FRAMEWORK_OFFHEAP)
+ private final Long frameworkOffHeap;
+
+ @JsonProperty(FIELD_NAME_TASK_OFFHEAP)
+ private final Long taskOffHeap;
+
+ @JsonProperty(FIELD_NAME_NETWORK_MIN)
+ private final Long networkMemoryMin;
+ @JsonProperty(FIELD_NAME_NETWORK_MAX)
+ private final Long networkMemoryMax;
+ @JsonProperty(FIELD_NAME_NETWORK_FRACTION)
+ private final Float networkMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_MANAGED_TOTAL)
+ private final Long managedMemoryTotal;
+ @JsonProperty(FIELD_NAME_MANAGED_FRACTION)
+ private final Float managedMemoryFraction;
+
+ @JsonProperty(FIELD_NAME_METASPACE_MAX)
+ private final Long jvmMetaspaceMax;
+
+ @JsonProperty(FIELD_NAME_OVERHEAD_MIN)
+ private final Long jvmOverheadMin;
+ @JsonProperty(FIELD_NAME_OVERHEAD_MAX)
+ private final Long jvmOverheadMax;
+ @JsonProperty(FIELD_NAME_OVERHEAD_FRACTION)
+ private final Float jvmOverheadFraction;
+
+ @JsonProperty(FIELD_NAME_MEMORY_TOTAL)
+ private final Long totalProcessMemory;
+
+ private static Long getConfigurationValue(Configuration config, ConfigOption<? extends MemorySize> option) {
+ MemorySize memorySize = config.get(option);
+ return memorySize != null ? memorySize.getBytes() : null;
+ }
+
+ /**
+ * Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.
+ * @param config The Configuration used for initializing the TaskExecutorMemoryConfiguration.
+ * @return The newly instantiated TaskExecutorMemoryConfiguration.
+ */
+ public static TaskExecutorMemoryConfiguration create(Configuration config) {
+ return new TaskExecutorMemoryConfiguration(
+ getConfigurationValue(config, FRAMEWORK_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_HEAP_MEMORY),
+ getConfigurationValue(config, FRAMEWORK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, TASK_OFF_HEAP_MEMORY),
+ getConfigurationValue(config, NETWORK_MEMORY_MIN),
+ getConfigurationValue(config, NETWORK_MEMORY_MAX),
+ config.getOptional(NETWORK_MEMORY_FRACTION).orElse(NETWORK_MEMORY_FRACTION.defaultValue()),
+ getConfigurationValue(config, MANAGED_MEMORY_SIZE),
+ config.getOptional(MANAGED_MEMORY_FRACTION).orElse(MANAGED_MEMORY_FRACTION.defaultValue()),
+ getConfigurationValue(config, JVM_METASPACE),
+ getConfigurationValue(config, JVM_OVERHEAD_MIN),
+ getConfigurationValue(config, JVM_OVERHEAD_MAX),
+ config.getOptional(JVM_OVERHEAD_FRACTION).orElse(JVM_OVERHEAD_FRACTION.defaultValue()),
+ getConfigurationValue(config, TOTAL_PROCESS_MEMORY)
+ );
+ }
+
+ @JsonCreator
+ public TaskExecutorMemoryConfiguration(
Review comment:
I don't have a good idea for a solution but this long list of `Longs` and `Floats` is easy to get wrong in the sense that mixes up the order of the memory configuration values. It is good that we have the factory method `create` which makes it definitely safer.
----------------------------------------------------------------
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:
users@infra.apache.org