api,server,schema,plugin,client: logs web server

This feature enables administrators to view management server logs directly in the UI through a dedicated API call. It leverages a Netty-based websocket server to stream logs in real time, offering an efficient way to monitor and debug server operations. Note that the plugin is disabled by default and must be enabled manually.

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -101,8 +101,8 @@ public class ApiConstants {
     public static final String CONVERT_INSTANCE_HOST_ID = "convertinstancehostid";
     public static final String CONVERT_INSTANCE_STORAGE_POOL_ID = "convertinstancepoolid";
     public static final String ENABLED_REVOCATION_CHECK = "enabledrevocationcheck";
-    public static final String CLIENT_ADDRESS = "clientaddress";
     public static final String COMBINED_CAPACITY_ORDERING = "COMBINED";
+    public static final String CONTEXT_ID = "contextid";
     public static final String CONTROLLER = "controller";
     public static final String CONTROLLER_UNIT = "controllerunit";
     public static final String CONSOLE_ENDPOINT_CREATOR_ADDRESS = "consoleendpointcreatoraddress";
@@ -127,6 +127,7 @@ public class ApiConstants {
     public static final String DEST_CIDR_LIST = "destcidrlist";
     public static final String CLEANUP = "cleanup";
     public static final String MAKEREDUNDANT = "makeredundant";
+    public static final String CLIENT_ADDRESS = "clientaddress";
     public static final String CLUSTER_ID = "clusterid";
     public static final String CLUSTER_IDS = "clusterids";
     public static final String CLUSTER_NAME = "clustername";
@@ -140,12 +141,14 @@ public class ApiConstants {
     public static final String CNI_CONFIG_NAME = "cniconfigname";
     public static final String CSI_ENABLED = "csienabled";
     public static final String COMPONENT = "component";
+    public static final String CONNECTED = "connected";
     public static final String CPU = "CPU";
     public static final String CPU_CORE_PER_SOCKET = "cpucorepersocket";
     public static final String CPU_NUMBER = "cpunumber";
     public static final String CPU_SPEED = "cpuspeed";
     public static final String CPU_LOAD_AVERAGE = "cpuloadaverage";
     public static final String CREATED = "created";
+    public static final String CREATOR_ADDRESS = "creatoraddress";
     public static final String CROSS_ZONE_INSTANCE_CREATION = "crosszoneinstancecreation";
     public static final String CTX_ACCOUNT_ID = "ctxaccountid";
     public static final String CTX_DETAILS = "ctxDetails";
@@ -164,6 +167,7 @@ public class ApiConstants {
     public static final String ENCRYPT_ROOT = "encryptroot";
     public static final String ENCRYPTION_SUPPORTED = "encryptionsupported";
     public static final String ETCD_IPS = "etcdips";
+    public static final String FILTERS = "filters";
     public static final String MIN_IOPS = "miniops";
     public static final String MAX_IOPS = "maxiops";
     public static final String HYPERVISOR_SNAPSHOT_RESERVE = "hypervisorsnapshotreserve";
@@ -1332,6 +1336,8 @@ public class ApiConstants {
     public static final String WEBHOOK_ID = "webhookid";
     public static final String WEBHOOK_NAME = "webhookname";
 
+    public static final String WEBSOCKET = "websocket";
+
     public static final String NFS_MOUNT_OPTIONS = "nfsmountopts";
     public static final String MOUNT_OPTIONS = "mountopts";
 
@@ -1348,6 +1354,8 @@ public class ApiConstants {
     public static final String OBJECT_STORAGE_LIMIT = "objectstoragelimit";
     public static final String OBJECT_STORAGE_TOTAL = "objectstoragetotal";
 
+    public static final String LOGS_WEB_SERVER_ENABLED = "logswebserverenabled";
+
     public static final String PARAMETER_DESCRIPTION_ACTIVATION_RULE = "Quota tariff's activation rule. It can receive a JS script that results in either " +
             "a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the " +
             "numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff " +

api/src/main/java/org/apache/cloudstack/api/BaseResponse.java

@@ -32,6 +32,10 @@ public abstract class BaseResponse implements ResponseObject {
     @Param(description = "The current status of the latest async job acting on this object")
     private Integer jobStatus;
 
+    @SerializedName(ApiConstants.CONTEXT_ID)
+    @Param(description = "the ID of the executing context")
+    private String contextId;
+
     public BaseResponse() {
     }
 
@@ -83,4 +87,14 @@ public Integer getJobStatus() {
     public void setJobStatus(Integer jobStatus) {
         this.jobStatus = jobStatus;
     }
+
+    @Override
+    public String getContextId() {
+        return contextId;
+    }
+
+    @Override
+    public void setContextId(String contextId) {
+        this.contextId = contextId;
+    }
 }

api/src/main/java/org/apache/cloudstack/api/ResponseObject.java

@@ -76,6 +76,9 @@ public interface ResponseObject {
      */
     void setJobStatus(Integer jobStatus);
 
+    String getContextId();
+    void setContextId(String contextId);
+
     public enum ResponseView {
         Full,
         Restricted

api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java

@@ -93,6 +93,7 @@ public void execute() {
             Map<String, Object> vpnCustomerGatewayParameters = (Map<String, Object>) capabilities.get(ApiConstants.VPN_CUSTOMER_GATEWAY_PARAMETERS);
             response.setVpnCustomerGatewayParameters(vpnCustomerGatewayParameters);
         }
+        response.setLogsWebServerEnabled((Boolean)capabilities.get(ApiConstants.LOGS_WEB_SERVER_ENABLED));
         response.setObjectName("capability");
         response.setResponseName(getCommandName());
         this.setResponseObject(response);

api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java

@@ -163,6 +163,10 @@ public class CapabilitiesResponse extends BaseResponse {
     @Param(description = "Excluded and obsolete VPN customer gateway cryptographic parameters")
     private Map<String, Object> vpnCustomerGatewayParameters;
 
+    @SerializedName(ApiConstants.LOGS_WEB_SERVER_ENABLED)
+    @Param(description = "true if Logs Web Server plugin is enabled, false otherwise", since = "4.21.0")
+    private boolean logsWebServerEnabled;
+
     public void setSecurityGroupsEnabled(boolean securityGroupsEnabled) {
         this.securityGroupsEnabled = securityGroupsEnabled;
     }
@@ -293,6 +297,11 @@ public void setDynamicScalingEnabled(Boolean dynamicScalingEnabled) {
 
     public void setAdditionalConfigEnabled(Boolean additionalConfigEnabled) {
         this.additionalConfigEnabled = additionalConfigEnabled;
+
+    }
+
+    public void setLogsWebServerEnabled(boolean logsWebServerEnabled) {
+        this.logsWebServerEnabled = logsWebServerEnabled;
     }
 
     public void setVpnCustomerGatewayParameters(Map<String, Object> vpnCustomerGatewayParameters) {

client/pom.xml

@@ -246,6 +246,11 @@
             <artifactId>cloud-plugin-user-two-factor-authenticator-staticpin</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-plugin-logs-web-server</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.cloudstack</groupId>
             <artifactId>cloud-plugin-metrics</artifactId>

engine/schema/src/main/java/org/apache/cloudstack/util/StringListJsonConverter.java

@@ -0,0 +1,50 @@
+// 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.cloudstack.util;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import javax.persistence.AttributeConverter;
+import javax.persistence.Converter;
+import java.io.IOException;
+import java.util.List;
+
+@Converter
+public class StringListJsonConverter implements AttributeConverter<List<String>, String> {
+
+    private static final ObjectMapper mapper = new ObjectMapper();
+
+    @Override
+    public String convertToDatabaseColumn(List<String> attribute) {
+        try {
+            return attribute == null ? null : mapper.writeValueAsString(attribute);
+        } catch (JsonProcessingException e) {
+            throw new IllegalArgumentException("Error converting list to JSON", e);
+        }
+    }
+
+    @Override
+    public List<String> convertToEntityAttribute(String dbData) {
+        try {
+            return dbData == null ? null : mapper.readValue(dbData, List.class);
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Error converting JSON to list", e);
+        }
+    }
+}
+

engine/schema/src/main/resources/META-INF/db/schema-42010to42100-cleanup.sql

@@ -18,3 +18,5 @@
 --;
 -- Schema upgrade cleanup from 4.20.1.0 to 4.21.0.0
 --;
+
+DROP TABLE IF EXISTS `cloud`.`logs_web_session`;

engine/schema/src/main/resources/META-INF/db/schema-42010to42100.sql

@@ -208,6 +208,7 @@ SET `sort_key` = CASE
 END;
 -- End: Changes for Guest OS category cleanup
 
+<<<<<<< HEAD
 -- Update description for configuration: host.capacityType.to.order.clusters
 UPDATE `cloud`.`configuration` SET
     `description` = 'The host capacity type (CPU, RAM or COMBINED) is used by deployment planner to order clusters during VM resource allocation'
@@ -757,3 +758,19 @@ SET `cs`.`domain_id` = (
 
 -- Re-apply VPC: update default network offering for vpc tier to conserve_mode=1 (#8309)
 UPDATE `cloud`.`network_offerings` SET conserve_mode = 1 WHERE name = 'DefaultIsolatedNetworkOfferingForVpcNetworks';
+
+-- Create table for logs web session
+CREATE TABLE IF NOT EXISTS `cloud`.`logs_web_session` (
+    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    `uuid` varchar(40) NOT NULL COMMENT 'UUID generated for the session',
+    `filter` varchar(64) DEFAULT NULL COMMENT 'Filter keyword for the session',
+    `created` datetime NOT NULL COMMENT 'When the session was created',
+    `domain_id` bigint(20) unsigned NOT NULL COMMENT 'Domain of the account who generated the session',
+    `account_id` bigint(20) unsigned NOT NULL COMMENT 'Account who generated the session',
+    `creator_address` VARCHAR(45) DEFAULT NULL COMMENT 'Address of the creator of the session',
+    `connections` int unsigned NOT NULL DEFAULT 0 COMMENT 'Number of connections for the session',
+    `connected_time` datetime DEFAULT NULL COMMENT 'When the session was connected',
+    `client_address` VARCHAR(45) DEFAULT NULL COMMENT 'Address of the client that connected to the session',
+    `removed` datetime COMMENT 'When the session was removed/used',
+    CONSTRAINT `uc_logs_web_session__uuid` UNIQUE (`uuid`)
+);

plugins/logs-web-server/pom.xml

@@ -0,0 +1,41 @@
+<!--
+  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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>cloud-plugin-logs-web-server</artifactId>
+    <name>Apache CloudStack Plugin - Logs Web Server</name>
+    <parent>
+        <groupId>org.apache.cloudstack</groupId>
+        <artifactId>cloudstack-plugins</artifactId>
+        <version>4.21.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-all</artifactId>
+        </dependency>
+    </dependencies>
+</project>