bed156c565
KASM-7072 Added threaded decoding of rects. Update replay test to work with threaded decoding. Update stats tracker to track dropped fps. --------- Co-authored-by: ryan.kuba <ryan.kuba@kasmweb.com> Co-authored-by: Ryan Kuba <ryankuba@gmail.com> Co-authored-by: Matt McClaskey <matt@kasmweb.com> |
||
|---|---|---|
| .. | ||
| .eslintrc | ||
| README.md | ||
| assertions.js | ||
| fake.websocket.js | ||
| playback-ui.js | ||
| playback.js | ||
| test.base64.js | ||
| test.copyrect.js | ||
| test.deflator.js | ||
| test.display.js | ||
| test.gesturehandler.js | ||
| test.helper.js | ||
| test.hextile.js | ||
| test.inflator.js | ||
| test.int.js | ||
| test.jpeg.js | ||
| test.keyboard.js | ||
| test.localization.js | ||
| test.ra2.js | ||
| test.raw.js | ||
| test.rfb.js | ||
| test.rre.js | ||
| test.tight.js | ||
| test.tightpng.js | ||
| test.util.js | ||
| test.websock.js | ||
| test.webutil.js | ||
| test.zrle.js | ||
| vnc_playback.html | ||
README.md
KasmVNC Client Tests
The page /tests/vnc_playback.html can be used to playback KasmVNC session recordings. The playbacks can be ran in realtime or as fast as possible for performance testing.
Creating new recordings
In order to create a new recording, you will need to disable KasmVNC's built-in web server, enable the legacy VNC TCP port, and disable authentication.
sudo apt-get install websockify
vncserver -noWebsocket -disableBasicAuth
websockify --web /usr/share/kasmvnc/www --record=/home/ubuntu/record.bin 8444 localhost:5901
Websockify automatically adds a number to the end of the filename, so the above example might be record.bin.8. After you are finished recording, Ctrl+C the running websockify process and mv the file to the noVNC www directory.
sudo mkdir /usr/share/kasmvnc/www/recordings
mv /home/ubuntu/record.bin.8 /usr/share/kasmvnc/www/recordings
Playing Back Recordings
Place recordings on the KasmVNC server in the /usr/share/kasmvnc/www/recordings directory, you may need to create this directory. Then navigate to https://server-ip:8444/tests/vnc_playback.html?data=record.bin.8 where record.bin.8 is the name of the playback file you placed in the recordings directory.
If you are running a Dev container for KasmVNC and running the front-end using nodejs, create a directory public/recordings from the root of the frontend code and place the videos in that location.
Threaded Decoding When threaded decoding on the client was added to KasmVNC in 1.4.0, this disrupted the playback testing framework. When threaded encoding is enabled, the client does not block on rendering, therefore the server will send frames as fast as it can regardless of if the client can process the frames or not. In this playback framework, the VNC session recording is played back without a frame rate limit and if threaded decoding is enabled the client will process as much of it as possible and end up discarding frames. To account for this, a target frame rate was added to the playback UI. When testing with threaded decoding enabled, be sure to set the iterations to 1 and provide a target frame rate. Keep increasing the target frame rate until you start dropping frames and then back the frame rate down until you get near 0.
Pre-Test Modifications
Before running performance testing using recording playback, you need to run noVNC from source, rather than the 'compiled' webpack. See the docs at docs/DEVELOP.md for running noVNC from source.
Kasm Provided Recordings
The following recordings are used by Kasm Technologies to provide repeatable performance statisitics using different rendering settings.
| Name | Description | URL |
|---|---|---|
| newyork.1 | Default 'Static' preset mode. | https://kasm-static-content.s3.amazonaws.com/kasmvnc/playbacktests/newyork.1 |
| losangeles.1 | Default static preset mode with webp disabled | https://kasm-static-content.s3.amazonaws.com/kasmvnc/playbacktests/losangeles.1 |
Historical Statistics
This table keeps track of performance of pre-defined recordings, defined in the previous section, on static hardware that can be replicated over time to track performance improvements. Multi-threaded decoding was added during noVNC 1.3.0 development, previous testing did not include this feature.
| File | Commit/Version | Threaded | Hardware | OS | Browser | Webpacked | Result Avg |
|---|---|---|---|---|---|---|---|
| newyork.1 | 08233e6 |
N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 106 | False | 2446ms |
| losangeles.1 | 08233e6 |
N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 106 | False | 2272ms |
| newyork.1 | base64opt | N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 106 | False | 2273ms |
| losangeles.1 | base64opt | N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 106 | False | 1847ms |
| newyork.1 | 4a6aa73 |
N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 119 | False | 2128ms |
| losangeles.1 | 4a6aa73 |
N/A | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 119 | False | 1766ms |
| newyork.1 | 1.3.0 | off | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 135 | False | 1956ms |
| newyork.1 | 1.3.0 | On | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 135 | False | 696ms |
| losangeles.1 | 1.3.0 | off | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 135 | False | 1166ms |
| losangeles.1 | 1.3.0 | On | Macbook M1 Pro, 32GB RAM | macOS 12.2 | Chrome 135 | False | 789ms |