feature: websocket server framework, logs web session implementation by shwstppr · Pull Request #12053 · apache/cloudstack

shwstppr · 2025-11-12T10:23:37Z

Description

This PR introduces a WebSocket framework, enabling flexible configuration and management of WebSocket server and contexts.
The framework allows WebSocket services to run either as:

Standalone server: A new Netty-based implementation, suitable for dedicated WebSocket routing and scalability.
Embedded mode (same port as API server): Integration within the existing Jetty server, extending current servlet-based behaviour.

The first implementation built on this framework is the Logs Web Session, which allows ROOT administrators to securely stream and view logs in real-time via the UI, tied to specific API calls or actions.

Key Features

Adds a generic framework to initialize and configure WebSocket server and contexts.
Supports both Jetty (embedded) and Netty (standalone) modes.
Introduces a Logs WebSocket session handler to stream management server logs for API calls.
Enhances the UI to display live logs for ROOT admins through authenticated WebSocket connections.
Provides configuration flexibility for enabling/disabling WebSocket modes.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

codecov · 2025-11-12T10:32:24Z

Codecov Report

❌ Patch coverage is 1.31752% with 1498 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.96%. Comparing base (c361409) to head (dbe9dc4).

Files with missing lines	Patch %	Lines
...e/cloudstack/logsws/LogsWebSessionManagerImpl.java	3.60%	213 Missing and 1 partial ⚠️
...ack/logsws/server/LogsWebSocketRoutingHandler.java	0.00%	132 Missing ⚠️
...loudstack/logsws/LogsWebSessionApiServiceImpl.java	0.00%	122 Missing ⚠️
.../apache/cloudstack/logsws/server/LogsStreamer.java	0.00%	105 Missing ⚠️
...ework/websocket/server/common/WebSocketRouter.java	0.00%	97 Missing ⚠️
...ket/server/manager/WebSocketServerManagerImpl.java	0.00%	88 Missing ⚠️
...ebsocket/server/WebSocketServerRoutingHandler.java	0.00%	78 Missing ⚠️
.../apache/cloudstack/logsws/vo/LogsWebSessionVO.java	0.00%	77 Missing ⚠️
...ck/framework/websocket/server/WebSocketServer.java	0.00%	73 Missing ⚠️
...e/cloudstack/logsws/dao/LogsWebSessionDaoImpl.java	0.00%	52 Missing ⚠️
... and 28 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12053      +/-   ##
============================================
- Coverage     18.00%   17.96%   -0.05%     
- Complexity    16466    16472       +6     
============================================
  Files          5977     6005      +28     
  Lines        537777   539459    +1682     
  Branches      66037    66201     +164     
============================================
+ Hits          96844    96894      +50     
- Misses       430011   431639    +1628     
- Partials      10922    10926       +4

