This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new c391fe5 Migrate command `readlogmetadata`
c391fe5 is described below
commit c391fe58dfdb283e54d809a8d24200c9a34d5dfc
Author: Yong Zhang <[email protected]>
AuthorDate: Wed Apr 3 02:21:14 2019 +0800
Migrate command `readlogmetadata`
Descriptions of the changes in this PR:
#2038
Reviewers: Sijie Guo <[email protected]>
This closes #2039 from zymap/command-readlogmetadata
---
.../org/apache/bookkeeper/bookie/BookieShell.java | 20 +--
.../apache/bookkeeper/bookie/EntryLogMetadata.java | 2 +-
.../commands/bookie/ReadLogMetadataCommand.java | 145 +++++++++++++++++++++
.../tools/cli/commands/BookieCommandGroup.java | 2 +
.../bookie/ReadLogMetadataCommandTest.java | 88 +++++++++++++
5 files changed, 242 insertions(+), 15 deletions(-)
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/BookieShell.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/BookieShell.java
index a656f38..72546e4 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/BookieShell.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/BookieShell.java
@@ -109,6 +109,7 @@ import
org.apache.bookkeeper.tools.cli.commands.bookie.LedgerCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ListFilesOnDiscCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ListLedgersCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ReadJournalCommand;
+import org.apache.bookkeeper.tools.cli.commands.bookie.ReadLogMetadataCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.SanityTestCommand;
import org.apache.bookkeeper.tools.cli.commands.bookies.InfoCommand;
import org.apache.bookkeeper.tools.cli.commands.bookies.ListBookiesCommand;
@@ -1306,6 +1307,8 @@ public class BookieShell implements Tool {
@Override
public int runCmd(CommandLine cmdLine) throws Exception {
+ ReadLogMetadataCommand cmd = new
ReadLogMetadataCommand(ledgerIdFormatter);
+ ReadLogMetadataCommand.ReadLogMetadataFlags flags = new
ReadLogMetadataCommand.ReadLogMetadataFlags();
String[] leftArgs = cmdLine.getArgs();
if (leftArgs.length <= 0) {
LOG.error("ERROR: missing entry log id or entry log file
name");
@@ -1316,22 +1319,11 @@ public class BookieShell implements Tool {
long logId;
try {
logId = Long.parseLong(leftArgs[0]);
+ flags.logId(logId);
} catch (NumberFormatException nfe) {
- // not a entry log id
- File f = new File(leftArgs[0]);
- String name = f.getName();
- if (!name.endsWith(".log")) {
- // not a log file
- LOG.error("ERROR: invalid entry log file name " +
leftArgs[0]);
- printUsage();
- return -1;
- }
- String idString = name.split("\\.")[0];
- logId = Long.parseLong(idString, 16);
+ flags.logFilename(leftArgs[0]);
}
-
- printEntryLogMetadata(logId);
-
+ cmd.apply(bkConf, flags);
return 0;
}
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/EntryLogMetadata.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/EntryLogMetadata.java
index ad6d87d..17cf58f 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/EntryLogMetadata.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/EntryLogMetadata.java
@@ -74,7 +74,7 @@ public class EntryLogMetadata {
return remainingSize;
}
- ConcurrentLongLongHashMap getLedgersMap() {
+ public ConcurrentLongLongHashMap getLedgersMap() {
return ledgersMap;
}
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommand.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommand.java
new file mode 100644
index 0000000..4b73742
--- /dev/null
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommand.java
@@ -0,0 +1,145 @@
+/*
+ * 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.bookkeeper.tools.cli.commands.bookie;
+
+import com.beust.jcommander.Parameter;
+import com.google.common.util.concurrent.UncheckedExecutionException;
+import java.io.File;
+import java.io.IOException;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.apache.bookkeeper.bookie.EntryLogMetadata;
+import org.apache.bookkeeper.bookie.EntryLogger;
+import org.apache.bookkeeper.bookie.ReadOnlyEntryLogger;
+import org.apache.bookkeeper.conf.ServerConfiguration;
+import
org.apache.bookkeeper.tools.cli.commands.bookie.ReadLogMetadataCommand.ReadLogMetadataFlags;
+import org.apache.bookkeeper.tools.cli.helpers.BookieCommand;
+import org.apache.bookkeeper.tools.framework.CliFlags;
+import org.apache.bookkeeper.tools.framework.CliSpec;
+import org.apache.bookkeeper.util.LedgerIdFormatter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Command to print metadata of entry log.
+ */
+public class ReadLogMetadataCommand extends
BookieCommand<ReadLogMetadataFlags> {
+
+ static final Logger LOG =
LoggerFactory.getLogger(ReadLogMetadataFlags.class);
+
+ private static final String NAME = "readlogmetadata";
+ private static final String DESC = "Prints entrylog's metadata";
+
+ private static final long DEFAULT_LOGID = -1L;
+ private static final String DEFAULT_FILENAME = "";
+ private static final String DEFAULT = "";
+
+ private LedgerIdFormatter ledgerIdFormatter;
+
+ EntryLogger entryLogger = null;
+
+ public ReadLogMetadataCommand() {
+ this(new ReadLogMetadataFlags());
+ }
+
+ public ReadLogMetadataCommand(LedgerIdFormatter ledgerIdFormatter) {
+ this(new ReadLogMetadataFlags());
+ this.ledgerIdFormatter = ledgerIdFormatter;
+ }
+
+ private ReadLogMetadataCommand(ReadLogMetadataFlags flags) {
+ super(CliSpec.<ReadLogMetadataFlags>newBuilder()
+ .withName(NAME)
+ .withDescription(DESC)
+ .withFlags(flags)
+ .build());
+ }
+
+ /**
+ * Flags for read log metadata command.
+ */
+ @Accessors(fluent = true)
+ @Setter
+ public static class ReadLogMetadataFlags extends CliFlags {
+
+ @Parameter(names = { "-l", "--logid" }, description = "Entry log id")
+ private long logId;
+
+ @Parameter(names = { "-f", "--filename" }, description = "Entry log
filename")
+ private String logFilename;
+
+ @Parameter(names = { "-lf", "--ledgeridformatter" }, description =
"Set ledger id formatter")
+ private String ledgerIdFormatter = DEFAULT;
+
+ }
+
+ @Override
+ public boolean apply(ServerConfiguration conf, ReadLogMetadataFlags
cmdFlags) {
+ if (!cmdFlags.ledgerIdFormatter.equals(DEFAULT) && ledgerIdFormatter
== null) {
+ this.ledgerIdFormatter =
LedgerIdFormatter.newLedgerIdFormatter(cmdFlags.ledgerIdFormatter, conf);
+ } else if (ledgerIdFormatter == null) {
+ this.ledgerIdFormatter =
LedgerIdFormatter.newLedgerIdFormatter(conf);
+ }
+ if (cmdFlags.logId == DEFAULT_LOGID &&
cmdFlags.logFilename.equals(DEFAULT_FILENAME)) {
+ System.err.println("Missing entry log id or entry log file name");
+ return false;
+ }
+ try {
+ return readLogMetadata(conf, cmdFlags);
+ } catch (IOException e) {
+ throw new UncheckedExecutionException(e.getMessage(), e);
+ }
+ }
+
+ public boolean readLogMetadata(ServerConfiguration conf,
ReadLogMetadataFlags flags) throws IOException {
+ long logid = DEFAULT_LOGID;
+ if (flags.logId != DEFAULT_LOGID) {
+ logid = flags.logId;
+ } else if (!flags.logFilename.equals(DEFAULT_FILENAME)) {
+ File f = new File(flags.logFilename);
+ String name = f.getName();
+ if (!name.endsWith(".log")) {
+ LOG.error("ERROR: invalid entry log file name " +
flags.logFilename);
+ return false;
+ }
+ String idString = name.split("\\.")[0];
+ logid = Long.parseLong(idString, 16);
+ }
+
+ printEntryLogMetadata(conf, logid);
+ return true;
+ }
+
+ private void printEntryLogMetadata(ServerConfiguration conf, long logId)
throws IOException {
+ LOG.info("Print entryLogMetadata of entrylog {} ({}.log)", logId,
Long.toHexString(logId));
+ initEntryLogger(conf);
+ EntryLogMetadata entryLogMetadata =
entryLogger.getEntryLogMetadata(logId);
+ entryLogMetadata.getLedgersMap().forEach((ledgerId, size) -> {
+ LOG.info("--------- Lid={}, TotalSizeOfEntriesOfLedger={}
---------",
+ ledgerIdFormatter.formatLedgerId(ledgerId), size);
+ });
+ }
+
+ private synchronized void initEntryLogger(ServerConfiguration conf) throws
IOException {
+ // provide read only entry logger
+ if (null == entryLogger) {
+ entryLogger = new ReadOnlyEntryLogger(conf);
+ }
+ }
+}
diff --git
a/tools/ledger/src/main/java/org/apache/bookkeeper/tools/cli/commands/BookieCommandGroup.java
b/tools/ledger/src/main/java/org/apache/bookkeeper/tools/cli/commands/BookieCommandGroup.java
index 4967889..98480ef 100644
---
a/tools/ledger/src/main/java/org/apache/bookkeeper/tools/cli/commands/BookieCommandGroup.java
+++
b/tools/ledger/src/main/java/org/apache/bookkeeper/tools/cli/commands/BookieCommandGroup.java
@@ -30,6 +30,7 @@ import
org.apache.bookkeeper.tools.cli.commands.bookie.LedgerCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ListFilesOnDiscCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ListLedgersCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.ReadJournalCommand;
+import org.apache.bookkeeper.tools.cli.commands.bookie.ReadLogMetadataCommand;
import org.apache.bookkeeper.tools.cli.commands.bookie.SanityTestCommand;
import org.apache.bookkeeper.tools.common.BKFlags;
import org.apache.bookkeeper.tools.framework.CliCommandGroup;
@@ -58,6 +59,7 @@ public class BookieCommandGroup extends
CliCommandGroup<BKFlags> {
.addCommand(new ListLedgersCommand())
.addCommand(new ConvertToInterleavedStorageCommand())
.addCommand(new ReadJournalCommand())
+ .addCommand(new ReadLogMetadataCommand())
.build();
public BookieCommandGroup() {
diff --git
a/tools/ledger/src/test/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommandTest.java
b/tools/ledger/src/test/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommandTest.java
new file mode 100644
index 0000000..983c9b1
--- /dev/null
+++
b/tools/ledger/src/test/java/org/apache/bookkeeper/tools/cli/commands/bookie/ReadLogMetadataCommandTest.java
@@ -0,0 +1,88 @@
+/*
+ * 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.bookkeeper.tools.cli.commands.bookie;
+
+import static org.mockito.ArgumentMatchers.anyLong;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.powermock.api.mockito.PowerMockito.verifyNew;
+import static org.powermock.api.mockito.PowerMockito.when;
+
+import org.apache.bookkeeper.bookie.EntryLogMetadata;
+import org.apache.bookkeeper.bookie.ReadOnlyEntryLogger;
+import org.apache.bookkeeper.conf.ServerConfiguration;
+import org.apache.bookkeeper.tools.cli.helpers.BookieCommandTestBase;
+import org.apache.bookkeeper.util.collections.ConcurrentLongLongHashMap;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+
+/**
+ * Unit test for {@link ReadLogMetadataCommand}.
+ */
+@RunWith(PowerMockRunner.class)
+@PrepareForTest({ ReadLogMetadataCommand.class })
+public class ReadLogMetadataCommandTest extends BookieCommandTestBase {
+
+ @Mock
+ private ReadOnlyEntryLogger entryLogger;
+
+ @Mock
+ private EntryLogMetadata entryLogMetadata;
+
+ public ReadLogMetadataCommandTest() {
+ super(3, 0);
+ }
+
+ @Override
+ public void setup() throws Exception {
+ super.setup();
+
+
PowerMockito.whenNew(ServerConfiguration.class).withNoArguments().thenReturn(conf);
+
+
PowerMockito.whenNew(ReadOnlyEntryLogger.class).withArguments(eq(conf)).thenReturn(entryLogger);
+
when(entryLogger.getEntryLogMetadata(anyLong())).thenReturn(entryLogMetadata);
+
+ ConcurrentLongLongHashMap map = new ConcurrentLongLongHashMap();
+ map.put(1, 1);
+ when(entryLogMetadata.getLedgersMap()).thenReturn(map);
+
+ }
+
+ @Test
+ public void testWithoutFlags() {
+ ReadLogMetadataCommand cmd = new ReadLogMetadataCommand();
+ Assert.assertFalse(cmd.apply(bkFlags, new String[] {"-l", "-1", "-f",
""}));
+ }
+
+ @Test
+ public void commandTest() throws Exception {
+ ReadLogMetadataCommand cmd = new ReadLogMetadataCommand();
+ Assert.assertTrue(cmd.apply(bkFlags, new String[] { "-l", "1" }));
+ verifyNew(ReadOnlyEntryLogger.class, times(1)).withArguments(eq(conf));
+ verify(entryLogger, times(1)).getEntryLogMetadata(anyLong());
+ verify(entryLogMetadata, times(1)).getLedgersMap();
+ }
+}
+
