Skip to content

A research tool for debugging performance in software systems.

Notifications You must be signed in to change notification settings

vanHekthor/glimps

Repository files navigation

GLIMPS

A research tool for debugging performance in software systems.

image.png Modified and easily reproducible version of the original tool (https://github.com/miguelvelezmj25/glimps).

Features

  • Influencing Options: Displaying the options with the biggest impact on performance.
  • Option Hotspots: Show where in the code the influencing options effect the performance.
  • Option-Hotspot Trace: Reduce the codebase to the parts which are effected by an option.

Installation

You must install the extension and run two local servers to be able to use all features of GLIMPS. The two servers can be run using the docker images provided in ./servers.

Extension

The following commands will create the VSIX package containing the extension:

npm install
vsce package

This results in a perf-debug-0.0.1.vsix inside the root folder. For installing the extension in VS Code use:

code --install-extension perf-debug-0.0.1.vsix

You may need to reload the VS Code window.

Hotspot Diff Server

Inside the root folder run:

docker load -i ./servers/hotspot-diff-server.tar

This adds the image to your local docker images.

Joana Slicer Server

Inside the root folder run:

docker load -i ./servers/joana-slicer-server.tar

This adds the image to your local docker images.

Usage

As of now, GLIMPS can only be used with the following three software systems, because only those contain the required resources (i.e. profiler measurements, ML models, program slices):

Get Started

  1. Clone one of the listed repositories.
  2. Open the repository in VS Code.
  3. Switch to the user-study branch.
  4. Start the two servers with
docker run -it -p 8001:8001 hotspot-diff-server
docker run -it -p 8002:8002 -p 8003:8003 -p 8025:8025 joana-slicer-server
  1. Press Ctrl+Shift+P or F1 and select Perf Debug: Configuration Dialog

image.png

Hotspot View (works only if the hotspot diff server runs)

image.png

Option-Hotspot Trace (works only if the joana slicer server runs)

image.png

Known issues

The extension does not start on Ubuntu 21.10 and 22.04 (but 20.04 is fine) in combination with VS Code version 1.62+ (october 2021 and newer). When working on Ubuntu 21.10+, we recommend to install the VS Code version 1.61 (https://code.visualstudio.com/updates/v1_61).

About

A research tool for debugging performance in software systems.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published