You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2018/12/13 14:45:11 UTC

[GitHub] sijie closed pull request #1840: Add get method for rest endpoint gc

sijie closed pull request #1840: Add get method for rest endpoint gc 
URL: https://github.com/apache/bookkeeper/pull/1840
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpRouter.java b/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpRouter.java
index 5384df6520..b4251d7327 100644
--- a/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpRouter.java
+++ b/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpRouter.java
@@ -46,6 +46,7 @@
     public static final String LIST_DISK_FILE               = "/api/v1/bookie/list_disk_file";
     public static final String EXPAND_STORAGE               = "/api/v1/bookie/expand_storage";
     public static final String GC                           = "/api/v1/bookie/gc";
+    public static final String GC_DETAILS                   = "/api/v1/bookie/gc_details";
     // autorecovery
     public static final String RECOVERY_BOOKIE              = "/api/v1/autorecovery/bookie";
     public static final String LIST_UNDER_REPLICATED_LEDGER = "/api/v1/autorecovery/list_under_replicated_ledger";
@@ -75,6 +76,7 @@ public HttpRouter(AbstractHttpHandlerFactory<Handler> handlerFactory) {
         this.endpointHandlers.put(LIST_DISK_FILE, handlerFactory.newHandler(HttpServer.ApiType.LIST_DISK_FILE));
         this.endpointHandlers.put(EXPAND_STORAGE, handlerFactory.newHandler(HttpServer.ApiType.EXPAND_STORAGE));
         this.endpointHandlers.put(GC, handlerFactory.newHandler(HttpServer.ApiType.GC));
+        this.endpointHandlers.put(GC_DETAILS, handlerFactory.newHandler(HttpServer.ApiType.GC_DETAILS));
 
         // autorecovery
         this.endpointHandlers.put(RECOVERY_BOOKIE, handlerFactory.newHandler(HttpServer.ApiType.RECOVERY_BOOKIE));
diff --git a/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpServer.java b/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpServer.java
index 5e9f509027..0922b56d90 100644
--- a/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpServer.java
+++ b/bookkeeper-http/http-server/src/main/java/org/apache/bookkeeper/http/HttpServer.java
@@ -78,6 +78,8 @@ public int getValue() {
         LIST_DISK_FILE,
         EXPAND_STORAGE,
         GC,
+        GC_DETAILS,
+
         // autorecovery
         RECOVERY_BOOKIE,
         LIST_UNDER_REPLICATED_LEDGER,
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectionStatus.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectionStatus.java
new file mode 100644
index 0000000000..e1728ddfa4
--- /dev/null
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectionStatus.java
@@ -0,0 +1,47 @@
+/**
+ *
+ * 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.bookie;
+
+import lombok.Builder;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * This is the garbage collection thread status.
+ * It includes what phase GarbageCollection (major/minor), gc counters, last gc time, etc.
+ */
+@Setter
+@Getter
+@Builder
+public class GarbageCollectionStatus {
+    // whether the GC thread is in force GC.
+    private boolean forceCompacting;
+    // whether the GC thread is in major compacting.
+    private boolean majorCompacting;
+    // whether the GC thread is in minor compacting.
+    private boolean minorCompacting;
+
+    private long lastMajorCompactionTime;
+    private long lastMinorCompactionTime;
+    private long majorCompactionCounter;
+    private long minorCompactionCounter;
+}
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectorThread.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectorThread.java
index 369883cd2e..ca02651e87 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectorThread.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/GarbageCollectorThread.java
@@ -108,6 +108,10 @@
     // to reduce the risk getting entry log corrupted
     final AtomicBoolean compacting = new AtomicBoolean(false);
 
+    // use to get the compacting status
+    final AtomicBoolean minorCompacting = new AtomicBoolean(false);
+    final AtomicBoolean majorCompacting = new AtomicBoolean(false);
+
     volatile boolean running = true;
 
     // track the last scanned successfully log id
@@ -298,6 +302,10 @@ public void disableForceGC() {
             });
     }
 
