Web Server Interface
Use Intel® VTune™ Profiler in a web server mode (preview feature) to get an easy on-boarding experience, benefit from a collaborative multi-user environment, and access a common repository of collected performance results.
This is a
PREVIEW FEATURE
. A preview feature may or may not appear in a future production release. It is available for your use in the hopes that you will provide feedback on its usefulness and help determine its future. Data collected with a preview feature is not guaranteed to be backward compatible with future releases.
The web server interface helps you quickly get started with the tool since you do not need to install the VTune Profiler as a desktop application on every client system. You can use the VTune Profiler Server to configure and control analysis on arbitrary target systems and view collected results.
To run an analysis via a web interface:
- (Personal mode) Run the VTune Profiler Server to get a URL to access the web interface.(Reverse proxy/SAML SSO modes) Get the server URL from your admin.
- Access the server via the URL.
- Select your target system:
To control
VTune
agents, use the
Administrator Dashboard.
Profiler
Run VTune Profiler Server
Prerequisite:
VTune Profiler Server is installed with VTune Profiler GUI.
In the personal/evaluation usage mode, run the VTune Profiler Server as follows:
- Start the VTune Profiler Server:<vtune-install-dir>/bin64/vtune-backendIf you want the VTune Profiler Server to access a specific TCP port, specify it with the--web-portoption. For example:vtune-backend --web-port=8080VTune Profiler Server outputs a URL to access the GUI. For the first run, the URL includes a one-time token. For example:Serving GUI at https://127.0.0.1:64880?one-time-token=0160852eeff593e0ab0a0f90991b4efaOptionally, you can specify a working directory forVTuneServer using theProfiler--data-directoryoption. For example:vtune-backend --web-port=8080 --data-directory="C:\vtune-results"VTuneServer allows you to create a directory with a custom hierarchy, organized to best fit your needs. Once you pointProfilerVTuneServer to this directory using theProfiler--data-directoryoption, users will be able to access all projects and results, regardless of folder names and levels of nesting. This can be especially useful if you're using an HPC scheduler to regularly collectVTuneperformance data and put it into a shared folder on the network for later examination. For example, you can organize your results folder by users and their workloads:ProfilerBy default, access to the VTune Profiler Server is limited to the local host only. To enable access from remote client and target systems, restart the server with the--allow-remote-uioption.
- Open the URL with the provided one-time token.If you start the VTune Profiler Server in the personal/evaluation mode with no signed TLS certificate provided, your web browser warns you that the default self-signed server certificate is not trusted and asks for your confirmation to proceed.
- Set a passphrase in theSet Passphrasedialog box.
In the reverse proxy or SAML SSO usage modes, use the URL provided by your admin to access the VTune Profiler Server instance installed in a lab.
Deploy the
VTune
Profiler Agent
VTune
Agent Profiler
You can choose between automated and manual deployment of the
VTune
Agent.
Profiler
Deploy the Agent automatically
VTune Profiler Server uses SSH for automated agent deployment. Running an SSH server on the target machine is required for automated deployment.
To deploy the Agent automatically:
- Enter the target machine username.
- Enter the credentials for target machine:
- ForPublic key authentication, add your public SSH key to theauthorized_keysfile on the target system for the user account that you specify in theUsernamefield. Then, select thePrivate keyfile on your client machine. If your private key is encrypted, specify thePrivate key passphrase.
- Alternatively, switch toPassword authenticationand provide the username and password.
- Optionally, specify the deployment directory.
- Click theDeploy Agentbutton.

Deploy the Agent manually
To deploy the Agent manually:
- Click theDownload Agent Manuallybutton In theWHEREpane of theConfigure Analysiswindow or access thehttp://URL to download the Agent.<VTune Profiler Server URL>/api/collection-agent/downloadYou can use tools such aswgetto download the Agent directly to the target system.
- Extract the Agent archive with your tool of choice and copy its contents to the target system.
- Run thevtune-agentexecutable on the target system and specify the agent owner using the-owneroption.<vtune-user-id>You can find yourVTuneuser ID in theProfilerAboutdialog.
- Compare theAgent key fingerprintin theWHEREpane of theConfigure Analysiswindow with the fingerprint printed out by the agent upon startup. If they match, click theAdmit Agentbutton.
Shared Agents
You can run a shared
VTune
Agent. In this case, the Agent will be available to all users of an instance of
Profiler
VTune
Server. This means that any user of this
Profiler
VTune
Server instance will be able to run data collection using this agent. It is recommended to only run shared agents using dedicated faceless accounts.
Profiler
To deploy a shared agent, check the
Share the agent with all VTune Profiler users
checkbox in the
WHERE
pane of the
Configure Analysis
dialog, or use the
--shared
command line option when deploying an agent manually.
Select a Client System
To profile a
client system
, which is the same machine that you use to access the VTune Profiler Server via a web browser, do the following:
- ClickNew Projectand specify a name for the new project.VTune Profiler opens the project configuration with yourlocalhostpre-selected as a target system.
- Configure your analysis target and analysis type.
Select a Remote System
To profile a remote target system, do the following:
- In theWHEREpane of theConfigure Analysiswindow, click the
down arrow to see available target systems.
- SelectAdd new remote target....VTunemaintains a list of used remote systems, if any, and displays it underProfilerRemote Targets.
- Enter the hostname or IP address.
Run the Analysis
Once the Agent is running, the
Configure Analysis
pane displays information that
VTune
is detecting the device configuration.
Profiler
The Agent downloads the collectors and the target package, which is approximately 100MB in size. Once the target package is downloaded, the Agent analyzes the target system configuration and displays the applicable analysis types.
To run an analysis:
- Install the Intel sampling drivers manually by running these commands:On Windows* OS:<vtune-agent-dir>\bin64\amplxe-sepreg.exeOn Linux* OS:<vtune-agent-dir>/sepdk/src/build-driver<vtune-agent-dir>/sepdk/src/insmod-sepThe<vtune-agent-dir>is the<vtune_profiler_<version>>installation folder created on the client system byVTune.Profiler
- Configure your analysis target and analysis type.
- Click theStartbutton to run the analysis.
Control
VTune
Profiler Agents
VTune
Agents Profiler
The
Administrator Dashboard
feature of
VTune
Server enables you to monitor and manage one or multiple agents from a single point.
Profiler
To open the Administrator Dashboard:
- Open theVTuneServer interface in your browser.Profiler
- In the main toolbar, open the drop-down menu and selectAdministrator Dashboard.The dashboard opens in a new tab and shows all agents that are related to this instance ofVTuneServer. This includes both connected and disconnected agents.Profiler
The dashboard enables you to:
- View information related to this agent:
- Target system IP address and hostname
- The username of the agent's user.
- Current connection status.
- Admit or stop one or multiple agents. To admit or stop multiple agents, select the agents by ticking the checkboxes and clickAdmit selectedorStop selected.