console: optimise buffer sizes for faster console performance #11221

rohityadavcloud · 2025-07-16T10:29:48Z

Description

This fixes the console proxy input and output buffer sizes to accommodate responsive user-experience for desktop users using console (novnc).

Fixes #10650

How I tested:

Applied this fix (https://dl.yadav.cloud/console-performance/cloud-console-proxy-4.20.1.0.jar) to a ACS 4.20.1 CPVM's /usr/local/cloud/systemvm/ and restarted the cloud service
Tested against Ubuntu 22.04 based KVM env with both qemu/VNC TLS enabled and disabled, against normal instances, systemvms and desktop instances (Windows 10 and Ubuntu 24.04 desktop VMs)

console-improvements.mov

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)

codecov · 2025-07-16T10:37:38Z

Codecov Report

Attention: Patch coverage is 1.08696% with 91 lines in your changes missing coverage. Please review.

Project coverage is 16.16%. Comparing base (c61a5eb) to head (e878bbe).
Report is 42 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...om/cloud/consoleproxy/ConsoleProxyNoVncClient.java	0.00%	48 Missing ⚠️
...leproxy/vnc/network/NioSocketSSLEngineManager.java	0.00%	18 Missing ⚠️
...consoleproxy/vnc/network/NioSocketInputStream.java	0.00%	10 Missing ⚠️
...main/java/com/cloud/consoleproxy/ConsoleProxy.java	20.00%	4 Missing ⚠️
...consoleproxy/vnc/network/NioSocketHandlerImpl.java	0.00%	4 Missing ⚠️
...n/java/com/cloud/consoleproxy/vnc/NoVncClient.java	0.00%	2 Missing ⚠️
.../com/cloud/consoleproxy/vnc/network/NioSocket.java	0.00%	2 Missing ⚠️
...oleproxy/vnc/network/NioSocketTLSOutputStream.java	0.00%	2 Missing ⚠️
...soleproxy/vnc/network/NioSocketTLSInputStream.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #11221      +/-   ##
============================================
+ Coverage     16.14%   16.16%   +0.01%     
- Complexity    13256    13277      +21     
============================================
  Files          5656     5656              
  Lines        497893   497818      -75     
  Branches      60374    60375       +1     
============================================
+ Hits          80394    80457      +63     
+ Misses       408539   408407     -132     
+ Partials       8960     8954       -6

Flag	Coverage Δ
uitests	`4.00% <ø> (-0.01%)`	⬇️
unittests	`17.01% <1.08%> (+0.01%)`	⬆️

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.

.../console-proxy/server/src/main/java/com/cloud/consoleproxy/vnc/network/NioSocketHandler.java

DaanHoogland · 2025-07-16T10:45:45Z

looks good, @rohityadavcloud . jus one question (i might misunderstand the architectural aspect though)

This bumps the input and output stream buffers to 64KiB and uses them consistent across TLS and non-TLS based VNC connections. This fixes apache#10650 Co-authored-by: Vishesh Jindal <[email protected]> Signed-off-by: Rohit Yadav <[email protected]>

.../console-proxy/server/src/main/java/com/cloud/consoleproxy/vnc/network/NioSocketHandler.java

rohityadavcloud · 2025-07-16T11:10:50Z

@blueorangutan package

blueorangutan · 2025-07-16T11:12:03Z

@rohityadavcloud 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.

weizhouapache · 2025-07-16T11:12:45Z

amazing findings ! @vishesh92 @rohityadavcloud

rohityadavcloud · 2025-07-16T11:24:54Z

@vishesh92 can you set the PR to 'ready for review' once you're done with your experimentations if any

adietrich-ussignal · 2025-07-16T12:22:07Z

Is there value in making this setting tunable via a system configuration setting?

blueorangutan · 2025-07-16T12:47:04Z

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

rohityadavcloud · 2025-07-16T12:53:00Z

@blueorangutan test

blueorangutan · 2025-07-16T12:54:05Z

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

rohityadavcloud · 2025-07-16T12:55:47Z

