HBASE-25193: Add support for row prefix and type in the WAL Pretty Printer

Closes #2556

Signed-off-by: Wellington Chevreuil <wchevreuil@apache.org>
Signed-off-by: Bharath Vissapragada <bharathv@apache.org>
Signed-off-by: Duo Zhang <zhangduo@apache.org>
Signed-off-by: Viraj Jasani <vjasani@apache.org>
This commit is contained in:
Sandeep Pal 2020-10-23 12:23:36 +05:30 committed by Viraj Jasani
parent d8de24c311
commit 5e3ffb1db6
No known key found for this signature in database
GPG Key ID: B3D6C0B41C8ADFD5
2 changed files with 70 additions and 21 deletions

View File

@ -105,7 +105,7 @@ public class WALProcedurePrettyPrinter extends AbstractHBaseTool {
if (!Bytes.equals(PROC_FAMILY, 0, PROC_FAMILY.length, cell.getFamilyArray(),
cell.getFamilyOffset(), cell.getFamilyLength())) {
// We could have cells other than procedure edits, for example, a flush marker
WALPrettyPrinter.printCell(out, op, false);
WALPrettyPrinter.printCell(out, op, false, false);
continue;
}
long procId = Bytes.toLong(cell.getRowArray(), cell.getRowOffset(), cell.getRowLength());

View File

@ -46,7 +46,7 @@ import org.apache.yetus.audience.InterfaceAudience;
import org.apache.yetus.audience.InterfaceStability;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.hbase.thirdparty.com.google.common.base.Strings;
import org.apache.hbase.thirdparty.com.google.gson.Gson;
import org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine;
import org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLineParser;
@ -85,7 +85,12 @@ public class WALPrettyPrinter {
// List of tables for filter
private final Set<String> tableSet;
private String region;
// exact row which needs to be filtered
private String row;
// prefix of rows which needs to be filtered
private String rowPrefix;
private boolean outputOnlyRowKey;
// enable in order to output a single list of transactions from several files
private boolean persistentOutput;
@ -107,6 +112,7 @@ public class WALPrettyPrinter {
tableSet = new HashSet<>();
region = null;
row = null;
rowPrefix = null;
outputOnlyRowKey = false;
persistentOutput = false;
firstTxn = true;
@ -181,6 +187,17 @@ public class WALPrettyPrinter {
this.row = row;
}
/**
* sets the rowPrefix key prefix by which output will be filtered
*
* @param rowPrefix
* when not null, serves as a filter; only log entries with rows
* having this prefix will be printed
*/
public void setRowPrefixFilter(String rowPrefix) {
this.rowPrefix = rowPrefix;
}
/**
* Option to print the row key only in case you just need the row keys from the WAL
*/
@ -301,15 +318,12 @@ public class WALPrettyPrinter {
List<Map<String, Object>> actions = new ArrayList<>();
for (Cell cell : edit.getCells()) {
// add atomic operation to txn
Map<String, Object> op = new HashMap<>(toStringMap(cell, outputOnlyRowKey));
if (outputValues) {
op.put("value", Bytes.toStringBinary(CellUtil.cloneValue(cell)));
Map<String, Object> op =
new HashMap<>(toStringMap(cell, outputOnlyRowKey, rowPrefix, row, outputValues));
if (op.isEmpty()) {
continue;
}
// check row output filter
if (row == null || ((String) op.get("row")).equals(row)) {
actions.add(op);
}
op.put("total_size_sum", cell.heapSize());
actions.add(op);
}
if (actions.isEmpty()) {
continue;
@ -326,15 +340,19 @@ public class WALPrettyPrinter {
out.print(GSON.toJson(txn));
} else {
// Pretty output, complete with indentation by atomic action
out.println(String.format(outputTmpl,
if (!outputOnlyRowKey) {
out.println(String.format(outputTmpl,
txn.get("sequence"), txn.get("table"), txn.get("region"), new Date(writeTime)));
}
for (int i = 0; i < actions.size(); i++) {
Map<String, Object> op = actions.get(i);
printCell(out, op, outputValues);
printCell(out, op, outputValues, outputOnlyRowKey);
}
}
out.println("edit heap size: " + entry.getEdit().heapSize());
out.println("position: " + log.getPosition());
if (!outputOnlyRowKey) {
out.println("edit heap size: " + entry.getEdit().heapSize());
out.println("position: " + log.getPosition());
}
}
} finally {
log.close();
@ -344,9 +362,17 @@ public class WALPrettyPrinter {
}
}
public static void printCell(PrintStream out, Map<String, Object> op, boolean outputValues) {
out.println("row=" + op.get("row") + ", type=" + op.get("type") + ", column=" +
op.get("family") + ":" + op.get("qualifier"));
public static void printCell(PrintStream out, Map<String, Object> op,
boolean outputValues, boolean outputOnlyRowKey) {
String rowDetails = "row=" + op.get("row");
if (outputOnlyRowKey) {
out.println(rowDetails);
return;
}
rowDetails += ", column=" + op.get("family") + ":" + op.get("qualifier");
rowDetails += ", type=" + op.get("type");
out.println(rowDetails);
if (op.get("tag") != null) {
out.println(" tag: " + op.get("tag"));
}
@ -356,11 +382,20 @@ public class WALPrettyPrinter {
out.println("cell total size sum: " + op.get("total_size_sum"));
}
public static Map<String, Object> toStringMap(Cell cell, boolean printRowKeyOnly) {
public static Map<String, Object> toStringMap(Cell cell,
boolean printRowKeyOnly, String rowPrefix, String row, boolean outputValues) {
Map<String, Object> stringMap = new HashMap<>();
stringMap.put("row",
Bytes.toStringBinary(cell.getRowArray(), cell.getRowOffset(), cell.getRowLength()));
String rowKey = Bytes.toStringBinary(cell.getRowArray(),
cell.getRowOffset(), cell.getRowLength());
// Row and row prefix are mutually options so both cannot be true at the
// same time. We can include checks in the same condition
// Check if any of the filters are satisfied by the row, if not return empty map
if ((!Strings.isNullOrEmpty(rowPrefix) && !rowKey.startsWith(rowPrefix)) ||
(!Strings.isNullOrEmpty(row) && !rowKey.equals(row))) {
return stringMap;
}
stringMap.put("row", rowKey);
if (printRowKeyOnly) {
return stringMap;
}
@ -372,6 +407,7 @@ public class WALPrettyPrinter {
cell.getQualifierLength()));
stringMap.put("timestamp", cell.getTimestamp());
stringMap.put("vlen", cell.getValueLength());
stringMap.put("total_size_sum", cell.heapSize());
if (cell.getTagsLength() > 0) {
List<String> tagsString = new ArrayList<>();
Iterator<Tag> tagsIterator = PrivateCellUtil.tagsIterator(cell);
@ -382,11 +418,14 @@ public class WALPrettyPrinter {
}
stringMap.put("tag", tagsString);
}
if (outputValues) {
stringMap.put("value", Bytes.toStringBinary(CellUtil.cloneValue(cell)));
}
return stringMap;
}
public static Map<String, Object> toStringMap(Cell cell) {
return toStringMap(cell, false);
return toStringMap(cell, false, null, null, false);
}
public static void main(String[] args) throws IOException {
@ -417,6 +456,7 @@ public class WALPrettyPrinter {
options.addOption("k", "outputOnlyRowKey", false,
"Print only row keys");
options.addOption("w", "row", true, "Row to filter by. Pass row name.");
options.addOption("f", "rowPrefix", true, "Row prefix to filter by.");
options.addOption("g", "goto", true, "Position to seek to in the file");
WALPrettyPrinter printer = new WALPrettyPrinter();
@ -450,8 +490,17 @@ public class WALPrettyPrinter {
printer.setSequenceFilter(Long.parseLong(cmd.getOptionValue("s")));
}
if (cmd.hasOption("w")) {
if (cmd.hasOption("f")) {
throw new ParseException("Row and Row-prefix cannot be supplied together");
}
printer.setRowFilter(cmd.getOptionValue("w"));
}
if (cmd.hasOption("f")) {
if (cmd.hasOption("w")) {
throw new ParseException("Row and Row-prefix cannot be supplied together");
}
printer.setRowPrefixFilter(cmd.getOptionValue("f"));
}
if (cmd.hasOption("g")) {
printer.setPosition(Long.parseLong(cmd.getOptionValue("g")));
}