- Overview
- Script workflow
- Configurable variables
- Setup steps
- Prerequisites
- Benefits
- Examples of benchmarking results
- Additional information
This workload automates the execution of SPECviewperf (SVP) benchmarks and uploads the results as Platform Metrics to Login Enterprise. It provides an objective and standardized benchmarking process that is quick to configure, yielding valuable insights for baselining, performance comparisons, and configuration assessments.
Key features:
- Self-contained execution: Runs specified SPECviewperf view sets and handles results automatically.
- Data integration: Uploads benchmark results as Platform Metrics to Login Enterprise.
- Quick configuration: Requires minimal setup by updating variables at the top of the script.
- Objective analysis: Facilitates easy comparison across different GPUs, environments, and configurations.
Note that this document uses the terms script, workload, and Login Enterprise Application interchangeably. They all refer to the specViewPerf_Benchmark.cs
file that automates the benchmarking process.
For more details about the SPECperfview GPU benchmark workload, refer to the Login VSI repository on GitHub.
The script performs the following steps:
-
Check and terminate existing processes
- Checks if
runviewperf.exe
orviewperf.exe
processes are already running. - Optionally terminates existing processes if configured to do so.
- Checks if
-
Archive existing results
- Moves any existing
results_*
(previous SVP Test run(s)) directories from the SPECviewperf directory to an archive directory. - Ensures no residual result directories remain after archiving.
- Moves any existing
-
Run SPECviewperf
- Initiates the
RunViewperf.exe
process with the specified viewset and resolution. - Confirms the process starts within a specified timeout period.
- Records the start timestamp upon process initiation.
- Monitors the process until completion, enforcing a maximum runtime limit.
- Records the end timestamp when the process concludes.
- Initiates the
-
Create Start and End event
- Logs an event containing the start time, end time, viewset name, and host/user information.
-
Check for results and JS file
- Waits for the
results_*
directory to be created after benchmarking. - Locates the
*.js
results file within the directory.
- Waits for the
-
Wait for the JS file to be ready
- Monitors the
*.js
file to ensure it is fully written and stabilized in size before proceeding.
- Monitors the
-
Parse JS file
- Parses the
*.js
file to extract benchmark data. - Adjusts timestamps to UTC based on the specified time offset.
- Prepares the data for uploading to Login Enterprise.
- Parses the
-
Generate PowerShell script
- Creates a PowerShell script to upload the benchmark data to the Login Enterprise API.
-
Upload Platform Metrics
- Executes the PowerShell script to upload the data as Platform Metrics to Login Enterprise.
Update the following variables at the top of the script to match your environment:
-
string timeOffset = "0:00";
Time offset from UTC in hours:minutes. Adjusts timestamps to your local time zone. For example:-
"-7:00"
for Pacific Standard Time (PST). -
"+7:00"
or"7:00"
for UTC+7.
-
-
string configurationAccessToken = "**********";
Your configuration access token for the Login Enterprise API. To obtain:- Log in to Login Enterprise.
- Navigate to External notifications > Public API.
- Click New system access token.
- Provide a name and select Configuration from the Access level dropdown.
- Save and copy the token provided. Store it securely.
-
string baseUrl = "https://myLoginEnterprise.myDomain.com/";
The base URL of your Login Enterprise instance, including the ending slash. -
string environmentId = "**********";
Your environment key/ID in Login Enterprise. To obtain:-
Log in to Login Enterprise.
-
Navigate to Configuration > Environments.
-
You have two options:
-
Option A: Use an existing Environment.
- Click on the desired Environment.
- The environment ID is the unique identifier at the end of the browser's address bar URL (e.g.,
3221ce29-06ba-46a2-8c8b-da99dea341c4
).
-
Option B: Create a new Environment.
- Click Add Environment.
- Fill out the required information (only Name is necessary).
- Click Save.
- After saving, the unique environment ID will be at the end of the browser's address bar URL.
-
-
For more information on Environments, see the Environments.
-
string viewsetName = "snx";
The SPECviewperf viewset to run. Examples include"snx"
,"sw"
,"maya"
, etc. -
string resolution = "1920x1080";
The resolution for the benchmark. Options include resolutions like"1920x1080"
or"native"
. -
string svpDirPath = @"C:\SPEC\SPECgpc\SPECviewperf2020";
The installation directory path for SPECviewperf andRunViewperf.exe
.
Before running the script, perform the following setup steps:
-
Upload the Workload script: Import the
specViewPerf_Benchmark.cs
script to Login Enterprise under Configuration > Applications.
-
Login Enterprise version: This script has been tested with Login Enterprise version 5.13.
-
SPECviewperf installation: SPECviewperf must be installed and properly configured on the target machine.
-
SPECviewperf licensing: Before installing and using SPECviewperf for this testing, review your SPECviewperf licensing agreement to ensure that you are correctly licensed for this usage.
-
Access Tokens and IDs: Obtain a configuration access token and environment ID from your Login Enterprise instance.
-
Quick configuration: Minimal setup required. Update a few variables, and you're ready to run the benchmark.
-
Objective benchmarking: Utilizes SPECviewperf for standardized GPU performance metrics.
-
Data integration: Automatically uploads results as Platform Metrics to Login Enterprise for centralized analysis.
-
Performance analysis: Facilitates baselining and comparative analysis across different environments, GPUs, and configurations.
Examples of benchmarking results
Figure: Platform Metrics displayed over an hour timeframe.
Figure: Platform Metrics displayed over a day timeframe.
Notes
-
Modify the configurable variables at the top of the script to suit your environment.
-
Ensure that the target machine meets all requirements for running SPECviewperf.
-
The script includes error handling to gracefully handle unexpected conditions.
-
Method breakdown:
- The script uses nested methods within the
Execute()
method, each responsible for a specific part of the workflow, as detailed in the Script workflow.
- The script uses nested methods within the
-
Best practices:
-
The script follows best practices regarding error handling, resource management, and modular code structure.
-
Variables are clearly defined and documented for ease of configuration.
-
This workload script provides an automated and efficient method for running SPECviewperf benchmarks, processing the results, and integrating them into Login Enterprise for comprehensive analysis. It streamlines the benchmarking process, enabling quick configuration and immediate value in performance monitoring and comparative assessments.
© 2024 Login VSI. All rights reserved.
The information provided in this document is subject to change without notice. Login VSI assumes no responsibility for any errors that may appear in this document.
Please ensure to adhere to your organization's policies regarding script usage and data handling.
If you have any questions or need further assistance, contact our support team at support@loginvsi.com.