HBASE-26441: Add metrics for BrokenStoreFileCleaner

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterBrokenStoreFileCleaner.java

@@ -0,0 +1,82 @@
+/*
+ * 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.hadoop.hbase.master;
+
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * BrokenStoreFileCleaner metrics for a specific table in a RegionServer.
+ */
+@InterfaceAudience.Private
+public interface MetricsMasterBrokenStoreFileCleaner {
+
+  /**
+   * The name of the metrics
+   */
+  String METRICS_NAME = "BrokenStoreFileCleaner";
+
+  /**
+   * The name of the metrics context that metrics will be under.
+   */
+  String METRICS_CONTEXT = "master";
+
+  /**
+   * Description
+   */
+  String METRICS_DESCRIPTION =
+    "Metrics about BrokenStoreFileCleaner results on a single HBase RegionServer";
+
+  /**
+   * The name of the metrics context that metrics will be under in jmx
+   */
+  String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;
+
+
+  String DELETES = "BrokenStoreFileCleanerDeletes";
+  String DELETES_DESC = "Number of files deleted by BrokenStoreFileCleaner";
+  String FAILED_DELETES = "BrokenStoreFileCleanerFailedDeletes";
+  String FAILED_DELETES_DESC =
+    "Number of files BrokenStoreFileCleaner tried but failed to delete";
+  String RUNS = "BrokenStoreFileCleanerRuns";
+  String RUNS_DESC = "Number of time the BrokenStoreFileCleaner chore run";
+  String RUNTIME = "BrokenStoreFileCleanerRuntime";
+  String RUNTIME_DESC = "Time required to run BrokenStoreFileCleaner chore in milliseconds";
+
+  /**
+   * Increment the deleted files counter
+   * @param deletes number of new files deleted
+   */
+  public void incrementBrokenStoreFileCleanerDeletes(long deletes);
+
+  /**
+   * Increment the failed file deletes counter
+   * @param failedDeletes number of files the chore failed to delete
+   */
+  public void incrementBrokenStoreFileCleanerFailedDeletes(long failedDeletes);
+
+  /**
+   * Increment the number of cleaner runs counter
+   */
+  public void incrementBrokenStoreFileCleanerRuns(long runs);
+
+  /**
+   * Update the chore runtime
+   * @param milis Chore runtime
+   */
+  public void updateBrokenStoreFileCleanerTimer(long milis);
+
+}

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterBrokenStoreFileCleanerImpl.java

