nodetool: add triggeroffstrategycompaction

Invoke new api to trigger offstrategy compaction on keyspaces/tables. Signed-off-by: Benny Halevy <[email protected]>
scylladb · Jul 26, 2021 · 1f79949 · 1f79949
1 parent 4ef8049
commit 1f79949
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 0 deletions.
diff --git a/src/java/org/apache/cassandra/service/StorageService.java b/src/java/org/apache/cassandra/service/StorageService.java
@@ -2983,6 +2983,16 @@ public int forceKeyspaceCleanup(int jobs, String keyspaceName, String... tables)
         return status.statusCode;
     }
 
+    public int triggerKeyspaceOffstrategyCompaction(String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
+    {
+        return triggerKeyspaceOffstrategyCompaction(0, keyspaceName, tables);
+    }
+
+    public int triggerKeyspaceOffstrategyCompaction(int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
+    {
+        throw new RuntimeException("triggerKeyspaceOffstrategyCompaction is not implemented");
+    }
+
     public int scrub(boolean disableSnapshot, boolean skipCorrupted, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
     {
         return scrub(disableSnapshot, skipCorrupted, true, 0, keyspaceName, tables);

diff --git a/src/java/org/apache/cassandra/service/StorageServiceMBean.java b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
@@ -269,6 +269,13 @@ public interface StorageServiceMBean extends NotificationEmitter
     public int forceKeyspaceCleanup(String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException;
     public int forceKeyspaceCleanup(int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException;
 
+    /**
+     * Trigger offstrategy compaction aon tables in  single keyspace
+     */
+    @Deprecated
+    public int triggerKeyspaceOffstrategyCompaction(String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException;
+    public int triggerKeyspaceOffstrategyCompaction(int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException;
+
     /**
      * Scrub (deserialize + reserialize at the latest version, skipping bad rows if any) the given keyspace.
      * If tableNames array is empty, all CFs are scrubbed.

diff --git a/src/java/org/apache/cassandra/tools/NodeProbe.java b/src/java/org/apache/cassandra/tools/NodeProbe.java
@@ -312,6 +312,11 @@ public int forceKeyspaceCleanup(int jobs, String keyspaceName, String... tables)
         return ssProxy.forceKeyspaceCleanup(jobs, keyspaceName, tables);
     }
 
+    public int triggerKeyspaceOffstrategyCompaction(int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
+    {
+        return ssProxy.triggerKeyspaceOffstrategyCompaction(jobs, keyspaceName, tables);
+    }
+
     public int scrub(boolean disableSnapshot, boolean skipCorrupted, boolean checkData, boolean reinsertOverflowedTTL, int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
     {
         return ssProxy.scrub(disableSnapshot, skipCorrupted, checkData, reinsertOverflowedTTL, jobs, keyspaceName, tables);
@@ -356,6 +361,22 @@ public void forceKeyspaceCleanup(PrintStream out, int jobs, String keyspaceName,
         }
     }
 
+    public void triggerKeyspaceOffstrategyCompaction(PrintStream out, int jobs, String keyspaceName, String... tableNames) throws IOException, ExecutionException, InterruptedException
+    {
+        checkJobs(out, jobs);
+        switch (triggerKeyspaceOffstrategyCompaction(jobs, keyspaceName, tableNames))
+        {
+            case 1:
+                failed = true;
+                out.println("Aborted offstrategy compaction of some tables in keyspace "+keyspaceName+", check server logs for more information.");
+                break;
+            case 2:
+                failed = true;
+                out.println("Failed offstrategy compaction of some tables in keyspace "+keyspaceName+", check server logs for more information");
+                break;
+        }
+    }
+
     public void scrub(PrintStream out, boolean disableSnapshot, boolean skipCorrupted, boolean checkData, boolean reinsertOverflowedTTL, int jobs, String keyspaceName, String... tables) throws IOException, ExecutionException, InterruptedException
     {
         checkJobs(out, jobs);

diff --git a/src/java/org/apache/cassandra/tools/NodeTool.java b/src/java/org/apache/cassandra/tools/NodeTool.java
@@ -98,6 +98,7 @@ public static void main(String... args)
                 // Remove for GA: InvalidateCounterCache.class,
                 // Remove for GA: Join.class,
                 Move.class,
+                OffstrategyCompaction.class,
                 // Remove for GA: PauseHandoff.class,
                 // Remove for GA: ResumeHandoff.class,
                 ProxyHistograms.class,

diff --git a/src/java/org/apache/cassandra/tools/nodetool/OffstrategyCompaction.java b/src/java/org/apache/cassandra/tools/nodetool/OffstrategyCompaction.java
@@ -0,0 +1,63 @@
+/*
+ * 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.cassandra.tools.nodetool;
+
+import io.airlift.command.Arguments;
+import io.airlift.command.Command;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import io.airlift.command.Option;
+import org.apache.cassandra.config.SchemaConstants;
+import org.apache.cassandra.tools.NodeProbe;
+import org.apache.cassandra.tools.NodeTool.NodeToolCmd;
+
+@Command(name = "triggeroffstrategycompaction", description = "Triggers offstrategy compaction of tables, if pending (e.g. post repair). By default, trigger offstrategy compaction in all keyspaces")
+public class OffstrategyCompaction extends NodeToolCmd
+{
+    @Arguments(usage = "[<keyspace> [<tables>...]]", description = "The keyspace followed by zero or more tables")
+    private List<String> args = new ArrayList<>();
+
+    @Option(title = "jobs",
+            name = {"-j", "--jobs"},
+            description = "Number of tables to trigger offstrategy compaction for simultanously, set to 0 to use all available compaction threads")
+    private int jobs = 0;
+
+    @Override
+    public void execute(NodeProbe probe)
+    {
+        List<String> keyspaces = parseOptionalKeyspace(args, probe, KeyspaceSet.NON_LOCAL_STRATEGY);
+        String[] tableNames = parseOptionalTables(args);
+
+        for (String keyspace : keyspaces)
+        {
+            if (SchemaConstants.isLocalSystemKeyspace(keyspace))
+                continue;
+
+            try
+            {
+                probe.triggerKeyspaceOffstrategyCompaction(System.out, jobs, keyspace, tableNames);
+            }
+            catch (Exception e)
+            {
+                throw new RuntimeException("Error occurred during trigger offstrategy compaction", e);
+            }
+        }
+    }
+}