Skip to main content
Skip table of contents

NVIDIA nVector Integration

Overview

Login VSI, in collaboration with NVIDIA, proposes a unique extension to Login Enterprise that
leverages NVIDIA’s GPU and virtual GPU (vGPU) performance testing and analysis technology. This integration aims to enhance graphical responsiveness and quality in virtual environments using NVIDIA's nVector agents and performance metrics for scalability testing and VDI production monitoring. This integration enables you to optimize GPU-based configurations, ensuring optimal performance and cost-efficiency for your solutions.

Requirements

  • Login Enterprise Appliance v5.13.6 or higher (which has Platform Metrics enablement).

  • Supported VDI stacks: Citrix, VMware/Omnissa (Horizon), RDS, Azure Virtual Desktop.

  • NVIDIA GPU (or vGPU) present on the Launcher machine - nVector workloads require GPU-enabled Launchers.

  • nvector-agent.exe on each Launcher and the Appliance (see repo/release).

  • Launcher access to the Login Enterprise API (for metric upload).

  • Following the Quick Start section below.

Quick Start

  1. git clone https://github.com/LoginVSI/nVector

  2. Upload the agent to the Appliance

    1. Via a tool like WinSCP, place nvector-agent.exe (from the repo/release) in the Appliance script content folder (example path used in the PDF - loginvsi/content/scriptcontent/nvector-agent.exe).

  3. Create an Environment in Login Enterprise and note the EnvironmentId (UUID). To learn more, see Creating an Environment.

  4. Upload the workload

    1. Add nVector_Desktop_Prepare.cs as a custom application/workload in Login Enterprise. For details, refer to Importing Application Scripts.

  5. Prepare Launchers (per Launcher you will use for latency measurements):

    1. Copy: nVector_Client_Prepare.ps1, nVector_Startup_Script.cmd, nvector-agent.exe → e.g. C:\temp\nvidia\.

    2. Edit nVector_Client_Prepare.ps1 and set these values:

      1. NvectorAgentExePath → full path to nvector-agent.exe

      2. EnvironmentId → the UUID from step 3

      3. BaseUrl → your Login Enterprise API base URL

      4. ConfigurationAccessToken → API token with upload rights (configuration). For more information, consult Adding a System Access Token.

      5. Local log/screenshot/CSV paths (if needing to be changed from the placeholder paths)

    3. Place nVector_Startup_Script.cmd in the user Startup folder (like "shell:common startup" or create a scheduled task to run at logon, such as:

      1. CODE 
        powershell.exe -ExecutionPolicy Bypass -File "C:\temp\nvidia\nVector_Client_Prepare.ps1"

  6. Create a Test in Login Enterprise (Load Test or Continuous):

    1. Use the Environment created earlier.

    2. Add the nVector_Desktop_Prepare workload to a session.

    3. Important: set the connector/session to run full-screen on the Target VM (nVector captures the top-most full-screen session - see note below).

  7. Run a short smoke test (60–120s) to confirm datapoints are uploaded to Platform Metrics and the CSV uploader writes files.

Now you're ready to scale up and run further actual testing.

What You’ll Get

  • Scatter/time charts of endpoint graphical latency (ms) in Login Enterprise Platform Metrics.

  • Per-launcher CSV/JSON exports of latency via the included get_nVectorMetrics.ps1.

  • Ability to compare GPU vs no-GPU scenarios and correlate with other Login Enterprise measurements (EUX, VSImax, session, etc.) metrics.

What to Check After the First Run

  • Platform Metrics in the Appliance's UI show latency datapoints (scatter/time).

  • The Launcher folder contains nvector logs and CSVs.

  • get_nVectorMetrics.ps1 can pull data for your EnvironmentId and time window.

Enabling Browser Viewing of Latency Metrics

  1. Open the Login Enterprise web UI and sign in with an account that can view the Appliance UI.

  2. Open the browser Developer Tools:

    • Windows: press F12 or Ctrl + Shift + I

    • macOS: Cmd + Option + I

  3. Select the Console tab in Developer Tools.

  4. Paste the following command at the console prompt and press Enter:

    1. CODE 
      leSetFeatureFlag('platformMetrics', 1)

    2. This will enable the Platform Metrics view, so nVector metrics (latency, etc.) become visible in the UI.

  5. Refresh the page (if the metrics view does not appear immediately) and navigate to the Platform Metrics / Results area to view the nVector charts.

How to View and Export Results

  • In the UI: 

    • For Continuous Test: select Platform Metrics > the environment/time window > view Endpoint Latency scatter and timeseries.

    • For Load Test: the measurements will automatically display in the test results

  • Export: run get_nVectorMetrics.ps1 with StartTime, EndTime, EnvironmentId, and an API token to export CSV/JSON for analysis.

  • If you don’t see metrics, confirm the API token, EnvironmentId, and that the Launcher uploaded CSVs to the Appliance.

Important Operational Notes

  • Launcher must be GPU-enabled. nVector requires the Launcher to have an NVIDIA GPU/vGPU — CPU-only Launchers will not generate latency telemetry.

  • Latency is collected only from the top-most full-screen session on a Launcher. If multiple desktop sessions run on a single Launcher, only the active full-screen session will emit latency measurements. Best practice: if possible, run one Target session per Launcher when you require latency metrics.

Troubleshooting: Quick Checks

  • No latency datapoints:

    • Confirm nvector-agent.exe exists and nVector_Client_Prepare.ps1 ran successfully at logon.

    • Verify the test session is full-screen on the Target VM (only full-screen sessions produce latency).

    • Confirm Launcher is GPU-enabled and drivers are up to date.

  • CSV upload failed/missing exports:

    • Inspect local Launcher logs (path set in nVector_Client_Prepare.ps1).

    • Run get_nVectorMetrics.ps1 manually with the EnvironmentId/API token and check for HTTP errors.

  • Platform Metrics UI not visible:

    • Ensure to enable the platform metrics UI flag as documented in the full PDF or upgrade the Appliance, and that the Appliance is v5.13.6 or newer

(See the PDF in the repo for log examples, feature-flag commands, and advanced diagnostics.)

Contacts and Support

Appendix: File Reference

  • nVector_Client_Prepare.ps1 - Login Enterprise Launcher data uploader and nVector runner script

  • nVector_Startup_Script.cmd - startup wrapper for logon execution on the Client (of the nVector_Client_Prepare.ps1 script)

  • nVector_Desktop_Prepare.cs - Login Enterprise workload to execute on the Target VM (Desktop)

  • nVector_Agent_Installation_x.pdf - full installer + troubleshooting guide (in repo)

  • get_nVectorMetrics.ps1 - export helper that queries the Login Enterprise API and outputs CSV/JSON. Not needed for primary testing, but helpful with extracting raw data

Additional Resources

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close