Synced with main

Author: germanosin

api/src/main/java/io/kafbat/ui/mapper/DynamicConfigMapper.java

@@ -9,6 +9,7 @@
 import io.kafbat.ui.model.ApplicationConfigPropertiesDTO;
 import io.kafbat.ui.model.ApplicationConfigPropertiesKafkaClustersInnerDTO;
 import io.kafbat.ui.model.ApplicationConfigPropertiesRbacRolesInnerPermissionsInnerDTO;
+import io.kafbat.ui.model.RbacPermissionDTO;
 import io.kafbat.ui.model.rbac.Permission;
 import io.kafbat.ui.util.DynamicConfigOperations;
 import java.util.Optional;
@@ -26,6 +27,9 @@ public interface DynamicConfigMapper {
   @Mapping(target = "kafka.clusters[].metrics.store", ignore = true)
   ApplicationConfigPropertiesDTO toDto(DynamicConfigOperations.PropertiesStructure propertiesStructure);
 
+  @Mapping(target = "parsedActions", ignore = true)
+  Permission toPermission(RbacPermissionDTO dto);
+
   default String map(Resource resource) {
     return resource.getFilename();
   }

contract-typespec/api/clusters.tsp

@@ -55,7 +55,8 @@ alias ClusterFeature =
   | "TOPIC_DELETION"
   | "KAFKA_ACL_VIEW"
   | "KAFKA_ACL_EDIT"
-  | "CLIENT_QUOTA_MANAGEMENT";
+  | "CLIENT_QUOTA_MANAGEMENT"
+  | "GRAPHS_ENABLED";
 
 enum ServerStatus {
   ONLINE,

contract-typespec/api/config.tsp

@@ -115,12 +115,11 @@ model ApplicationConfig {
             value?: string;
             regex?: boolean = false;
         }[];
-        permissions?: {
-          resource?: ResourceType;
-          value?: string;
-          actions?: Action[];
-        }[];
+        permissions?: RbacPermission[];
       }[];
+      defaultRole?: {
+        permissions?: RbacPermission[];
+      }
     };
     webclient?: {
       maxInMemoryBufferSize?: string;
@@ -135,6 +134,14 @@ model ApplicationConfig {
       };
       adminClientTimeout?: int32;
       internalTopicPrefix?: string;
+      defaultMetricsStorage?: ClusterMetricsStoreConfig;
+      cache?: {
+        enabled?: boolean;
+        @format("duration")
+        connectCacheExpiry?: string;
+        @format("duration")
+        connectClusterCacheExpiry?: string;
+      };
       clusters?: {
         name?: string;
         bootstrapServers?: string;
@@ -177,6 +184,8 @@ model ApplicationConfig {
           password?: string;
           keystoreLocation?: string;
           keystorePassword?: string;
+          prometheusExpose?: boolean;
+          store?: ClusterMetricsStoreConfig;
         };
         properties?: Record<unknown>;
         consumerProperties?: Record<unknown>;
@@ -231,6 +240,7 @@ model ClusterConfigValidation {
   schemaRegistry?: ApplicationPropertyValidation;
   kafkaConnects?: Record<ApplicationPropertyValidation>;
   ksqldb?: ApplicationPropertyValidation;
+  prometheusStorage?: ApplicationPropertyValidation;
 }
 
 alias ApplicationFeature =
@@ -291,3 +301,22 @@ enum ResourceType {
   AUDIT,
   CLIENT_QUOTAS,
 }
+
+model ClusterMetricsStoreConfig {
+    prometheus?: PrometheusStorage;
+}
+
+model PrometheusStorage {
+    url?: string;
+    remoteWrite?: boolean;
+    pushGatewayUrl?: string;
+    pushGatewayUsername?: string;
+    pushGatewayPassword?: string;
+    pushGatewayJobName?: string;
+}
+
+model RbacPermission {
+    resource?: ResourceType;
+    value?: string;
+    actions?: Action[];
+}

contract-typespec/api/graphs.tsp

@@ -0,0 +1,91 @@
+import "@typespec/openapi";
+import "./responses.tsp";
+
+namespace Api;
+
+using TypeSpec.Http;
+using OpenAPI;
+
+@route("/api/clusters/{clusterName}/graphs")
+@tag("Graphs")
+interface GraphsApi {
+    @get
+    @operationId("getGraphsList")
+    @summary("getGraphsList")
+    getGraphsList(
+        @path clusterName: string
+    ): GraphDescriptions;
+
+    @post
+    @operationId("getGraphData")
+    @summary("getGraphData")
+    getGraphData(
+        @path clusterName: string,
+        @body request: GraphDataRequest
+    ) : PrometheusApiQueryResponse
+}
+
+model GraphDescriptions {
+    graphs?: Array<GraphDescription>;
+}
+
+model GraphDescription {
+    @doc("Id that should be used to query data on API level")
+    id: string;
+    type?: "range" | "instant";
+    @doc("""
+        ISO_8601 duration string (for "range" graphs only)
+        """)
+    defaultPeriod?: string;
+    parameters?: Array<GraphParameter>;
+}
+
+model GraphParameter {
+    name: string;
+}
+
+model GraphDataRequest {
+    id?: string;
+    parameters?: Record<string>;
+    from?: offsetDateTime;
+    to?: offsetDateTime;
+}
+
+model PrometheusApiBaseResponse {
+    status: "success" | "error";
+    error?: string;
+    errorType?: string;
+    warnings?: Array<string>;
+}
+
+model PrometheusApiQueryResponse extends PrometheusApiBaseResponse {
+    data?: PrometheusApiQueryResponseData;
+}
+
+model PrometheusApiQueryResponseData {
+    resultType: "matrix" | "vector" | "scalar" | "string";
+    @doc("""
+            Depending on resultType format can vary:
+            "vector":
+              [
+                {
+                  "metric": { "<label_name>": "<label_value>", ... },
+                  "value": [ <unix_time>, "<sample_value>" ],
+                  "histogram": [ <unix_time>, <histogram> ]
+               }, ...
+              ]
+            "matrix":
+              [
+                {
+                  "metric": { "<label_name>": "<label_value>", ... },
+                  "values": [ [ <unix_time>, "<sample_value>" ], ... ],
+                  "histograms": [ [ <unix_time>, <histogram> ], ... ]
+                }, ...
+              ]
+            "scalar":
+              [ <unix_time>, "<scalar_value>" ]
+            "string":
+              [ <unix_time>, "<string_value>" ]
+    """)
+    result?: Array<unknown>;
+}

contract-typespec/api/main.tsp

@@ -11,6 +11,8 @@ import "./acls.tsp";
 import "./quotas.tsp";
 import "./auth.tsp";
 import "./config.tsp";
+import "./graphs.tsp";
+import "./prometheus.tsp";
 
 import "@typespec/http";
 import "@typespec/rest";

contract-typespec/api/prometheus.tsp

@@ -0,0 +1,23 @@
+import "@typespec/openapi";
+import "./models.tsp";
+import "./responses.tsp";
+
+namespace Api;
+
+using TypeSpec.Http;
+using OpenAPI;
+
+@route("/metrics")
+@tag("PrometheusExpose")
+interface PrometheusExposeApi {
+    @get
+    @summary("exposeAllMetrics")
+    @operationId("exposeAllMetrics")
+    exposeAllMetrics(): string;
+
+    @get
+    @route("/{clusterName}")
+    @summary("exposeClusterMetrics")
+    @operationId("exposeClusterMetrics")
+    exposeClusterMetrics(@path clusterName: string): string;
+}