steveloughran commented on a change in pull request #1003: HADOOP-16384: Avoid inconsistencies between DDB and S3 URL: https://github.com/apache/hadoop/pull/1003#discussion_r302155360
########## File path: hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DumpS3GuardTable.java ########## @@ -0,0 +1,691 @@ +/* + * 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.hadoop.fs.s3a.s3guard; + +import javax.annotation.Nullable; +import java.io.Closeable; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.PrintWriter; +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Date; +import java.util.List; + +import com.amazonaws.services.dynamodbv2.xspec.ExpressionSpecBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.commons.lang3.tuple.Pair; +import org.apache.hadoop.classification.InterfaceAudience; +import org.apache.hadoop.classification.InterfaceStability; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.Path; +import org.apache.hadoop.fs.RemoteIterator; +import org.apache.hadoop.fs.s3a.Listing; +import org.apache.hadoop.fs.s3a.S3AFileStatus; +import org.apache.hadoop.fs.s3a.S3AFileSystem; +import org.apache.hadoop.fs.s3a.S3ALocatedFileStatus; +import org.apache.hadoop.fs.s3a.S3ListRequest; +import org.apache.hadoop.service.Service; +import org.apache.hadoop.service.launcher.LauncherExitCodes; +import org.apache.hadoop.service.launcher.ServiceLaunchException; +import org.apache.hadoop.service.launcher.ServiceLauncher; +import org.apache.hadoop.util.DurationInfo; +import org.apache.hadoop.util.ExitUtil; + +import static com.google.common.base.Preconditions.checkNotNull; +import static org.apache.hadoop.fs.s3a.S3AUtils.ACCEPT_ALL; + +/** + * This is a low-level diagnostics entry point which does a CVE/TSV dump of + * the DDB state. + * As it also lists the filesystem, it actually changes the state of the store + * during the operation. + */ [email protected] [email protected] +public class DumpS3GuardTable extends AbstractS3GuardDiagnostic { + + private static final Logger LOG = + LoggerFactory.getLogger(DumpS3GuardTable.class); + + /** + * Application name. + */ + public static final String NAME = "DumpS3GuardTable"; + + /** + * Usage. + */ + private static final String USAGE_MESSAGE = NAME + + " <filesystem> <dest-file>"; + + /** + * Suffix for the flat list: {@value}. + */ + public static final String FLAT_CSV = "-flat.csv"; + + /** + * Suffix for the raw S3 dump: {@value}. + */ + public static final String RAW_CSV = "-s3.csv"; + + /** + * Suffix for the DDB scan: {@value}. + */ + public static final String SCAN_CSV = "-scan.csv"; + + /** + * Suffix for the second DDB scan: : {@value}. + */ + public static final String SCAN2_CSV = "-scan-2.csv"; + + /** + * Suffix for the treewalk scan of the S3A Filesystem: {@value}. + */ + public static final String TREE_CSV = "-tree.csv"; + + /** + * Suffix for a recursive treewalk through the metastore: {@value}. + */ + public static final String STORE_CSV = "-store.csv"; + + /** + * Path in the local filesystem to save the data. + */ + protected String destPath; + + /** + * Instantiate. + * @param name application name. + */ + public DumpS3GuardTable(final String name) { + super(name); + } + + /** + * Instantiate with default name. + */ + public DumpS3GuardTable() { + this(NAME); + } + + /** + * Bind to a specific FS + store. + * @param fs filesystem + * @param store metastore to use + * @param destFile the base filename for output + * @param uri URI of store -only needed if FS is null. + */ + public DumpS3GuardTable( + final S3AFileSystem fs, + final DynamoDBMetadataStore store, + final File destFile, + final URI uri) { + super(NAME, fs, store, uri); + this.destPath = destFile.getAbsolutePath(); + } + + /** + * Bind to the argument list, including validating the CLI + * @throws Exception failure. + */ + @Override + protected void serviceStart() throws Exception { + if (getStore() == null) { + List<String> arg = getArgumentList(2, 2, USAGE_MESSAGE); + bindFromCLI(arg.get(0)); + destPath = arg.get(1); + } + } + + /** + * Dump the filesystem and the metastore. + * @return the exit code. + * @throws ServiceLaunchException on failure. + * @throws IOException IO failure. + */ + @Override + public int execute() throws ServiceLaunchException, IOException { + + try { + final File scanFile = new File( + destPath + SCAN_CSV).getCanonicalFile(); + scanFile.getParentFile().mkdirs(); + + try (CsvFile csv = new CsvFile(scanFile); + DurationInfo ignored = new DurationInfo(LOG, + "scanFile dump to %s", scanFile)) { + scanMetastore(csv); + } + + if (getFilesystem() != null) { + + Path basePath = getFilesystem().qualify(new Path(getUri())); + + final File destFile = new File(destPath + STORE_CSV) + .getCanonicalFile(); + LOG.info("Writing Store details to {}", destFile); + try (CsvFile csv = new CsvFile(destFile); + DurationInfo ignored = new DurationInfo(LOG, "List metastore")) { + + LOG.info("Base path: {}", basePath); + dumpMetastore(csv, basePath); + } + + // these operations all update the metastore as they list, + // that is: they are side-effecting. + final File treewalkFile = new File(destPath + TREE_CSV) + .getCanonicalFile(); + + try (CsvFile csv = new CsvFile(treewalkFile); + DurationInfo ignored = new DurationInfo(LOG, + "Treewalk to %s", treewalkFile)) { + treewalkFilesystem(csv, basePath); + } + final File flatlistFile = new File( + destPath + FLAT_CSV).getCanonicalFile(); + + try (CsvFile csv = new CsvFile(flatlistFile); + DurationInfo ignored = new DurationInfo(LOG, + "Flat list to %s", flatlistFile)) { + listStatusFilesystem(csv, basePath); + } + final File rawFile = new File( + destPath + RAW_CSV).getCanonicalFile(); + + try (CsvFile csv = new CsvFile(rawFile); + DurationInfo ignored = new DurationInfo(LOG, + "Raw dump to %s", rawFile)) { + dumpRawS3ObjectStore(csv); + } + final File scanFile2 = new File( + destPath + SCAN2_CSV).getCanonicalFile(); + + try (CsvFile csv = new CsvFile(scanFile); + DurationInfo ignored = new DurationInfo(LOG, + "scanFile dump to %s", scanFile2)) { + scanMetastore(csv); + } + + } + + return LauncherExitCodes.EXIT_SUCCESS; + } catch (IOException | RuntimeException e) { + LOG.error("failure", e); + throw e; + } + } + + /** + * Dump the filesystem via a recursive treewalk. + * If metastore entries mark directories as deleted, this + * walk will not explore them. + * @param csv destination. + * @return number of entries found. + * @throws IOException IO failure. + */ + protected int treewalkFilesystem( + final CsvFile csv, + final Path path) throws IOException { + int count = 1; + FileStatus[] fileStatuses; + try { + fileStatuses = getFilesystem().listStatus(path); + } catch (FileNotFoundException e) { + LOG.warn("File {} was not found", path); + return 0; + } + // entries + for (FileStatus fileStatus : fileStatuses) { + csv.entry((S3AFileStatus) fileStatus); + } + for (FileStatus fileStatus : fileStatuses) { + if (fileStatus.isDirectory() + && !(fileStatus.getPath().equals(path))) { + count += treewalkFilesystem(csv, fileStatus.getPath()); + } else { + count++; + } + } + return count; + } + + /** + * Dump the filesystem via a recursive listStatus call. + * @param csv destination. + * @return number of entries found. + * @throws IOException IO failure. + */ + protected int listStatusFilesystem( + final CsvFile csv, + final Path path) throws IOException { + int count = 0; + RemoteIterator<S3ALocatedFileStatus> iterator = getFilesystem() + .listFilesAndEmptyDirectories(path, true); + while (iterator.hasNext()) { + S3ALocatedFileStatus status = iterator.next(); + csv.entry(status.toS3AFileStatus()); + } + return count; + } + + /** + * Dump the raw S3 Object Store. + * @param csv destination. + * @return number of entries found. + * @throws IOException IO failure. + */ + protected int dumpRawS3ObjectStore( + final CsvFile csv) throws IOException { + S3AFileSystem fs = getFilesystem(); + Path rootPath = fs.qualify(new Path("/")); + Listing listing = new Listing(fs); + S3ListRequest request = fs.createListObjectsRequest("", null); + int count = 0; + RemoteIterator<S3AFileStatus> st = + listing.createFileStatusListingIterator(rootPath, request, + ACCEPT_ALL, + new Listing.AcceptAllButSelfAndS3nDirs(rootPath)); + while (st.hasNext()) { + count++; + S3AFileStatus next = st.next(); + LOG.debug("[{}] {}", count, next); + csv.entry(next); + } + LOG.info("entry count: {}", count); + return count; + } + + /** + * list children under the metastore from a base path, through + * a recursive query + walk strategy. + * @param csv dest + * @param basePath base path + * @throws IOException failure. + */ + protected void dumpMetastore(final CsvFile csv, + final Path basePath) throws IOException { + dumpRecursively(csv, getStore().listChildren(basePath)); + } + + /** + * Recursive Store Dump. + * @param csv open CSV file. + * @param dir directory listing + * @return (directories, files) + * @throws IOException failure + */ + private Pair<Integer, Integer> dumpRecursively( + CsvFile csv, DirListingMetadata dir) throws IOException { + int files = 0, dirs = 1; + List<DDBPathMetadata> childDirs = new ArrayList<>(); + Collection<PathMetadata> listing = dir.getListing(); + // sort by name + List<PathMetadata> sorted = new ArrayList<>(listing); + sorted.sort(new PathOrderComparators.PathMetadataComparator( + (l, r) -> l.compareTo(r))); + + for (PathMetadata pmd : sorted) { + DDBPathMetadata ddbMd = (DDBPathMetadata) pmd; + dumpEntry(csv, ddbMd); + if (ddbMd.getFileStatus().isDirectory()) { + childDirs.add(ddbMd); + } else { + files++; + } + } + for (DDBPathMetadata childDir : childDirs) { + DirListingMetadata children = getStore().listChildren( + childDir.getFileStatus().getPath()); + Pair<Integer, Integer> pair = dumpRecursively(csv, + children); + dirs += pair.getLeft(); + files += pair.getRight(); + } + + return Pair.of(dirs, files); + } + + + /** + * Dump a single entry, and log it. + * @param csv CSV output file. + * @param md metadata to log. + */ + private void dumpEntry(CsvFile csv, DDBPathMetadata md) { + LOG.info("{}", md.prettyPrint()); + csv.entry(md); + } + + /** + * Scan the metastore for all entries and dump them. + * There's no attempt to sort the output. + * @param csv file + * @return count of the number of entries. + */ + private int scanMetastore(CsvFile csv) { + S3GuardTableAccess tableAccess = new S3GuardTableAccess(getStore()); + ExpressionSpecBuilder builder = new ExpressionSpecBuilder(); + Iterable<DDBPathMetadata> results = tableAccess.scanMetadata( + builder); + int count = 0; + for (DDBPathMetadata md : results) { + if (!(md instanceof S3GuardTableAccess.VersionMarker)) { + count++; + // print it + csv.entry(md); + } + } + return count; + } + + + /** + * Convert a timestamp in milliseconds to a human string. + * @param millis epoch time in millis + * @return a string for the CSV file. + */ + private static String stringify(long millis) { + return new Date(millis).toString(); + } + + /** + * This is the JVM entry point for the service launcher. + * + * Converts the arguments to a list, then invokes {@link #serviceMain(List)} + * @param args command line arguments. + */ + public static void main(String[] args) { + try { + serviceMain(Arrays.asList(args), new DumpS3GuardTable()); + } catch (ExitUtil.ExitException e) { + ExitUtil.terminate(e); + } + } + + /** + * The real main function, which takes the arguments as a list. + * Argument 0 MUST be the service classname + * @param argsList the list of arguments + * @param service service to launch. + */ + static void serviceMain( + final List<String> argsList, + final AbstractS3GuardDiagnostic service) { + ServiceLauncher<Service> serviceLauncher = + new ServiceLauncher<>(service.getName()); + + ExitUtil.ExitException ex = serviceLauncher.launchService( + new Configuration(), + service, + argsList, + false, + true); + if (ex != null) { + throw ex; + } + } + + /** + * Entry point to dump the metastore and s3 store world views + * <p> + * Both the FS and the store will be dumped: the store is scanned + * before and after the sequence to show what changes were made to + * the store during the list operation. + * @param fs fs to dump. If null a store must be provided. + * @param store store to dump (fallback to FS) + * @param conf configuration to use (fallback to fs) + * @param destFile base name of the output files. + * @param uri URI of store -only needed if FS is null. + * @throws ExitUtil.ExitException failure. + */ + public static void dumpStore( + @Nullable final S3AFileSystem fs, + @Nullable DynamoDBMetadataStore store, Review comment: I will change the name on the hierarchy of classes to keep you happy ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
