[FLINK-28313][rest] Add history server flag to DashboardConfiguration

This closes apache#20142.
changzhiwin · Jul 6, 2022 · a4540fe · a4540fe
1 parent 03a1a42
commit a4540fe
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 8 deletions.
diff --git a/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html b/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
@@ -104,6 +104,9 @@
         "web-cancel" : {
           "type" : "boolean"
         },
+        "web-history" : {
+          "type" : "boolean"
+        },
         "web-submit" : {
           "type" : "boolean"
         }

diff --git a/docs/static/generated/rest_v1_dispatcher.yml b/docs/static/generated/rest_v1_dispatcher.yml
@@ -2705,6 +2705,8 @@ components:
           type: boolean
         web-cancel:
           type: boolean
+        web-history:
+          type: boolean
     JobVertexTaskManagersInfo:
       type: object
       properties:

diff --git a/...-runtime-web/src/main/java/org/apache/flink/runtime/webmonitor/history/HistoryServer.java b/...-runtime-web/src/main/java/org/apache/flink/runtime/webmonitor/history/HistoryServer.java
@@ -349,7 +349,11 @@ private void createDashboardConfigFile() throws IOException {
             fw.write(
                     createConfigJson(
                             DashboardConfiguration.from(
-                                    webRefreshIntervalMillis, ZonedDateTime.now(), false, false)));
+                                    webRefreshIntervalMillis,
+                                    ZonedDateTime.now(),
+                                    false,
+                                    false,
+                                    true)));
             fw.flush();
         } catch (IOException ioe) {
             LOG.error("Failed to write config file.");

diff --git a/flink-runtime-web/src/test/resources/rest_api_v1.snapshot b/flink-runtime-web/src/test/resources/rest_api_v1.snapshot
@@ -58,6 +58,9 @@
             },
             "web-cancel" : {
               "type" : "boolean"
+            },
+            "web-history" : {
+              "type" : "boolean"
             }
           }
         }

diff --git a/...e/src/main/java/org/apache/flink/runtime/rest/handler/cluster/DashboardConfigHandler.java b/...e/src/main/java/org/apache/flink/runtime/rest/handler/cluster/DashboardConfigHandler.java
@@ -54,7 +54,11 @@ public DashboardConfigHandler(
 
         dashboardConfiguration =
                 DashboardConfiguration.from(
-                        refreshInterval, ZonedDateTime.now(), webSubmitEnabled, webCancelEnabled);
+                        refreshInterval,
+                        ZonedDateTime.now(),
+                        webSubmitEnabled,
+                        webCancelEnabled,
+                        false);
     }
 
     @Override

diff --git a/...-runtime/src/main/java/org/apache/flink/runtime/rest/messages/DashboardConfiguration.java b/...-runtime/src/main/java/org/apache/flink/runtime/rest/messages/DashboardConfiguration.java
@@ -48,6 +48,8 @@ public class DashboardConfiguration implements ResponseBody {
 
     public static final String FIELD_NAME_FEATURE_WEB_CANCEL = "web-cancel";
 
+    public static final String FIELD_NAME_FEATURE_WEB_HISTORY = "web-history";
+
     @JsonProperty(FIELD_NAME_REFRESH_INTERVAL)
     private final long refreshInterval;
 
@@ -121,12 +123,17 @@ public static final class Features {
         @JsonProperty(FIELD_NAME_FEATURE_WEB_CANCEL)
         private final boolean webCancelEnabled;
 
+        @JsonProperty(FIELD_NAME_FEATURE_WEB_HISTORY)
+        private final boolean isHistoryServer;
+
         @JsonCreator
         public Features(
                 @JsonProperty(FIELD_NAME_FEATURE_WEB_SUBMIT) boolean webSubmitEnabled,
-                @JsonProperty(FIELD_NAME_FEATURE_WEB_CANCEL) boolean webCancelEnabled) {
+                @JsonProperty(FIELD_NAME_FEATURE_WEB_CANCEL) boolean webCancelEnabled,
+                @JsonProperty(FIELD_NAME_FEATURE_WEB_HISTORY) boolean isHistoryServer) {
             this.webSubmitEnabled = webSubmitEnabled;
             this.webCancelEnabled = webCancelEnabled;
+            this.isHistoryServer = isHistoryServer;
         }
 
         @JsonIgnore
@@ -139,6 +146,11 @@ public boolean isWebCancelEnabled() {
             return webCancelEnabled;
         }
 
+        @JsonIgnore
+        public boolean isHistoryServer() {
+            return isHistoryServer;
+        }
+
         @Override
         public boolean equals(Object o) {
             if (this == o) {
@@ -149,12 +161,13 @@ public boolean equals(Object o) {
             }
             Features features = (Features) o;
             return webSubmitEnabled == features.webSubmitEnabled
-                    && webCancelEnabled == features.webCancelEnabled;
+                    && webCancelEnabled == features.webCancelEnabled
+                    && isHistoryServer == features.isHistoryServer;
         }
 
         @Override
         public int hashCode() {
-            return Objects.hash(webSubmitEnabled, webCancelEnabled);
+            return Objects.hash(webSubmitEnabled, webCancelEnabled, isHistoryServer);
         }
     }
 
@@ -190,7 +203,8 @@ public static DashboardConfiguration from(
             long refreshInterval,
             ZonedDateTime zonedDateTime,
             boolean webSubmitEnabled,
-            boolean webCancelEnabled) {
+            boolean webCancelEnabled,
+            boolean isHistoryServer) {
 
         final String flinkVersion = EnvironmentInformation.getVersion();
 
@@ -212,6 +226,6 @@ public static DashboardConfiguration from(
                 zonedDateTime.toOffsetDateTime().getOffset().getTotalSeconds() * 1000,
                 flinkVersion,
                 flinkRevision,
-                new Features(webSubmitEnabled, webCancelEnabled));
+                new Features(webSubmitEnabled, webCancelEnabled, isHistoryServer));
     }
 }
diff --git a/...time/src/test/java/org/apache/flink/runtime/rest/messages/DashboardConfigurationTest.java b/...time/src/test/java/org/apache/flink/runtime/rest/messages/DashboardConfigurationTest.java
@@ -35,6 +35,6 @@ protected DashboardConfiguration getTestResponseInstance() {
                 42,
                 "version",
                 "revision",
-                new DashboardConfiguration.Features(true, true));
+                new DashboardConfiguration.Features(true, true, false));
     }
 }