@adietrich-ussignal currently that’s not possible, these are internal byte buffers which weren’t consistently coded in the first place and without this code-based fix it won’t possible to fix existing ACS environments.

services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyNoVncClient.java

Copilot

Pull Request Overview

This PR optimizes buffer sizes for console proxy connections to improve performance and responsiveness for desktop users accessing VNC consoles through NoVNC. The changes address issue #10650 by implementing configurable buffer sizes, adaptive batching strategies, and socket optimizations.

Key changes include:

Introduction of configurable default buffer size (65536 bytes) replacing hardcoded values
Implementation of adaptive batching for TLS connections with immediate flushing for non-TLS
Socket-level optimizations including TCP_NODELAY and keep-alive settings

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
consoleproxy.properties	Adds configurable defaultBufferSize property (65536 bytes)
ConsoleProxy.java	Implements buffer size configuration parsing and static field
NioSocketTLSOutputStream.java	Replaces SSL session buffer size with configurable size, adds batching logic
NioSocketTLSInputStream.java	Updates to use configurable buffer size instead of SSL session size
NioSocketSSLEngineManager.java	Implements adaptive batching with explicit flush control
NioSocketInputStream.java	Refactors byte reading methods for better performance
NioSocketHandlerImpl.java	Updates to use configurable buffer size and new API methods
NioSocketHandler.java	Simplifies interface by replacing two methods with single buffer-based method
NioSocket.java	Enables TCP optimizations (keep-alive, TCP_NODELAY)
NoVncClient.java	Updates to use new buffer-based reading API
ConsoleProxyNoVncClient.java	Implements adaptive sleep timing and TLS-aware batching strategy

services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyNoVncClient.java

...proxy/server/src/main/java/com/cloud/consoleproxy/vnc/network/NioSocketSSLEngineManager.java

services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyNoVncClient.java

Co-authored-by: Copilot <[email protected]>

vishesh92 · 2025-07-17T14:45:40Z

@blueorangutan package

blueorangutan · 2025-07-17T14:48:03Z

@vishesh92 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-07-17T16:32:12Z

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

vishesh92 · 2025-07-17T18:20:32Z

@blueorangutan package

blueorangutan · 2025-07-17T18:22:04Z

@vishesh92 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-07-17T19:36:51Z

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

vishesh92 · 2025-07-21T10:14:48Z

@blueorangutan package

blueorangutan · 2025-07-21T10:16:03Z

@vishesh92 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-07-21T11:29:13Z

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

rohityadavcloud · 2025-07-22T12:19:56Z

@blueorangutan test

blueorangutan · 2025-07-22T12:22:04Z

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

sureshanaparti · 2025-07-22T14:00:12Z

@blueorangutan test

blueorangutan · 2025-07-22T14:02:04Z

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

blueorangutan · 2025-07-23T05:39:04Z

[SF] Trillian test result (tid-13842)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 59103 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11221-t13842-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

blueorangutan · 2025-07-23T07:31:34Z

[SF] Trillian test result (tid-13844)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 60153 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11221-t13844-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_01_deployVMInSharedNetwork	`Failure`	478.92	test_network.py

DaanHoogland

clgtm

sureshanaparti

lgtm, checked the consoles for some instances in vmware/kvm/xenserver.

…#11221) * console-proxy: fix stream buffer sizes to improve console performance This bumps the input and output stream buffers to 64KiB and uses them consistent across TLS and non-TLS based VNC connections. This fixes apache#10650 Co-authored-by: Vishesh Jindal <[email protected]> Signed-off-by: Rohit Yadav <[email protected]> * Make buffer size configurable & other improvements for CPU & memory utilisation * Setup batching of data for TLS connections to the VNC server * Apply suggestions from code review * Fix buffer size for xenserver --------- Signed-off-by: Rohit Yadav <[email protected]> Co-authored-by: Vishesh Jindal <[email protected]> Co-authored-by: vishesh92 <[email protected]>

rohityadavcloud added this to the 4.20.2 milestone Jul 16, 2025

