org.apache.hadoop.hbase.snapshot

Class SnapshotInfo

java.lang.Object

org.apache.hadoop.hbase.util.AbstractHBaseTool

org.apache.hadoop.hbase.snapshot.SnapshotInfo

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@InterfaceAudience.Public
public final class SnapshotInfo
extends AbstractHBaseTool

Tool for dumping snapshot information.

1. Table Descriptor
2. Snapshot creation time, type, format version, ...
3. List of hfiles and wals
4. Stats about hfiles and logs sizes, percentage of shared with the source table, ...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SnapshotInfo.Options
static class	SnapshotInfo.SnapshotStats Statistics about the snapshot How many store files and logs are in the archive How many store files and logs are shared with the table Total store files and logs size and shared amount

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

AbstractHBaseTool.OptionsOrderComparator

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.hadoop.fs.FileSystem	fs
private boolean	listSnapshots
private static org.slf4j.Logger	LOG
private boolean	printSizeInBytes
private org.apache.hadoop.fs.Path	remoteDir
private org.apache.hadoop.fs.Path	rootDir
private boolean	showFiles
private boolean	showSchema
private boolean	showStats
private SnapshotManifest	snapshotManifest
private String	snapshotName

Fields inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

cmdLineArgs, conf, EXIT_FAILURE, EXIT_SUCCESS, LONG_HELP_OPTION, options, SHORT_HELP_OPTION

Constructor Summary

Constructors

Constructor and Description
SnapshotInfo()

Method Summary

Modifier and Type	Method and Description
protected void	addOptions() Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.
int	doWork() The "main function" of the tool
private String	fileSizeToString(long size)
private static void	getSnapshotFilesMap(org.apache.hadoop.conf.Configuration conf, SnapshotDescription snapshot, ExecutorService exec, ConcurrentHashMap<org.apache.hadoop.fs.Path,Integer> filesMap, AtomicLong uniqueHFilesArchiveSize, AtomicLong uniqueHFilesSize, AtomicLong uniqueHFilesMobSize) Gets the store files map for snapshot
static List<SnapshotDescription>	getSnapshotList(org.apache.hadoop.conf.Configuration conf) Returns the list of available snapshots in the specified location
static Map<org.apache.hadoop.fs.Path,Integer>	getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration conf, AtomicLong uniqueHFilesArchiveSize, AtomicLong uniqueHFilesSize, AtomicLong uniqueHFilesMobSize) Returns the map of store files based on path for all snapshots
static SnapshotInfo.SnapshotStats	getSnapshotStats(org.apache.hadoop.conf.Configuration conf, SnapshotDescription snapshot) Returns the snapshot stats
static SnapshotInfo.SnapshotStats	getSnapshotStats(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc, Map<org.apache.hadoop.fs.Path,Integer> filesMap) Returns the snapshot stats
private boolean	loadSnapshotInfo(String snapshotName) Load snapshot info and table descriptor for the specified snapshot
static void	main(String[] args)
private void	printFiles(boolean showFiles, boolean showStats) Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and the collected information.
private void	printInfo() Dump the SnapshotDescription
private void	printSchema() Dump the TableDescriptor
protected void	printUsage()
protected void	processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd) This method is called to process the options after they have been parsed.

Methods inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

addOption, addOptNoArg, addOptNoArg, addOptWithArg, addOptWithArg, addRequiredOption, addRequiredOptWithArg, addRequiredOptWithArg, doStaticMain, getConf, getOptionAsDouble, getOptionAsInt, getOptionAsLong, newParser, parseArgs, parseInt, parseLong, printUsage, processOldArgs, run, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

fs

private org.apache.hadoop.fs.FileSystem fs

rootDir

private org.apache.hadoop.fs.Path rootDir

snapshotManifest

private SnapshotManifest snapshotManifest

listSnapshots

private boolean listSnapshots

snapshotName

private String snapshotName

remoteDir

private org.apache.hadoop.fs.Path remoteDir

showSchema

private boolean showSchema

showFiles

private boolean showFiles

showStats

private boolean showStats

printSizeInBytes

private boolean printSizeInBytes

Constructor Detail

SnapshotInfo

