[FLINK-25608][metrics] Annotate metrics classes with Public(Evolving)

apache · Jan 11, 2022 · 549e1b1 · 549e1b1
1 parent 29dd24f
commit 549e1b1
Show file tree

Hide file tree

Showing 16 changed files with 41 additions and 17 deletions.
diff --git a/flink-architecture-tests/violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 b/flink-architecture-tests/violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8
diff --git a/flink-metrics/flink-metrics-core/pom.xml b/flink-metrics/flink-metrics-core/pom.xml
@@ -35,8 +35,12 @@ under the License.
 	<packaging>jar</packaging>
 
 	<dependencies>
+		<dependency>
+			<groupId>org.apache.flink</groupId>
+			<artifactId>flink-annotations</artifactId>
+			<version>${project.version}</version>
+		</dependency>
 		<!-- ================== test dependencies ================== -->
-
 		<dependency>
 			<groupId>org.apache.flink</groupId>
 			<artifactId>flink-test-utils-junit</artifactId>

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/CharacterFilter.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/CharacterFilter.java
@@ -18,10 +18,13 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /**
  * Interface for a character filter function. The filter function is given a string which the filter
  * can transform. The returned string is the transformation result.
  */
+@Public
 public interface CharacterFilter {
     CharacterFilter NO_OP_FILTER = input -> input;
 

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Counter.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Counter.java
@@ -18,7 +18,10 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /** A Counter is a {@link Metric} that measures a count. */
+@Public
 public interface Counter extends Metric {
 
     /** Increment the current count by 1. */

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Gauge.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Gauge.java
@@ -18,7 +18,10 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /** A Gauge is a {@link Metric} that calculates a specific value at a point in time. */
+@Public
 public interface Gauge<T> extends Metric {
 
     /**

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Histogram.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Histogram.java
@@ -18,12 +18,15 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /**
  * Histogram interface to be used with Flink's metrics system.
  *
  * <p>The histogram allows to record values, get the current count of recorded values and create
  * histogram statistics for the currently seen elements.
  */
+@Public
 public interface Histogram extends Metric {
 
     /**

diff --git a/...etrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/HistogramStatistics.java b/...etrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/HistogramStatistics.java
@@ -18,12 +18,15 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /**
  * Histogram statistics represent the current snapshot of elements recorded in the histogram.
  *
  * <p>The histogram statistics allow to calculate values for quantiles, the mean, the standard
  * deviation, the minimum and the maximum.
  */
+@Public
 public abstract class HistogramStatistics {
 
     /**

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Meter.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Meter.java
@@ -18,7 +18,10 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /** Metric for measuring throughput. */
+@Public
 public interface Meter extends Metric {
 
     /** Mark occurrence of an event. */

diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Metric.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/Metric.java
@@ -18,5 +18,8 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 /** Common super interface for all metrics. */
+@Public
 public interface Metric {}
diff --git a/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/MetricGroup.java b/flink-metrics/flink-metrics-core/src/main/java/org/apache/flink/metrics/MetricGroup.java
@@ -18,6 +18,8 @@
 
 package org.apache.flink.metrics;
 
+import org.apache.flink.annotation.Public;
+
 import java.util.Map;
 
 /**
@@ -28,6 +30,7 @@
  *
  * <p>A MetricGroup is uniquely identified by it's place in the hierarchy and name.
  */
+@Public
 public interface MetricGroup {
 
     // ------------------------------------------------------------------------

diff --git a/...cs-core/src/main/java/org/apache/flink/metrics/groups/OperatorCoordinatorMetricGroup.java b/...cs-core/src/main/java/org/apache/flink/metrics/groups/OperatorCoordinatorMetricGroup.java
@@ -17,11 +17,13 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.MetricGroup;
 
 /**
  * Special {@link MetricGroup} representing an Operator coordinator.
  *
  * <p>You should only update the metrics in the coordinator thread.
  */
+@PublicEvolving
 public interface OperatorCoordinatorMetricGroup extends MetricGroup {}
diff --git a/...ink-metrics-core/src/main/java/org/apache/flink/metrics/groups/OperatorIOMetricGroup.java b/...ink-metrics-core/src/main/java/org/apache/flink/metrics/groups/OperatorIOMetricGroup.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.Counter;
 import org.apache.flink.metrics.MetricGroup;
 
@@ -25,6 +26,7 @@
  *
  * <p>You should only update the metrics in the main operator thread.
  */
+@PublicEvolving
 public interface OperatorIOMetricGroup extends MetricGroup {
     /**
      * The total number of input records since the operator started. Will also populate

diff --git a/...flink-metrics-core/src/main/java/org/apache/flink/metrics/groups/OperatorMetricGroup.java b/...flink-metrics-core/src/main/java/org/apache/flink/metrics/groups/OperatorMetricGroup.java
@@ -17,13 +17,15 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.MetricGroup;
 
 /**
  * Special {@link org.apache.flink.metrics.MetricGroup} representing an Operator.
  *
  * <p>You should only update the metrics in the main operator thread.
  */
+@PublicEvolving
 public interface OperatorMetricGroup extends MetricGroup {
     OperatorIOMetricGroup getIOMetricGroup();
 }
diff --git a/...ink-metrics-core/src/main/java/org/apache/flink/metrics/groups/SinkWriterMetricGroup.java b/...ink-metrics-core/src/main/java/org/apache/flink/metrics/groups/SinkWriterMetricGroup.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.Counter;
 import org.apache.flink.metrics.Gauge;
 
@@ -25,6 +26,7 @@
  *
  * <p>You should only update the metrics in the main operator thread.
  */
+@PublicEvolving
 public interface SinkWriterMetricGroup extends OperatorMetricGroup {
     /** The total number of records failed to send. */
     Counter getNumRecordsOutErrorsCounter();

diff --git a/...k-metrics-core/src/main/java/org/apache/flink/metrics/groups/SourceReaderMetricGroup.java b/...k-metrics-core/src/main/java/org/apache/flink/metrics/groups/SourceReaderMetricGroup.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.Counter;
 import org.apache.flink.metrics.Gauge;
 
@@ -25,6 +26,7 @@
  *
  * <p>You should only update the metrics in the main operator thread.
  */
+@PublicEvolving
 public interface SourceReaderMetricGroup extends OperatorMetricGroup {
     /** The total number of record that failed to consume, process, or emit. */
     Counter getNumRecordsInErrorsCounter();

diff --git a/...etrics-core/src/main/java/org/apache/flink/metrics/groups/SplitEnumeratorMetricGroup.java b/...etrics-core/src/main/java/org/apache/flink/metrics/groups/SplitEnumeratorMetricGroup.java
@@ -17,13 +17,15 @@
 
 package org.apache.flink.metrics.groups;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.metrics.Gauge;
 
 /**
  * Pre-defined metrics for {@code SplitEnumerator}.
  *
  * <p>You should only update the metrics in the main operator thread.
  */
+@PublicEvolving
 public interface SplitEnumeratorMetricGroup extends OperatorCoordinatorMetricGroup {
     /**
      * Sets an optional gauge for the number of splits that have been enumerated but not yet