+    public boolean isInForceGC() {
+        return forceGarbageCollection.get();
+    }
+
     public void suspendMajorGC() {
         if (suspendMajorCompaction.compareAndSet(false, true)) {
             LOG.info("Suspend Major Compaction triggered by thread: {}", Thread.currentThread().getName());
@@ -376,18 +384,22 @@ public void runWithFlags(boolean force, boolean suspendMajor, boolean suspendMin
             && (force || curTime - lastMajorCompactionTime > majorCompactionInterval)) {
             // enter major compaction
             LOG.info("Enter major compaction, suspendMajor {}", suspendMajor);
+            majorCompacting.set(true);
             doCompactEntryLogs(majorCompactionThreshold);
             lastMajorCompactionTime = System.currentTimeMillis();
             // and also move minor compaction time
             lastMinorCompactionTime = lastMajorCompactionTime;
             majorCompactionCounter.inc();
+            majorCompacting.set(false);
         } else if (enableMinorCompaction && (!suspendMinor)
             && (force || curTime - lastMinorCompactionTime > minorCompactionInterval)) {
             // enter minor compaction
             LOG.info("Enter minor compaction, suspendMinor {}", suspendMinor);
+            minorCompacting.set(true);
             doCompactEntryLogs(minorCompactionThreshold);
             lastMinorCompactionTime = System.currentTimeMillis();
             minorCompactionCounter.inc();
+            minorCompacting.set(false);
         }
 
         if (force) {
@@ -601,4 +613,16 @@ protected void compactEntryLog(EntryLogMetadata entryLogMeta) {
     CompactableLedgerStorage getLedgerStorage() {
         return ledgerStorage;
     }
+
+    public GarbageCollectionStatus getGarbageCollectionStatus() {
+        return GarbageCollectionStatus.builder()
+            .forceCompacting(forceGarbageCollection.get())
+            .majorCompacting(majorCompacting.get())
+            .minorCompacting(minorCompacting.get())
+            .lastMajorCompactionTime(lastMajorCompactionTime)
+            .lastMinorCompactionTime(lastMinorCompactionTime)
+            .majorCompactionCounter(majorCompactionCounter.get())
+            .minorCompactionCounter(minorCompactionCounter.get())
+            .build();
+    }
 }
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/InterleavedLedgerStorage.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/InterleavedLedgerStorage.java
index 0a0e60da37..6078d6924a 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/InterleavedLedgerStorage.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/InterleavedLedgerStorage.java
@@ -37,6 +37,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.NavigableMap;
@@ -226,6 +227,11 @@ public void forceGC() {
         gcThread.enableForceGC();
     }
 
+    @Override
+    public boolean isInForceGC() {
+        return gcThread.isInForceGC();
+    }
+
     @Override
     public void start() {
         gcThread.start();
@@ -563,10 +569,10 @@ public void onRotateEntryLog() {
 
                         if (success.booleanValue()) {
                             pageScanStats.registerSuccessfulEvent(
-                                    MathUtils.elapsedNanos(start), TimeUnit.NANOSECONDS);
+                                MathUtils.elapsedNanos(start), TimeUnit.NANOSECONDS);
                         } else {
                             pageScanStats.registerFailedEvent(
-                                    MathUtils.elapsedNanos(start), TimeUnit.NANOSECONDS);
+                                MathUtils.elapsedNanos(start), TimeUnit.NANOSECONDS);
                         }
                     } while (retry.booleanValue());
                     checkedPages++;
@@ -584,15 +590,20 @@ public void onRotateEntryLog() {
             checkedLedgers++;
         }
         LOG.info(
-                "Finished localConsistencyCheck, took {}s to scan {} ledgers, {} pages, "
-                        + "{} entries with {} retries, {} errors",
-                TimeUnit.NANOSECONDS.toSeconds(MathUtils.elapsedNanos(checkStart)),
-                checkedLedgers,
-                checkedPages,
-                checkedEntries.longValue(),
-                pageRetries.longValue(),
-                errors.size());
+            "Finished localConsistencyCheck, took {}s to scan {} ledgers, {} pages, "
+                + "{} entries with {} retries, {} errors",
+            TimeUnit.NANOSECONDS.toSeconds(MathUtils.elapsedNanos(checkStart)),
+            checkedLedgers,
+            checkedPages,
+            checkedEntries.longValue(),
+            pageRetries.longValue(),
+            errors.size());
 
         return errors;
     }