@@ -0,0 +1,68 @@
+/*
+ * 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.hadoop.hbase.master;
+
+import org.apache.hadoop.hbase.metrics.BaseSourceImpl;
+import org.apache.hadoop.metrics2.lib.MutableFastCounter;
+import org.apache.hadoop.metrics2.lib.MutableTimeHistogram;
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * Implementation of {@link MetricsMasterBrokenStoreFileCleaner} to track latencies for one table
+ * in a RegionServer.
+ */
+@InterfaceAudience.Private
+public class MetricsMasterBrokenStoreFileCleanerImpl extends BaseSourceImpl implements
+  MetricsMasterBrokenStoreFileCleaner {
+
+  private MutableFastCounter brokenStoreFileCleanerDeletes;
+  private MutableFastCounter brokenStoreFileCleanerFailedDeletes;
+  private MutableFastCounter brokenStoreFileCleanerRuns;
+  private MutableTimeHistogram brokenStoreFileCleanerTimer;
+
+  public MetricsMasterBrokenStoreFileCleanerImpl(String metricsName, String metricsDescription,
+    String metricsContext, String metricsJmxContext) {
+    super(metricsName, metricsDescription, metricsContext, metricsJmxContext);
+
+    brokenStoreFileCleanerDeletes =
+      getMetricsRegistry().newCounter(DELETES, DELETES_DESC, 0L);
+    brokenStoreFileCleanerFailedDeletes =
+      getMetricsRegistry().newCounter(FAILED_DELETES, FAILED_DELETES_DESC, 0L);
+    brokenStoreFileCleanerRuns = getMetricsRegistry().newCounter(RUNS, RUNS_DESC, 0L);
+    brokenStoreFileCleanerTimer = getMetricsRegistry().newTimeHistogram(RUNTIME, RUNTIME_DESC);
+  }
+
+  public MetricsMasterBrokenStoreFileCleanerImpl() {
+    this(METRICS_NAME, METRICS_DESCRIPTION, METRICS_CONTEXT, METRICS_JMX_CONTEXT);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerDeletes(long deletes) {
+    brokenStoreFileCleanerDeletes.incr(deletes);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerFailedDeletes(long failedDeletes) {
+    brokenStoreFileCleanerFailedDeletes.incr(failedDeletes);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerRuns(long runs) {
+    brokenStoreFileCleanerRuns.incr(runs);
+  }
+
+  @Override public void updateBrokenStoreFileCleanerTimer(long millis) {
+    brokenStoreFileCleanerTimer.add(millis);
+  }
+}

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsBrokenStoreFileCleaner.java

@@ -0,0 +1,82 @@
+/*
+ * 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.hadoop.hbase.regionserver;
+
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * BrokenStoreFileCleaner metrics for a specific RegionServer.
+ */
+@InterfaceAudience.Private
+public interface MetricsBrokenStoreFileCleaner {
+
+  /**
+   * The name of the metrics
+   */
+  String METRICS_NAME = "BrokenStoreFileCleaner";
+
+  /**
+   * The name of the metrics context that metrics will be under.
+   */
+  String METRICS_CONTEXT = "regionserver";
+
+  /**
+   * Description
+   */
+  String METRICS_DESCRIPTION =
+    "Metrics about BrokenStoreFileCleaner results on a single HBase RegionServer";
+
+  /**
+   * The name of the metrics context that metrics will be under in jmx
+   */
+  String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
+
+
+  String DELETES = "BrokenStoreFileCleanerDeletes";
+  String DELETES_DESC = "Number of files deleted by BrokenStoreFileCleaner";
+  String FAILED_DELETES = "BrokenStoreFileCleanerFailedDeletes";
+  String FAILED_DELETES_DESC =
+    "Number of files BrokenStoreFileCleaner tried but failed to delete";
+  String RUNS = "BrokenStoreFileCleanerRuns";
+  String RUNS_DESC = "Number of times the BrokenStoreFileCleaner chore run";
+  String RUNTIME = "BrokenStoreFileCleanerRuntime";
+  String RUNTIME_DESC = "Time required to run BrokenStoreFileCleaner chore in milliseconds";
+
+  /**
+   * Increment the deleted files counter
+   * @param deletes number of new files deleted
+   */
+  public void incrementBrokenStoreFileCleanerDeletes(long deletes);
+
+  /**
+   * Increment the failed file deletes counter
+   * @param failedDeletes number of files the chore failed to delete
+   */
+  public void incrementBrokenStoreFileCleanerFailedDeletes(long failedDeletes);
+
+  /**
+   * Increment the number of cleaner runs counter
+   */
+  public void incrementBrokenStoreFileCleanerRuns();
+
+  /**
+   * Update the chore runtime
+   * @param milis Chore runtime
+   */
+  public void updateBrokenStoreFileCleanerTimer(long milis);
+
+}

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsBrokenStoreFileCleanerImpl.java

@@ -0,0 +1,66 @@
+/*
+ * 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.hadoop.hbase.regionserver;
+
+import org.apache.hadoop.hbase.metrics.BaseSourceImpl;
+import org.apache.hadoop.metrics2.lib.MutableFastCounter;
+import org.apache.hadoop.metrics2.lib.MutableTimeHistogram;
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * Implementation of {@link MetricsBrokenStoreFileCleaner} to track metrics for a specific
+ * RegionServer.
+ */
+@InterfaceAudience.Private public class MetricsBrokenStoreFileCleanerImpl extends BaseSourceImpl
+  implements MetricsBrokenStoreFileCleaner {
+
+  private MutableFastCounter brokenStoreFileCleanerDeletes;
+  private MutableFastCounter brokenStoreFileCleanerFailedDeletes;
+  private MutableFastCounter brokenStoreFileCleanerRuns;
+  private MutableTimeHistogram brokenStoreFileCleanerTimer;
+
+  public MetricsBrokenStoreFileCleanerImpl(String metricsName, String metricsDescription,
+    String metricsContext, String metricsJmxContext) {
+    super(metricsName, metricsDescription, metricsContext, metricsJmxContext);
+
+    brokenStoreFileCleanerDeletes = getMetricsRegistry().newCounter(DELETES, DELETES_DESC, 0L);
+    brokenStoreFileCleanerFailedDeletes =
+      getMetricsRegistry().newCounter(FAILED_DELETES, FAILED_DELETES_DESC, 0L);
+    brokenStoreFileCleanerRuns = getMetricsRegistry().newCounter(RUNS, RUNS_DESC, 0L);
+    brokenStoreFileCleanerTimer = getMetricsRegistry().newTimeHistogram(RUNTIME, RUNTIME_DESC);
+  }
+
+  public MetricsBrokenStoreFileCleanerImpl() {
+    this(METRICS_NAME, METRICS_DESCRIPTION, METRICS_CONTEXT, METRICS_JMX_CONTEXT);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerDeletes(long deletes) {
+    brokenStoreFileCleanerDeletes.incr(deletes);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerFailedDeletes(long failedDeletes) {
+    brokenStoreFileCleanerFailedDeletes.incr(failedDeletes);
+  }
+
+  @Override public void incrementBrokenStoreFileCleanerRuns() {
+    brokenStoreFileCleanerRuns.incr();
+  }
+
+  @Override public void updateBrokenStoreFileCleanerTimer(long millis) {
+    brokenStoreFileCleanerTimer.add(millis);
+  }
+}

hbase-hadoop-compat/src/main/resources/META-INF/services/org.apache.hadoop.hbase.master.MetricsMasterBrokenStoreFileCleaner

@@ -0,0 +1,18 @@
+# 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.
+#
+org.apache.hadoop.hbase.master.MetricsMasterBrokenStoreFileCleanerImpl

hbase-hadoop-compat/src/main/resources/META-INF/services/org.apache.hadoop.hbase.regionserver.MetricsBrokenStoreFileCleaner

@@ -0,0 +1,18 @@
+# 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.
+#
+org.apache.hadoop.hbase.regionserver.MetricsBrokenStoreFileCleanerImpl

hbase-protocol-shaded/src/main/protobuf/server/master/RegionServerStatus.proto

@@ -184,6 +184,18 @@ message GetLiveRegionServersResponse {
   required uint32 total = 2;
 }
 
+
+message BrokenStoreFileCleanerUsageRequest {
+  required string server_name = 1;
+  required uint64 runtime = 2;
+  optional uint64 deleted_files = 3;
+  optional uint64 failed_deletes = 4;
+  required uint64 runs = 5;
+}
+
+message BrokenStoreFileCleanerUsageResponse {
+}
+
 service RegionServerStatusService {
   /** Called when a region server first starts. */
   rpc RegionServerStartup(RegionServerStartupRequest)
@@ -230,4 +242,8 @@ service RegionServerStatusService {
   /** Get some live region servers to be used as seed for bootstrap nodes */
   rpc GetLiveRegionServers(GetLiveRegionServersRequest)
     returns(GetLiveRegionServersResponse);
+
+  /** Report BrokenStoreFileCleaner chore metrics to master */
+  rpc ReportBrokenStoreFileCleanerUsage(BrokenStoreFileCleanerUsageRequest)
+    returns(BrokenStoreFileCleanerUsageResponse);
 }