You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uniffle.apache.org by ck...@apache.org on 2023/02/02 08:01:56 UTC

[incubator-uniffle] branch master updated: [SpotBugs] Fix UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD (#536)

This is an automated email from the ASF dual-hosted git repository.

ckj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-uniffle.git


The following commit(s) were added to refs/heads/master by this push:
     new a45be205 [SpotBugs] Fix UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD (#536)
a45be205 is described below

commit a45be2051cfbe962bfcf5cd6f20901ab8068360b
Author: Kaijie Chen <ck...@apache.org>
AuthorDate: Thu Feb 2 16:01:50 2023 +0800

    [SpotBugs] Fix UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD (#536)
    
    ### What changes were proposed in this pull request?
    
    Remove UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD from `spotbugs-exclude.xml` and fix violations.
    
    ### Why are the changes needed?
    
    Sub-task of #532 - Fix [UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD][1].
    
    [1]: https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html#uwf-unwritten-public-or-protected-field-uwf-unwritten-public-or-protected-field
    
    ### Does this PR introduce _any_ user-facing change?
    
    No.
    
    ### How was this patch tested?
    
    CI.
---
 .../main/java/org/apache/uniffle/common/metrics/GRPCMetrics.java  | 8 ++++++--
 .../apache/uniffle/coordinator/metric/CoordinatorGrpcMetrics.java | 4 ----
 .../java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java  | 5 -----
 spotbugs-exclude.xml                                              | 2 +-
 4 files changed, 7 insertions(+), 12 deletions(-)

diff --git a/common/src/main/java/org/apache/uniffle/common/metrics/GRPCMetrics.java b/common/src/main/java/org/apache/uniffle/common/metrics/GRPCMetrics.java
index 62972968..7909ff80 100644
--- a/common/src/main/java/org/apache/uniffle/common/metrics/GRPCMetrics.java
+++ b/common/src/main/java/org/apache/uniffle/common/metrics/GRPCMetrics.java
@@ -35,14 +35,16 @@ public abstract class GRPCMetrics {
   private static final String GRPC_SERVER_EXECUTOR_BLOCKING_QUEUE_SIZE = "grpc_server_executor_blocking_queue_size";
   public static final String GRPC_SERVER_CONNECTION_NUMBER_KEY = "grpcServerConnectionNumber";
   private static final String GRPC_SERVER_CONNECTION_NUMBER = "grpc_server_connection_number";
+  private static final String GRPC_OPEN = "grpc_open";
+  private static final String GRPC_TOTAL = "grpc_total";
 
   private boolean isRegistered = false;
   protected Map<String, Counter> counterMap = Maps.newConcurrentMap();
   protected Map<String, Gauge> gaugeMap = Maps.newConcurrentMap();
   protected Map<String, Summary> transportTimeSummaryMap = Maps.newConcurrentMap();
   protected Map<String, Summary> processTimeSummaryMap = Maps.newConcurrentMap();
-  protected Gauge gaugeGrpcOpen;
-  protected Counter counterGrpcTotal;
+  private Gauge gaugeGrpcOpen;
+  private Counter counterGrpcTotal;
   protected MetricsManager metricsManager;
 
   public abstract void registerMetrics();
@@ -57,6 +59,8 @@ public abstract class GRPCMetrics {
   }
 
   private void registerGeneralMetrics() {
+    gaugeGrpcOpen = metricsManager.addGauge(GRPC_OPEN);
+    counterGrpcTotal = metricsManager.addCounter(GRPC_TOTAL);
     gaugeMap.putIfAbsent(
         GRPC_SERVER_EXECUTOR_ACTIVE_THREADS_KEY,
         metricsManager.addGauge(GRPC_SERVER_EXECUTOR_ACTIVE_THREADS)
diff --git a/coordinator/src/main/java/org/apache/uniffle/coordinator/metric/CoordinatorGrpcMetrics.java b/coordinator/src/main/java/org/apache/uniffle/coordinator/metric/CoordinatorGrpcMetrics.java
index eb141a63..8a9999bf 100644
--- a/coordinator/src/main/java/org/apache/uniffle/coordinator/metric/CoordinatorGrpcMetrics.java
+++ b/coordinator/src/main/java/org/apache/uniffle/coordinator/metric/CoordinatorGrpcMetrics.java
@@ -24,8 +24,6 @@ public class CoordinatorGrpcMetrics extends GRPCMetrics {
   public static final String HEARTBEAT_METHOD = "heartbeat";
   public static final String GET_SHUFFLE_ASSIGNMENTS_METHOD = "getShuffleAssignments";
 
-  private static final String GRPC_OPEN = "grpc_open";
-  private static final String GRPC_TOTAL = "grpc_total";
   private static final String GRPC_GET_SHUFFLE_ASSIGNMENTS = "grpc_get_shuffle_assignments";
   private static final String GRPC_HEARTBEAT = "grpc_heartbeat";
   private static final String GRPC_GET_SHUFFLE_ASSIGNMENTS_TOTAL =
@@ -35,8 +33,6 @@ public class CoordinatorGrpcMetrics extends GRPCMetrics {
 
   @Override
   public void registerMetrics() {
-    gaugeGrpcOpen = metricsManager.addGauge(GRPC_OPEN);
-    counterGrpcTotal = metricsManager.addCounter(GRPC_TOTAL);
     gaugeMap.putIfAbsent(HEARTBEAT_METHOD,
         metricsManager.addGauge(GRPC_HEARTBEAT));
     gaugeMap.putIfAbsent(GET_SHUFFLE_ASSIGNMENTS_METHOD,
diff --git a/server/src/main/java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java b/server/src/main/java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java
index 5ecd75c3..f4e616e5 100644
--- a/server/src/main/java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java
+++ b/server/src/main/java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java
@@ -45,8 +45,6 @@ public class ShuffleServerGrpcMetrics extends GRPCMetrics {
   private static final String GRPC_GET_MEMORY_SHUFFLE_DATA = "grpc_get_memory_shuffle_data";
   private static final String GRPC_GET_SHUFFLE_INDEX = "grpc_get_local_shuffle_index";
 
-  private static final String GRPC_OPEN = "grpc_open";
-  private static final String GRPC_TOTAL = "grpc_total";
   private static final String GRPC_REGISTERED_SHUFFLE_TOTAL = "grpc_registered_shuffle_total";
   private static final String GRPC_SEND_SHUFFLE_DATA_TOTAL = "grpc_send_shuffle_data_total";
   private static final String GRPC_COMMIT_SHUFFLE_TASK_TOTAL = "grpc_commit_shuffle_task_total";
@@ -74,9 +72,6 @@ public class ShuffleServerGrpcMetrics extends GRPCMetrics {
 
   @Override
   public void registerMetrics() {
-    gaugeGrpcOpen = metricsManager.addGauge(GRPC_OPEN);
-    counterGrpcTotal = metricsManager.addCounter(GRPC_TOTAL);
-
     gaugeMap.putIfAbsent(REGISTER_SHUFFLE_METHOD,
         metricsManager.addGauge(GRPC_REGISTERED_SHUFFLE));
     gaugeMap.putIfAbsent(SEND_SHUFFLE_DATA_METHOD,
diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index 182730e4..cae8bb7e 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -20,6 +20,6 @@
     <Package name="~org\.apache\.uniffle\.proto.*"/>
   </Match>
   <Match>
-    <Bug pattern="MS_EXPOSE_REP,EI_EXPOSE_REP,EI_EXPOSE_REP2,EI_EXPOSE_STATIC_REP2,THROWS_METHOD_THROWS_RUNTIMEEXCEPTION,THROWS_METHOD_THROWS_CLAUSE_BASIC_EXCEPTION,THROWS_METHOD_THROWS_CLAUSE_THROWABLE,MS_PKGPROTECT,MS_CANNOT_BE_FINAL,UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD,SE_BAD_FIELD,SC_START_IN_CTOR,SWL_SLEEP_WITH_LOCK_HELD,IS2_INCONSISTENT_SYNC" />
+    <Bug pattern="MS_EXPOSE_REP,EI_EXPOSE_REP,EI_EXPOSE_REP2,EI_EXPOSE_STATIC_REP2,THROWS_METHOD_THROWS_RUNTIMEEXCEPTION,THROWS_METHOD_THROWS_CLAUSE_BASIC_EXCEPTION,THROWS_METHOD_THROWS_CLAUSE_THROWABLE,MS_PKGPROTECT,MS_CANNOT_BE_FINAL,SE_BAD_FIELD,SC_START_IN_CTOR,SWL_SLEEP_WITH_LOCK_HELD,IS2_INCONSISTENT_SYNC" />
   </Match>
 </FindBugsFilter>