+
+    @Override
+    public List<GarbageCollectionStatus> getGarbageCollectionStatus() {
+        return Collections.singletonList(gcThread.getGarbageCollectionStatus());
+    }
 }
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/LedgerStorage.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/LedgerStorage.java
index 7a98fc797b..111b8c213f 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/LedgerStorage.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/LedgerStorage.java
@@ -25,6 +25,7 @@
 import io.netty.buffer.ByteBuf;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import org.apache.bookkeeper.bookie.CheckpointSource.Checkpoint;
@@ -224,4 +225,24 @@ public Exception getException() {
     default List<DetectedInconsistency> localConsistencyCheck(Optional<RateLimiter> rateLimiter) throws IOException {
         return new ArrayList<>();
     }
+
+    /**
+     * Whether force triggered Garbage Collection is running or not.
+     *
+     * @return
+     *      true  -- force triggered Garbage Collection is running,
+     *      false -- force triggered Garbage Collection is not running
+     */
+    default boolean isInForceGC() {
+        return false;
+    }
+
+
+    /**
+     * Get Garbage Collection status.
+     * Since DbLedgerStorage is a list of storage instances, we should return a list.
+     */
+    default List<GarbageCollectionStatus> getGarbageCollectionStatus() {
+        return Collections.emptyList();
+    }
 }
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/SortedLedgerStorage.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/SortedLedgerStorage.java
index dd07d75550..5e4dbadd2a 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/SortedLedgerStorage.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/SortedLedgerStorage.java
@@ -340,4 +340,14 @@ public void forceGC() {
     public List<DetectedInconsistency> localConsistencyCheck(Optional<RateLimiter> rateLimiter) throws IOException {
         return interleavedLedgerStorage.localConsistencyCheck(rateLimiter);
     }
+
+    @Override
+    public boolean isInForceGC() {
+        return interleavedLedgerStorage.isInForceGC();
+    }
+
+    @Override
+    public List<GarbageCollectionStatus> getGarbageCollectionStatus() {
+        return interleavedLedgerStorage.getGarbageCollectionStatus();
+    }
 }
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/DbLedgerStorage.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/DbLedgerStorage.java
index 4c5fd33197..070656573d 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/DbLedgerStorage.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/DbLedgerStorage.java
@@ -39,12 +39,14 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 
+import java.util.stream.Collectors;
 import lombok.extern.slf4j.Slf4j;
 
 import org.apache.bookkeeper.bookie.BookieException;
 import org.apache.bookkeeper.bookie.CheckpointSource;
 import org.apache.bookkeeper.bookie.CheckpointSource.Checkpoint;
 import org.apache.bookkeeper.bookie.Checkpointer;
+import org.apache.bookkeeper.bookie.GarbageCollectionStatus;
 import org.apache.bookkeeper.bookie.LastAddConfirmedUpdateNotification;
 import org.apache.bookkeeper.bookie.LedgerCache;
 import org.apache.bookkeeper.bookie.LedgerDirsManager;
@@ -359,4 +361,15 @@ public static void readLedgerIndexEntries(long ledgerId, ServerConfiguration ser
     public void forceGC() {
         ledgerStorageList.stream().forEach(SingleDirectoryDbLedgerStorage::forceGC);
     }
+
+    @Override
+    public boolean isInForceGC() {
+        return ledgerStorageList.stream().anyMatch(SingleDirectoryDbLedgerStorage::isInForceGC);
+    }
+
+    @Override
+    public List<GarbageCollectionStatus> getGarbageCollectionStatus() {
+        return ledgerStorageList.stream()
+            .map(single -> single.getGarbageCollectionStatus().get(0)).collect(Collectors.toList());
+    }
 }
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/SingleDirectoryDbLedgerStorage.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/SingleDirectoryDbLedgerStorage.java
index 2e3c5562ab..58504ab6b7 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/SingleDirectoryDbLedgerStorage.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/storage/ldb/SingleDirectoryDbLedgerStorage.java
@@ -30,6 +30,8 @@
 import io.netty.util.concurrent.DefaultThreadFactory;
 
 import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -49,6 +51,7 @@
 import org.apache.bookkeeper.bookie.CompactableLedgerStorage;
 import org.apache.bookkeeper.bookie.EntryLocation;
 import org.apache.bookkeeper.bookie.EntryLogger;
+import org.apache.bookkeeper.bookie.GarbageCollectionStatus;
 import org.apache.bookkeeper.bookie.GarbageCollectorThread;
 import org.apache.bookkeeper.bookie.LastAddConfirmedUpdateNotification;
 import org.apache.bookkeeper.bookie.LedgerCache;