Flag	Coverage Δ
uitests	`3.55% <ø> (+0.02%)`	⬆️
unittests	`19.12% <1.31%> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull Request Overview

This PR introduces a comprehensive WebSocket server framework enabling both standalone (Netty-based) and embedded (Jetty-based) WebSocket server modes. The first implementation provides a Logs Web Session feature allowing ROOT administrators to securely stream and view management server logs in real-time via the UI.

Key changes:

New WebSocket framework with flexible server configuration (standalone/embedded modes)
Logs Web Session API and UI for real-time log streaming with filtering
Database schema additions for session and management server configuration storage

Reviewed Changes

Copilot reviewed 88 out of 88 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
framework/websocket-server/*	Core WebSocket server framework with Netty implementation and router
plugins/logs-web-server/*	Logs web session plugin with API, streaming, and session management
ui/src/components/view/LogsConsole.vue	New UI component for displaying real-time logs with filtering
ui/src/utils/plugins.js	Enhanced job polling with log viewing capabilities
engine/schema/.../schema-42200to42300.sql	Database schema for logs sessions and management server details
client/src/main/java/.../ServerDaemon.java	Jetty server integration for embedded WebSocket support
server/src/main/java/.../ManagementServerImpl.java	Management server capabilities and configuration updates

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...ogs-web-server/src/main/java/org/apache/cloudstack/logsws/LogsWebSessionTokenCryptoUtil.java

Copilot · 2025-11-13T14:22:34Z

ui/src/utils/plugins.js

 export const pollJobPlugin = {
  install (app) {
+    function canViewLogs (logIds) {
+      console.log('canViewLogs', store.getters.features.logswebserverenabled, 'createLogsWebSession' in store.getters.apis, logIds, logIds && logIds.length > 0)


Console.log statement should be removed from production code. This debug logging can expose sensitive information and impact performance.

Copilot · 2025-11-13T14:22:34Z

ui/src/utils/plugins.js

+        if (result.logids) {
+          allLogIds.push(...result.logids)
+        }
+        console.log('pollJobPlugin', result.logids, allLogIds)


Console.log statement should be removed from production code. Debug logging should use proper logging mechanisms instead of console.log.

ui/src/components/view/SettingsTab.vue

engine/schema/src/main/resources/META-INF/db/schema-42200to42300.sql

...t-server/src/main/java/org/apache/cloudstack/framework/websocket/server/WebSocketServer.java

ui/src/components/view/LogsConsole.vue

github-actions · 2025-11-27T15:42:10Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

shwstppr · 2025-11-27T17:27:57Z

@blueorangutan package

blueorangutan · 2025-11-27T17:30:03Z

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-11-27T18:44:17Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15848

github-actions · 2025-12-22T13:48:34Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2025-12-26T07:04:47Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

shwstppr · 2025-12-30T06:36:55Z

@blueorangutan package

blueorangutan · 2025-12-30T06:38:08Z

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

github-actions · 2026-01-19T13:07:25Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2026-01-27T15:28:50Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2026-01-29T10:29:46Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2026-02-16T14:22:03Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

DaanHoogland · 2026-04-09T13:05:36Z

@blueorangutan package

blueorangutan · 2026-04-09T13:06:04Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-09T13:15:20Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 17423

server/src/main/java/com/cloud/api/ApiServer.java

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>

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

blueorangutan · 2026-04-09T14:18:59Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17425

DaanHoogland · 2026-04-09T14:32:43Z

@blueorangutan test keepEnv

blueorangutan · 2026-04-09T14:34:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2026-04-09T14:36:16Z

[SF] Trillian Build Failed (tid-15840)

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

shwstppr · 2026-04-09T16:45:48Z

@blueorangutan package

blueorangutan · 2026-04-09T16:48:04Z

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-09T17:32:47Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17427

boring-cyborg bot added component:agent component:api component:build component:management-server component:orchestration labels Nov 12, 2025

shwstppr requested a review from Copilot November 13, 2025 14:11

Copilot started reviewing on behalf of shwstppr November 13, 2025 14:11 View session

Copilot finished reviewing on behalf of shwstppr November 13, 2025 14:13

Copilot AI reviewed Nov 13, 2025

View reviewed changes

apache deleted a comment from blueorangutan Nov 24, 2025

github-actions bot added the status:has-conflicts label Nov 27, 2025

github-actions bot removed the status:has-conflicts label Nov 27, 2025

apache deleted a comment from blueorangutan Nov 27, 2025

github-actions bot added status:has-conflicts and removed status:has-conflicts labels Dec 22, 2025

github-actions bot removed the status:has-conflicts label Dec 29, 2025

github-actions bot added status:has-conflicts and removed status:has-conflicts labels Jan 13, 2026

github-actions bot removed the status:has-conflicts label Jan 20, 2026

github-actions bot added the status:has-conflicts label Jan 27, 2026

github-actions bot added status:has-conflicts and removed status:has-conflicts labels Jan 28, 2026

github-actions bot removed the status:has-conflicts label Jan 29, 2026

github-actions bot added the status:has-conflicts label Feb 16, 2026

DaanHoogland added this to the 4.23.0 milestone Apr 9, 2026

DaanHoogland reviewed Apr 9, 2026

View reviewed changes

server/src/main/java/com/cloud/api/ApiServer.java Show resolved Hide resolved

shwstppr added 3 commits April 9, 2026 19:20

config: fix ManagementServer scope

686534a

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

changes for allowing both jetty shared server or standalone netty server

2ae789d

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

fixes

dbe9dc4

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

shwstppr force-pushed the feature-ui-logs branch from 84268d3 to dbe9dc4 Compare April 9, 2026 14:58

github-actions bot removed the status:has-conflicts label Apr 9, 2026

Conversation

shwstppr commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 27, 2025

Uh oh!

shwstppr commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

github-actions bot commented Dec 22, 2025

Uh oh!

github-actions bot commented Dec 26, 2025

Uh oh!

shwstppr commented Dec 30, 2025

Uh oh!

blueorangutan commented Dec 30, 2025

Uh oh!

github-actions bot commented Jan 19, 2026

Uh oh!

github-actions bot commented Jan 27, 2026

Uh oh!

github-actions bot commented Jan 29, 2026

Uh oh!

github-actions bot commented Feb 16, 2026

Uh oh!

DaanHoogland commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

DaanHoogland commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

shwstppr commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

Reviewers

Assignees

shwstppr commented Nov 12, 2025 •

edited

Loading

codecov bot commented Nov 12, 2025 •

edited

Loading