rajagopr commented on code in PR #15008: URL: https://github.com/apache/pinot/pull/15008#discussion_r1953226440
########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/DiskUtilizationChecker.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.pinot.controller.validation; + +import com.google.common.collect.BiMap; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.util.CompletionServiceHelper; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class DiskUtilizationChecker { + private static final Logger LOGGER = LoggerFactory.getLogger(DiskUtilizationChecker.class); + private final int _resourceUtilizationCheckTimeoutMs; + private final long _resourceUtilizationCheckerFrequency; + private final double _diskUtilizationThreshold; + private final String _diskUtilizationPath; + private static final String DISK_UTILIZATION_API_PATH = "/instance/diskUtilization"; + + private final PinotHelixResourceManager _helixResourceManager; + + public DiskUtilizationChecker(PinotHelixResourceManager helixResourceManager, ControllerConf controllerConf) { + _helixResourceManager = helixResourceManager; + _diskUtilizationPath = controllerConf.getDiskUtilizationPath(); + _diskUtilizationThreshold = controllerConf.getDiskUtilizationThreshold(); + _resourceUtilizationCheckTimeoutMs = controllerConf.getDiskUtilizationCheckTimeoutMs(); + _resourceUtilizationCheckerFrequency = controllerConf.getResourceUtilizationCheckerFrequency(); + } + + public static String getDiskUtilizationApiPath() { + return DISK_UTILIZATION_API_PATH; + } + + /** + * Check if disk utilization for the requested table is within the configured limits. + */ + public boolean isDiskUtilizationWithinLimits(String tableNameWithType) { + if (StringUtils.isEmpty(tableNameWithType)) { + throw new IllegalArgumentException("Table name found to be null or empty while computing disk utilization."); + } + TableConfig tableConfig = _helixResourceManager.getTableConfig(tableNameWithType); + if (tableConfig == null) { + return true; // table does not exist Review Comment: Yes, this can happen if the table gets deleted. Added logging when this happens. ########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/DiskUtilizationChecker.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.pinot.controller.validation; + +import com.google.common.collect.BiMap; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.util.CompletionServiceHelper; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class DiskUtilizationChecker { + private static final Logger LOGGER = LoggerFactory.getLogger(DiskUtilizationChecker.class); + private final int _resourceUtilizationCheckTimeoutMs; + private final long _resourceUtilizationCheckerFrequency; + private final double _diskUtilizationThreshold; + private final String _diskUtilizationPath; + private static final String DISK_UTILIZATION_API_PATH = "/instance/diskUtilization"; + + private final PinotHelixResourceManager _helixResourceManager; + + public DiskUtilizationChecker(PinotHelixResourceManager helixResourceManager, ControllerConf controllerConf) { + _helixResourceManager = helixResourceManager; + _diskUtilizationPath = controllerConf.getDiskUtilizationPath(); + _diskUtilizationThreshold = controllerConf.getDiskUtilizationThreshold(); + _resourceUtilizationCheckTimeoutMs = controllerConf.getDiskUtilizationCheckTimeoutMs(); + _resourceUtilizationCheckerFrequency = controllerConf.getResourceUtilizationCheckerFrequency(); + } + + public static String getDiskUtilizationApiPath() { + return DISK_UTILIZATION_API_PATH; + } + + /** + * Check if disk utilization for the requested table is within the configured limits. + */ + public boolean isDiskUtilizationWithinLimits(String tableNameWithType) { + if (StringUtils.isEmpty(tableNameWithType)) { + throw new IllegalArgumentException("Table name found to be null or empty while computing disk utilization."); + } + TableConfig tableConfig = _helixResourceManager.getTableConfig(tableNameWithType); + if (tableConfig == null) { + return true; // table does not exist + } + List<String> instances; + if (TableNameBuilder.isOfflineTableResource(tableNameWithType)) { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.OFFLINE); + } else { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.REALTIME); + } + return isDiskUtilizationWithinLimits(instances); + } + + private boolean isDiskUtilizationWithinLimits(List<String> instances) { + for (String instance : instances) { + DiskUsageInfo diskUsageInfo = ResourceUtilizationInfo.getDiskUsageInfo(instance); + if (diskUsageInfo == null) { + LOGGER.warn("Disk utilization info for server: {} is null", instance); + continue; + } + // Ignore if the disk utilization info is stale. The info is considered stale if it is older than the + // ResourceUtilizationChecker tasks frequency. + if (diskUsageInfo.getLastUpdatedTimeInEpochMs() + < System.currentTimeMillis() - _resourceUtilizationCheckerFrequency) { + LOGGER.warn("Disk utilization info for server: {} is stale", instance); + continue; + } + if (diskUsageInfo.getUsedSpaceBytes() > diskUsageInfo.getTotalSpaceBytes() * _diskUtilizationThreshold) { Review Comment: done. added logs and metric. Will setup alert separately. ########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/ResourceUtilizationInfo.java: ########## @@ -0,0 +1,45 @@ +/** + * 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.pinot.controller.validation; + +import java.util.HashMap; +import java.util.Map; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; + + +/** + * This class is used to capture resource utilization information for all instances. The periodic task, + * <code>ResourceUtilizationChecker</code>, will update this information. + */ +public class ResourceUtilizationInfo { + + private ResourceUtilizationInfo() { + } + + // Assumption – instanceId is unique across all tenants + private static final Map<String, DiskUsageInfo> INSTANCE_DISK_USAGE_INFO = new HashMap<>(); Review Comment: done. ########## pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/PinotTaskManager.java: ########## @@ -203,6 +206,14 @@ public Map<String, String> createTask(String taskType, String tableName, @Nullab for (String tableNameWithType : tableNameWithTypes) { TableConfig tableConfig = _pinotHelixResourceManager.getTableConfig(tableNameWithType); LOGGER.info("Trying to create tasks of type: {}, table: {}", taskType, tableNameWithType); + try { + if (!_resourceUtilizationManager.isResourceUtilizationWithinLimits(tableNameWithType)) { Review Comment: done. ########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/DiskUtilizationChecker.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.pinot.controller.validation; + +import com.google.common.collect.BiMap; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.util.CompletionServiceHelper; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class DiskUtilizationChecker { + private static final Logger LOGGER = LoggerFactory.getLogger(DiskUtilizationChecker.class); + private final int _resourceUtilizationCheckTimeoutMs; + private final long _resourceUtilizationCheckerFrequency; + private final double _diskUtilizationThreshold; + private final String _diskUtilizationPath; + private static final String DISK_UTILIZATION_API_PATH = "/instance/diskUtilization"; + + private final PinotHelixResourceManager _helixResourceManager; + + public DiskUtilizationChecker(PinotHelixResourceManager helixResourceManager, ControllerConf controllerConf) { + _helixResourceManager = helixResourceManager; + _diskUtilizationPath = controllerConf.getDiskUtilizationPath(); + _diskUtilizationThreshold = controllerConf.getDiskUtilizationThreshold(); + _resourceUtilizationCheckTimeoutMs = controllerConf.getDiskUtilizationCheckTimeoutMs(); + _resourceUtilizationCheckerFrequency = controllerConf.getResourceUtilizationCheckerFrequency(); + } + + public static String getDiskUtilizationApiPath() { + return DISK_UTILIZATION_API_PATH; + } + + /** + * Check if disk utilization for the requested table is within the configured limits. + */ + public boolean isDiskUtilizationWithinLimits(String tableNameWithType) { + if (StringUtils.isEmpty(tableNameWithType)) { + throw new IllegalArgumentException("Table name found to be null or empty while computing disk utilization."); + } + TableConfig tableConfig = _helixResourceManager.getTableConfig(tableNameWithType); + if (tableConfig == null) { + return true; // table does not exist + } + List<String> instances; + if (TableNameBuilder.isOfflineTableResource(tableNameWithType)) { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.OFFLINE); + } else { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.REALTIME); + } + return isDiskUtilizationWithinLimits(instances); + } + + private boolean isDiskUtilizationWithinLimits(List<String> instances) { Review Comment: If the disk issue is mitigated with the rebalance, the subsequent run of `ResourceUtilizationChecker` would update the limits. For OFFLINE tables, the ingestion tasks would be generated as soon as the `ResourceUtilizationChecker` runs. For REALTIME tables, consumption is resumed automatically upon the next run of `RealtimeSegmentValidationManager`. Alternately, consumption can be resumed manually. ########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/DiskUtilizationChecker.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.pinot.controller.validation; + +import com.google.common.collect.BiMap; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.util.CompletionServiceHelper; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class DiskUtilizationChecker { + private static final Logger LOGGER = LoggerFactory.getLogger(DiskUtilizationChecker.class); + private final int _resourceUtilizationCheckTimeoutMs; + private final long _resourceUtilizationCheckerFrequency; + private final double _diskUtilizationThreshold; + private final String _diskUtilizationPath; + private static final String DISK_UTILIZATION_API_PATH = "/instance/diskUtilization"; + + private final PinotHelixResourceManager _helixResourceManager; + + public DiskUtilizationChecker(PinotHelixResourceManager helixResourceManager, ControllerConf controllerConf) { + _helixResourceManager = helixResourceManager; + _diskUtilizationPath = controllerConf.getDiskUtilizationPath(); + _diskUtilizationThreshold = controllerConf.getDiskUtilizationThreshold(); + _resourceUtilizationCheckTimeoutMs = controllerConf.getDiskUtilizationCheckTimeoutMs(); + _resourceUtilizationCheckerFrequency = controllerConf.getResourceUtilizationCheckerFrequency(); Review Comment: done. ########## pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/minion/PinotTaskManager.java: ########## @@ -641,6 +652,13 @@ protected TaskSchedulingInfo scheduleTask(PinotTaskGenerator taskGenerator, List for (TableConfig tableConfig : enabledTableConfigs) { String tableName = tableConfig.getTableName(); try { + if (!_resourceUtilizationManager.isResourceUtilizationWithinLimits(tableName)) { + String message = + "Skipping tasks generation as resource utilization is not within limits for table: " + tableName; Review Comment: I have modified the message to show additional details. Tasks wont be generated. As of now, the OSS UI would look as follows. We need the UI fix to surface the `schedulingErrors` to the user. <img width="1883" alt="image" src="https://github.com/user-attachments/assets/aa864882-d901-4109-a087-a66ec46c5898"; /> ########## pinot-controller/src/main/java/org/apache/pinot/controller/validation/DiskUtilizationChecker.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.pinot.controller.validation; + +import com.google.common.collect.BiMap; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.restlet.resources.DiskUsageInfo; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.util.CompletionServiceHelper; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class DiskUtilizationChecker { + private static final Logger LOGGER = LoggerFactory.getLogger(DiskUtilizationChecker.class); + private final int _resourceUtilizationCheckTimeoutMs; + private final long _resourceUtilizationCheckerFrequency; + private final double _diskUtilizationThreshold; + private final String _diskUtilizationPath; + private static final String DISK_UTILIZATION_API_PATH = "/instance/diskUtilization"; + + private final PinotHelixResourceManager _helixResourceManager; + + public DiskUtilizationChecker(PinotHelixResourceManager helixResourceManager, ControllerConf controllerConf) { + _helixResourceManager = helixResourceManager; + _diskUtilizationPath = controllerConf.getDiskUtilizationPath(); + _diskUtilizationThreshold = controllerConf.getDiskUtilizationThreshold(); + _resourceUtilizationCheckTimeoutMs = controllerConf.getDiskUtilizationCheckTimeoutMs(); + _resourceUtilizationCheckerFrequency = controllerConf.getResourceUtilizationCheckerFrequency(); + } + + public static String getDiskUtilizationApiPath() { + return DISK_UTILIZATION_API_PATH; + } + + /** + * Check if disk utilization for the requested table is within the configured limits. + */ + public boolean isDiskUtilizationWithinLimits(String tableNameWithType) { + if (StringUtils.isEmpty(tableNameWithType)) { + throw new IllegalArgumentException("Table name found to be null or empty while computing disk utilization."); + } + TableConfig tableConfig = _helixResourceManager.getTableConfig(tableNameWithType); + if (tableConfig == null) { + return true; // table does not exist + } + List<String> instances; + if (TableNameBuilder.isOfflineTableResource(tableNameWithType)) { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.OFFLINE); + } else { + instances = _helixResourceManager.getServerInstancesForTable(tableNameWithType, TableType.REALTIME); + } + return isDiskUtilizationWithinLimits(instances); + } + + private boolean isDiskUtilizationWithinLimits(List<String> instances) { + for (String instance : instances) { + DiskUsageInfo diskUsageInfo = ResourceUtilizationInfo.getDiskUsageInfo(instance); + if (diskUsageInfo == null) { + LOGGER.warn("Disk utilization info for server: {} is null", instance); + continue; + } + // Ignore if the disk utilization info is stale. The info is considered stale if it is older than the + // ResourceUtilizationChecker tasks frequency. + if (diskUsageInfo.getLastUpdatedTimeInEpochMs() Review Comment: The `DiskUsageInfo` object is written in it's entirety and would contain all the info when it's written. The `lastUpdatedTimeInEpoch` helps with the staleness check to cover for the case when the periodic task does not run or encounters some error. Behavior is as follows: 1) If disk info is stale --> ignore the stat and resource utilization is considered within limit. 2) No disk info for a particular server --> ignore the stat from this server and resource utilization is considered within limit. -- 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. To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