@@ -269,6 +272,11 @@ public void forceGC() {
         gcThread.enableForceGC();
     }
 
+    @Override
+    public boolean isInForceGC() {
+        return gcThread.isInForceGC();
+    }
+
     @Override
     public void shutdown() throws InterruptedException {
         try {
@@ -922,6 +930,11 @@ long getReadCacheCount() {
         return readCache.count();
     }
 
+    @Override
+    public List<GarbageCollectionStatus> getGarbageCollectionStatus() {
+        return Collections.singletonList(gcThread.getGarbageCollectionStatus());
+    }
+
     /**
      * Interface which process ledger logger.
      */
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/BKHttpServiceProvider.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/BKHttpServiceProvider.java
index 102b0eb57e..662777cadd 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/BKHttpServiceProvider.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/BKHttpServiceProvider.java
@@ -41,6 +41,7 @@
 import org.apache.bookkeeper.server.http.service.DecommissionService;
 import org.apache.bookkeeper.server.http.service.DeleteLedgerService;
 import org.apache.bookkeeper.server.http.service.ExpandStorageService;
+import org.apache.bookkeeper.server.http.service.GCDetailsService;
 import org.apache.bookkeeper.server.http.service.GetLastLogMarkService;
 import org.apache.bookkeeper.server.http.service.GetLedgerMetaService;
 import org.apache.bookkeeper.server.http.service.ListBookieInfoService;
@@ -211,6 +212,8 @@ public HttpEndpointService provideHttpEndpointService(ApiType type) {
                 return new ExpandStorageService(configuration);
             case GC:
                 return new TriggerGCService(configuration, bookieServer);
+            case GC_DETAILS:
+                return new GCDetailsService(configuration, bookieServer);
 
             // autorecovery
             case RECOVERY_BOOKIE:
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/GCDetailsService.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/GCDetailsService.java
new file mode 100644
index 0000000000..29b59e271b
--- /dev/null
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/GCDetailsService.java
@@ -0,0 +1,85 @@
+/*
+ * 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.server.http.service;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.List;
+import org.apache.bookkeeper.bookie.GarbageCollectionStatus;
+import org.apache.bookkeeper.common.util.JsonUtil;
+import org.apache.bookkeeper.conf.ServerConfiguration;
+import org.apache.bookkeeper.http.HttpServer;
+import org.apache.bookkeeper.http.service.HttpEndpointService;
+import org.apache.bookkeeper.http.service.HttpServiceRequest;
+import org.apache.bookkeeper.http.service.HttpServiceResponse;
+import org.apache.bookkeeper.proto.BookieServer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * HttpEndpointService that handle get garbage collection details service.
+ *
+ * <p>Get Garbage Collection status, the output would be like:
+ *        [ {
+ *           "forceCompacting" : false,
+ *           "majorCompacting" : false,
+ *           "minorCompacting" : false,
+ *           "lastMajorCompactionTime" : 1544578144944,
+ *           "lastMinorCompactionTime" : 1544578144944,
+ *           "majorCompactionCounter" : 1,
+ *           "minorCompactionCounter" : 0
+ *         } ]
+ */
+public class GCDetailsService implements HttpEndpointService {
+
+    static final Logger LOG = LoggerFactory.getLogger(GCDetailsService.class);
+
+    protected ServerConfiguration conf;
+    protected BookieServer bookieServer;
+
+    public GCDetailsService(ServerConfiguration conf, BookieServer bookieServer) {
+        checkNotNull(conf);
+        checkNotNull(bookieServer);
+        this.conf = conf;
+        this.bookieServer = bookieServer;
+    }
+
+    @Override
+    public HttpServiceResponse handle(HttpServiceRequest request) throws Exception {
+        HttpServiceResponse response = new HttpServiceResponse();
+
+        if (HttpServer.Method.GET == request.getMethod()) {
+            List<GarbageCollectionStatus> details = bookieServer.getBookie()
+                .getLedgerStorage().getGarbageCollectionStatus();
+
+            String jsonResponse = JsonUtil.toJson(details);
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("output body:" + jsonResponse);
+            }
+            response.setBody(jsonResponse);
+            response.setCode(HttpServer.StatusCode.OK);
+            return response;
+        } else {
+            response.setCode(HttpServer.StatusCode.NOT_FOUND);
+            response.setBody("Only support GET method to retrieve GC details."
+                + " If you want to trigger gc, send a POST to gc endpoint.");
+            return response;
+        }
+    }
+}
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/TriggerGCService.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/TriggerGCService.java
index 185965afad..ebf9ea9c34 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/TriggerGCService.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/server/http/service/TriggerGCService.java
@@ -27,6 +27,7 @@
 import org.apache.bookkeeper.http.service.HttpServiceRequest;
 import org.apache.bookkeeper.http.service.HttpServiceResponse;
 import org.apache.bookkeeper.proto.BookieServer;
+import org.apache.commons.lang3.tuple.Pair;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -34,6 +35,12 @@
  * HttpEndpointService that handle force trigger GC requests.
  *
  * <p>The PUT method will force trigger GC on current bookie, and make GC run at backend.
+ *
+ * <p>The GET method will get the force triggered GC running or not.
+ * Output would be like:
+ *        {
+ *           "is_in_force_gc" : "false"
+ *        }
  */
 public class TriggerGCService implements HttpEndpointService {
 
@@ -52,19 +59,31 @@ public TriggerGCService(ServerConfiguration conf, BookieServer bookieServer) {
     @Override
     public HttpServiceResponse handle(HttpServiceRequest request) throws Exception {
         HttpServiceResponse response = new HttpServiceResponse();
-        // PUT
+
         if (HttpServer.Method.PUT == request.getMethod()) {
             bookieServer.getBookie().getLedgerStorage().forceGC();
 
             String output = "Triggered GC on BookieServer: " + bookieServer.toString();
             String jsonResponse = JsonUtil.toJson(output);
-            LOG.debug("output body:" + jsonResponse);
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("output body:" + jsonResponse);
+            }
+            response.setBody(jsonResponse);
+            response.setCode(HttpServer.StatusCode.OK);
+            return response;
+        } else if (HttpServer.Method.GET == request.getMethod()) {
+            Boolean isInForceGC = bookieServer.getBookie().getLedgerStorage().isInForceGC();
+            Pair<String, String> output = Pair.of("is_in_force_gc", isInForceGC.toString());
+            String jsonResponse = JsonUtil.toJson(output);
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("output body:" + jsonResponse);
+            }
             response.setBody(jsonResponse);
             response.setCode(HttpServer.StatusCode.OK);
             return response;
         } else {
             response.setCode(HttpServer.StatusCode.NOT_FOUND);
-            response.setBody("Not found method. Should be PUT method to trigger GC.");
+            response.setBody("Not found method. Should be PUT to trigger GC, Or GET to get Force GC state.");
             return response;
         }
     }
diff --git a/bookkeeper-server/src/test/java/org/apache/bookkeeper/server/http/TestHttpService.java b/bookkeeper-server/src/test/java/org/apache/bookkeeper/server/http/TestHttpService.java
index e88d29d3a6..da25d14d5c 100644
--- a/bookkeeper-server/src/test/java/org/apache/bookkeeper/server/http/TestHttpService.java
+++ b/bookkeeper-server/src/test/java/org/apache/bookkeeper/server/http/TestHttpService.java
@@ -743,9 +743,6 @@ public void testDecommissionService() throws Exception {
         stopAuditorElector();
     }
 
-    /**
-     * Create ledgers, then test Delete Ledger service.
-     */
     @Test
     public void testTriggerGCService() throws Exception {
         baseConf.setMetadataServiceUri(zkUtil.getMetadataServiceUri());
@@ -771,14 +768,59 @@ public void testTriggerGCService() throws Exception {
         HttpEndpointService triggerGCService = bkHttpServiceProvider
             .provideHttpEndpointService(HttpServer.ApiType.GC);
 
-        //1,  GET, should return NOT_FOUND
+        //1,  GET, should return OK
         HttpServiceRequest request1 = new HttpServiceRequest(null, HttpServer.Method.GET, null);
         HttpServiceResponse response1 = triggerGCService.handle(request1);
-        assertEquals(HttpServer.StatusCode.NOT_FOUND.getValue(), response1.getStatusCode());
+        assertEquals(HttpServer.StatusCode.OK.getValue(), response1.getStatusCode());
+        assertTrue(response1.getBody().contains("\"is_in_force_gc\" : \"false\""));
 
         //2, PUT, should return OK
         HttpServiceRequest request2 = new HttpServiceRequest(null, HttpServer.Method.PUT, null);
         HttpServiceResponse response2 = triggerGCService.handle(request2);
         assertEquals(HttpServer.StatusCode.OK.getValue(), response2.getStatusCode());
     }
+
+    @Test
+    public void testGCDetailsService() throws Exception {
+        baseConf.setMetadataServiceUri(zkUtil.getMetadataServiceUri());
+        BookKeeper.DigestType digestType = BookKeeper.DigestType.CRC32;
+        int numLedgers = 4;
+        int numMsgs = 100;
+        LedgerHandle[] lh = new LedgerHandle[numLedgers];
+        // create ledgers
+        for (int i = 0; i < numLedgers; i++) {
+            lh[i] = bkc.createLedger(digestType, "".getBytes());
+        }
+        String content = "This is test for GC details service!";
+        // add entries
+        for (int i = 0; i < numMsgs; i++) {
+            for (int j = 0; j < numLedgers; j++) {
+                lh[j].addEntry(content.getBytes());
+            }
+        }
+        // close ledgers
+        for (int i = 0; i < numLedgers; i++) {
+            lh[i].close();
+        }
+        HttpEndpointService gcDetailsService = bkHttpServiceProvider
+            .provideHttpEndpointService(HttpServer.ApiType.GC_DETAILS);
+
+        // force trigger a GC
+        HttpEndpointService triggerGCService = bkHttpServiceProvider
+            .provideHttpEndpointService(HttpServer.ApiType.GC);
+        HttpServiceRequest request0 = new HttpServiceRequest(null, HttpServer.Method.PUT, null);
+        HttpServiceResponse response0 = triggerGCService.handle(request0);
+        assertEquals(HttpServer.StatusCode.OK.getValue(), response0.getStatusCode());
+
+        //1,  GET, should return OK
+        HttpServiceRequest request1 = new HttpServiceRequest(null, HttpServer.Method.GET, null);
+        HttpServiceResponse response1 = gcDetailsService.handle(request1);
+        assertEquals(HttpServer.StatusCode.OK.getValue(), response1.getStatusCode());
+        LOG.info("Get response: {}", response1.getBody());
+
+        //2, PUT, should return NOT_FOUND
+        HttpServiceRequest request3 = new HttpServiceRequest(null, HttpServer.Method.PUT, null);
+        HttpServiceResponse response3 = gcDetailsService.handle(request3);
+        assertEquals(HttpServer.StatusCode.NOT_FOUND.getValue(), response3.getStatusCode());
+    }
 }
diff --git a/site/docs/latest/admin/http.md b/site/docs/latest/admin/http.md
index 7c1abea49f..270dcb3a16 100644
--- a/site/docs/latest/admin/http.md
+++ b/site/docs/latest/admin/http.md
@@ -282,6 +282,45 @@ Currently all the HTTP endpoints could be divided into these 4 components:
         |403 | Permission denied |
         |404 | Not found |
 
+1. Method: GET
+    * Description:  whether force triggered Garbage Collection is running or not for this bookie. true for is running.
+    * Response:
+
+        | Code   | Description |
+        |:-------|:------------|
+        |200 | Successful operation |
+        |403 | Permission denied |
+        |404 | Not found |
+    * Body:
+       ```json
+       {
+          "is_in_force_gc" : "false"
+       }
+       ```
+
+### Endpoint: /api/v1/bookie/gc_details
+1. Method: GET
+    * Description:  get details of Garbage Collection Thread, like whether it is in compacting, last compaction time, compaction counter, etc.
+    * Response:
+
+        | Code   | Description |
+        |:-------|:------------|
+        |200 | Successful operation |
+        |403 | Permission denied |
+        |404 | Not found |
+    * Body:
+       ```json
+       [ {
+          "forceCompacting" : false,
+          "majorCompacting" : false,
+          "minorCompacting" : false,
+          "lastMajorCompactionTime" : 1544578144944,
+          "lastMinorCompactionTime" : 1544578144944,
+          "majorCompactionCounter" : 1,
+          "minorCompactionCounter" : 0
+        } ]
+       ```
+
 ## Auto recovery
 
 ### Endpoint: /api/v1/autorecovery/bookie/


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services