public SnapshotInfo()

Method Detail

doWork

public int doWork()
           throws IOException,
                  InterruptedException

Description copied from class: AbstractHBaseTool

The "main function" of the tool

Specified by:

doWork in class AbstractHBaseTool

Throws:

IOException

InterruptedException

loadSnapshotInfo

private boolean loadSnapshotInfo(String snapshotName)
                          throws IOException

Load snapshot info and table descriptor for the specified snapshot

Parameters:

snapshotName - name of the snapshot to load

Returns:

false if snapshot is not found

Throws:

IOException

printInfo

private void printInfo()

Dump the SnapshotDescription

printSchema

private void printSchema()

Dump the TableDescriptor

printFiles

private void printFiles(boolean showFiles,
                        boolean showStats)
                 throws IOException

Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and the collected information.

Throws:

IOException

fileSizeToString

private String fileSizeToString(long size)

addOptions

protected void addOptions()

Description copied from class: AbstractHBaseTool

Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.

Specified by:

addOptions in class AbstractHBaseTool

processOptions

protected void processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd)

Description copied from class: AbstractHBaseTool

This method is called to process the options after they have been parsed.

Specified by:

processOptions in class AbstractHBaseTool

printUsage

protected void printUsage()

Overrides:

printUsage in class AbstractHBaseTool

getSnapshotStats

public static SnapshotInfo.SnapshotStats getSnapshotStats(org.apache.hadoop.conf.Configuration conf,
                                                          SnapshotDescription snapshot)
                                                   throws IOException

Returns the snapshot stats

Parameters:

conf - the Configuration to use

snapshot - SnapshotDescription to get stats from

Returns:

the snapshot stats

Throws:

IOException

getSnapshotStats

public static SnapshotInfo.SnapshotStats getSnapshotStats(org.apache.hadoop.conf.Configuration conf,
                                                          org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc,
                                                          Map<org.apache.hadoop.fs.Path,Integer> filesMap)
                                                   throws IOException

Returns the snapshot stats

Parameters:

conf - the Configuration to use

snapshotDesc - HBaseProtos.SnapshotDescription to get stats from

filesMap - Map store files map for all snapshots, it may be null

Returns:

the snapshot stats

Throws:

IOException

getSnapshotList

public static List<SnapshotDescription> getSnapshotList(org.apache.hadoop.conf.Configuration conf)
                                                 throws IOException

Returns the list of available snapshots in the specified location

Parameters:

conf - the Configuration to use

Returns:

the list of snapshots

Throws:

IOException

getSnapshotFilesMap

private static void getSnapshotFilesMap(org.apache.hadoop.conf.Configuration conf,
                                        SnapshotDescription snapshot,
                                        ExecutorService exec,
                                        ConcurrentHashMap<org.apache.hadoop.fs.Path,Integer> filesMap,
                                        AtomicLong uniqueHFilesArchiveSize,
                                        AtomicLong uniqueHFilesSize,
                                        AtomicLong uniqueHFilesMobSize)
                                 throws IOException

Gets the store files map for snapshot

Parameters:

conf - the Configuration to use

snapshot - SnapshotDescription to get stats from

exec - the ExecutorService to use

filesMap - Map the map to put the mapping entries

uniqueHFilesArchiveSize - AtomicLong the accumulated store file size in archive

uniqueHFilesSize - AtomicLong the accumulated store file size shared

uniqueHFilesMobSize - AtomicLong the accumulated mob store file size shared

Throws:

IOException

getSnapshotsFilesMap

public static Map<org.apache.hadoop.fs.Path,Integer> getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration conf,
                                                                          AtomicLong uniqueHFilesArchiveSize,
                                                                          AtomicLong uniqueHFilesSize,
                                                                          AtomicLong uniqueHFilesMobSize)
                                                                   throws IOException

Returns the map of store files based on path for all snapshots

Parameters:

conf - the Configuration to use

uniqueHFilesArchiveSize - pass out the size for store files in archive

uniqueHFilesSize - pass out the size for store files shared

uniqueHFilesMobSize - pass out the size for mob store files shared

Returns:

the map of store files

Throws:

IOException

main

public static void main(String[] args)