|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.hbase.regionserver.wal.HLogPrettyPrinter
@InterfaceAudience.Public @InterfaceStability.Evolving public class HLogPrettyPrinter
HLogPrettyPrinter prints the contents of a given HLog with a variety of options affecting formatting and extent of content. It targets two usage cases: pretty printing for ease of debugging directly by humans, and JSON output for consumption by monitoring and/or maintenance scripts. It can filter by row, region, or sequence id. It can also toggle output of values.
| Constructor Summary | |
|---|---|
HLogPrettyPrinter()
Basic constructor that simply initializes values to reasonable defaults. |
|
HLogPrettyPrinter(boolean outputValues,
boolean outputJSON,
long sequence,
String region,
String row,
boolean persistentOutput,
PrintStream out)
Fully specified constructor. |
|
| Method Summary | |
|---|---|
void |
beginPersistentOutput()
enables output as a single, persistent list. |
void |
disableJSON()
turns JSON output off, and turns on "pretty strings" for human consumption |
void |
disableValues()
turns value output off |
void |
enableJSON()
turns JSON output on |
void |
enableValues()
turns value output on |
void |
endPersistentOutput()
ends output of a single, persistent list. |
static void |
main(String[] args)
|
void |
processFile(org.apache.hadoop.conf.Configuration conf,
org.apache.hadoop.fs.Path p)
reads a log file and outputs its contents, one transaction at a time, as specified by the currently configured options |
static void |
run(String[] args)
Pass one or more log file names and formatting options and it will dump out a text version of the contents on stdout. |
void |
setRegionFilter(String region)
sets the region by which output will be filtered |
void |
setRowFilter(String row)
sets the region by which output will be filtered |
void |
setSequenceFilter(long sequence)
sets the region by which output will be filtered |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public HLogPrettyPrinter()
public HLogPrettyPrinter(boolean outputValues,
boolean outputJSON,
long sequence,
String region,
String row,
boolean persistentOutput,
PrintStream out)
outputValues - when true, enables output of values along with other log
informationoutputJSON - when true, enables output in JSON format rather than a
"pretty string"sequence - when nonnegative, serves as a filter; only log entries with this
sequence id will be printedregion - when not null, serves as a filter; only log entries from this
region will be printedrow - when not null, serves as a filter; only log entries from this row
will be printedpersistentOutput - keeps a single list running for multiple files. if enabled, the
endPersistentOutput() method must be used!out - Specifies an alternative to stdout for the destination of this
PrettyPrinter's output.| Method Detail |
|---|
public void enableValues()
public void disableValues()
public void enableJSON()
public void disableJSON()
public void setSequenceFilter(long sequence)
sequence - when nonnegative, serves as a filter; only log entries with this
sequence id will be printedpublic void setRegionFilter(String region)
region - when not null, serves as a filter; only log entries from this
region will be printedpublic void setRowFilter(String row)
row - when not null, serves as a filter; only log entries from this row
will be printedpublic void beginPersistentOutput()
public void endPersistentOutput()
public void processFile(org.apache.hadoop.conf.Configuration conf,
org.apache.hadoop.fs.Path p)
throws IOException
conf - the HBase configuration relevant to this log filep - the path of the log file to be read
IOException - may be unable to access the configured filesystem or requested
file.
public static void main(String[] args)
throws IOException
IOException
public static void run(String[] args)
throws IOException
stdout.
args - Command line arguments
IOException - Thrown upon file system errors etc.
org.apache.commons.cli.ParseException - Thrown if command-line parsing fails.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||