[GitHub] [incubator-pinot] snleee commented on a change in pull request #4117: Admin tool for listing segments with invalid intervals for offline tables

[GitBox <gi...@apache.org>]

snleee commented on a change in pull request #4117: Admin tool for listing segments with invalid intervals for offline tables
URL: https://github.com/apache/incubator-pinot/pull/4117#discussion_r276425934
 
 

 ##########
 File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/OfflineSegmentIntervalCheckerCommand.java
 ##########
 @@ -0,0 +1,151 @@
+/**
+ * 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.tools.admin.command;
+
+import java.util.ArrayList;
+import java.util.List;
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.helix.PropertyPathConfig;
+import org.apache.helix.PropertyType;
+import org.apache.helix.ZNRecord;
+import org.apache.helix.manager.zk.ZKHelixAdmin;
+import org.apache.helix.manager.zk.ZNRecordSerializer;
+import org.apache.helix.store.zk.ZkHelixPropertyStore;
+import org.apache.pinot.common.config.TableConfig;
+import org.apache.pinot.common.config.TableNameBuilder;
+import org.apache.pinot.common.metadata.ZKMetadataProvider;
+import org.apache.pinot.common.metadata.segment.OfflineSegmentZKMetadata;
+import org.apache.pinot.controller.util.SegmentIntervalUtils;
+import org.apache.pinot.tools.Command;
+import org.joda.time.Interval;
+import org.kohsuke.args4j.Option;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * Pinot admin command to list all offline segments with invalid intervals, group by table name
+ */
+public class OfflineSegmentIntervalCheckerCommand extends AbstractBaseAdminCommand implements Command {
+  private static final Logger LOGGER = LoggerFactory.getLogger(OfflineSegmentIntervalCheckerCommand.class);
+
+  private ZKHelixAdmin _helixAdmin;
+  private ZkHelixPropertyStore<ZNRecord> _propertyStore;
+
+  @Option(name = "-zkAddress", required = true, metaVar = "<http>", usage = "Zookeeper server:port/cluster")
+  private String _zkAddress;
+
+  @Option(name = "-clusterName", required = true, metaVar = "<String>", usage = "Helix cluster name")
+  private String _clusterName;
+
+  @Option(name = "-tableNames", metaVar = "<string>", usage = "Comma separated list of tables to check for invalid segment intervals")
+  private String _tableNames;
+
+  @Option(name = "-help", help = true, aliases = {"-h", "--h", "--help"}, usage = "Print this message.")
+  private boolean _help = false;
+
+  @Override
+  public boolean getHelp() {
+    return _help;
+  }
+
+  @Override
+  public String toString() {
+    return "OfflineSegmentIntervalChecker";
+  }
+
+  @Override
+  public String getName() {
+    return "OfflineSegmentIntervalChecker";
+  }
+
+  @Override
+  public void cleanup() {
+
+  }
+
+  @Override
+  public String description() {
+    return "Prints out offline segments with invalid time intervals";
+  }
+
+  @Override
+  public boolean execute()
+      throws Exception {
+    LOGGER.info("Executing command: " + toString());
+
+    _helixAdmin = new ZKHelixAdmin(_zkAddress);
+    _propertyStore = new ZkHelixPropertyStore<>(_zkAddress, new ZNRecordSerializer(),
+        PropertyPathConfig.getPath(PropertyType.PROPERTYSTORE, _clusterName));
+
+    List<String> offlineTables = new ArrayList<>();
+    if (StringUtils.isBlank(_tableNames)) {
+      List<String> resourcesInCluster = _helixAdmin.getResourcesInCluster(_clusterName);
+      for (String tableName : resourcesInCluster) {
+        if (TableNameBuilder.isOfflineTableResource(tableName)) {
+          offlineTables.add(tableName);
+        }
+      }
+    } else {
+      for (String tableName : _tableNames.split(",")) {
+        if (ZKMetadataProvider.getOfflineTableConfig(_propertyStore, tableName) != null) {
+          offlineTables.add(tableName);
+        } else {
+          LOGGER.warn("Table config not found for table {}. Skipping", tableName);
+        }
+      }
+    }
+
+    LOGGER.info("Tables to check: {}", offlineTables);
+    for (String offlineTableName : offlineTables) {
+      LOGGER.info("Checking table {}", offlineTableName);
+      List<String> segmentsWithInvalidIntervals = checkOfflineTablesSegmentIntervals(offlineTableName);
+      if (CollectionUtils.isNotEmpty(segmentsWithInvalidIntervals)) {
+        LOGGER.info("Table: {} has {} segments with invalid interval: {}", offlineTableName,
+            segmentsWithInvalidIntervals.size(), segmentsWithInvalidIntervals);
+      }
+    }
+
+    return true;
+  }
+
+  /**
+   * Checks segments of table for invalid intervals and prints them out
+   * @param offlineTableName
+   */
+  private List<String> checkOfflineTablesSegmentIntervals(String offlineTableName) {
+    TableConfig tableConfig = ZKMetadataProvider.getOfflineTableConfig(_propertyStore, offlineTableName);
+    List<OfflineSegmentZKMetadata> offlineSegmentZKMetadataList =
+        ZKMetadataProvider.getOfflineSegmentZKMetadataListForTable(_propertyStore, offlineTableName);
+
+    // collect segments with invalid time intervals
+    List<String> segmentsWithInvalidIntervals = new ArrayList<>();
+    if (SegmentIntervalUtils.eligibleForSegmentIntervalCheck(tableConfig.getValidationConfig())) {
+      for (OfflineSegmentZKMetadata offlineSegmentZKMetadata : offlineSegmentZKMetadataList) {
+        Interval timeInterval = offlineSegmentZKMetadata.getTimeInterval();
+        if (!SegmentIntervalUtils.isValidInterval(timeInterval)) {
+          segmentsWithInvalidIntervals.add(offlineSegmentZKMetadata.getSegmentName());
+        }
+      }
+    }
+    return segmentsWithInvalidIntervals;
+  }
+
 
 Review comment:
   remove line

----------------------------------------------------------------
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


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org