boring-cyborg bot added the component:console-proxy label Jul 16, 2025

rohityadavcloud requested review from DaanHoogland, vishesh92 and weizhouapache July 16, 2025 10:30

DaanHoogland reviewed Jul 16, 2025

View reviewed changes

.../console-proxy/server/src/main/java/com/cloud/consoleproxy/vnc/network/NioSocketHandler.java Outdated Show resolved Hide resolved

rohityadavcloud force-pushed the console-proxy-performance branch from f1abf96 to bde67a1 Compare July 16, 2025 10:58

rohityadavcloud closed this Jul 16, 2025

rohityadavcloud reopened this Jul 16, 2025

rohityadavcloud commented Jul 16, 2025

View reviewed changes

.../console-proxy/server/src/main/java/com/cloud/consoleproxy/vnc/network/NioSocketHandler.java Outdated Show resolved Hide resolved

rohityadavcloud requested a review from nvazquez July 16, 2025 11:10

rohityadavcloud mentioned this pull request Jul 16, 2025

Windows Instance console user experience #10650

Closed

rohityadavcloud marked this pull request as draft July 16, 2025 11:24

rohityadavcloud linked an issue Jul 16, 2025 that may be closed by this pull request

Windows Instance console user experience #10650

Closed

DaanHoogland added this to Apache CloudStack 4.21.0 Jul 16, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jul 16, 2025

sureshanaparti modified the milestones: 4.20.2, 4.21.0 Jul 16, 2025

vishesh92 reviewed Jul 17, 2025

View reviewed changes

services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyNoVncClient.java Outdated Show resolved Hide resolved

vishesh92 requested a review from Copilot July 17, 2025 07:09

Copilot AI reviewed Jul 17, 2025

View reviewed changes

Apply suggestions from code review

0d5bdcd

Co-authored-by: Copilot <[email protected]>

Fix buffer size for xenserver

e878bbe

sureshanaparti added the status:needs-testing label Jul 22, 2025

DaanHoogland approved these changes Jul 23, 2025

View reviewed changes

sureshanaparti approved these changes Jul 24, 2025

View reviewed changes

sureshanaparti removed the status:needs-testing label Jul 24, 2025

sureshanaparti merged commit 111d87b into apache:4.20 Jul 24, 2025
25 of 26 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.21.0 Jul 24, 2025

DaanHoogland deleted the console-proxy-performance branch July 24, 2025 11:07

console: optimise buffer sizes for faster console performance #11221

console: optimise buffer sizes for faster console performance #11221

Uh oh!

Conversation

rohityadavcloud commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

DaanHoogland commented Jul 16, 2025

Uh oh!

Uh oh!

rohityadavcloud commented Jul 16, 2025

Uh oh!

blueorangutan commented Jul 16, 2025

Uh oh!

weizhouapache commented Jul 16, 2025

Uh oh!

rohityadavcloud commented Jul 16, 2025

Uh oh!

adietrich-ussignal commented Jul 16, 2025

Uh oh!

blueorangutan commented Jul 16, 2025

Uh oh!

rohityadavcloud commented Jul 16, 2025

Uh oh!

blueorangutan commented Jul 16, 2025

Uh oh!

rohityadavcloud commented Jul 16, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vishesh92 commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

Uh oh!

vishesh92 commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

Uh oh!

vishesh92 commented Jul 21, 2025

Uh oh!

blueorangutan commented Jul 21, 2025

Uh oh!

blueorangutan commented Jul 21, 2025

Uh oh!

rohityadavcloud commented Jul 22, 2025

Uh oh!

blueorangutan commented Jul 22, 2025

Uh oh!

sureshanaparti commented Jul 22, 2025

Uh oh!

blueorangutan commented Jul 22, 2025

Uh oh!

blueorangutan commented Jul 23, 2025

Uh oh!

blueorangutan commented Jul 23, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

rohityadavcloud commented Jul 16, 2025 •

edited

Loading

codecov bot commented Jul 16, 2025 •

edited

Loading