Skip to content

Latest commit

 

History

History
138 lines (104 loc) · 7.9 KB

README.md

File metadata and controls

138 lines (104 loc) · 7.9 KB
Raw

Platform Performance Suite (PPS)

The Platform Performance Suite (PPS) provides insight in software execution over time and enables automatic performance diagnostics. Various generic analysis techniques like critical path, root-cause, outlier identification analysis can be applied to the Timed Message Sequence Chart (TMSC) model. The TMSC-models, as well as the results of the analysis, are presented to the user by various visualizations focusing on facilitating the diagnosis at specific abstraction levels.

Documentation

To get up-and-running and to learn more about PPS, please read its documentation at https://tno.github.io/PPS/

Development environment setup

Note

Contributions are always welcome! Before starting PPS development, please read the PPS Developer Guide.

Follow these instructions to set up a PPS development environment.

To create a development environment (first time only):

  • Get the Eclipse Installer:
    • Go to https://www.eclipse.org/ in a browser.
    • Click on the big Download button at the top right.
    • Download Eclipse Installer, 64 bit edition, using the Download x86_64 button.
  • Start the Eclipse Installer that you downloaded.
  • Use the hamburger menu at the top right to switch to advanced mode.
  • For Windows:
    • When asked to keep the installer in a permanent location, choose to do so. Select a directory of your choosing.
    • The Eclipse installer will start automatically in advanced mode, from the new permanent location.
  • For Linux:
    • The Eclipse installer will restart in advanced mode.
  • Continue with non-first time instructions for setting up a development environment.

To create a development environment:

  • Ensure you are using the latest version of the Eclipse Installer:
    • One option is to download it again, as per the 'first time' instructions above.
    • Another option is to update your existing Eclipse Installer. In the Eclipse Installer, when in advanced mode, click the 'Install available updates' button. This button with the two-arrows icon is located at the bottom-left part of the window, next to the version number. Wait for the update to complete and the Eclipse Installer to restart. If the button is disabled (grey), you are already using the latest version.
  • In the first wizard window:
    • Select Eclipse IDE for Eclipse Comitters from the big list at the top.
    • Select 2021-12 for Product Version.
    • For Java 11+ VM select either a JRE 11 that is installed on your local machine or the JustJ JRE 11 release. Use the button to the right of the dropdown to manage the installed virtual machines on your system. A JDK can also be downloaded from e.g. Oracle or Adoptium.
    • Choose whether you want a P2 bundle pool (recommended).
    • Click the Next button.
  • In the second wizard window:
    • Use the green '+' icon at the top right to add the Oomph setup.
      • For Catalog, choose Github Projects.
      • For Resource URIs, enter https://raw.githubusercontent.com/TNO/PPS/main/pps.setup and make sure there are no spaces before or after the URL.
      • Click the OK button.
    • Check the checkbox for TNO - PPS, from the big list. It is under Github Projects / .
    • At the bottom right, select the Main stream.
    • Click the Next button.
  • In the third wizard window:
    • Enable the Show all variables option to show all options.
    • Choose a Root install folder and Installation folder name. The new development environment will be put at <root_installation_folder>/<installation_folder_name>.
    • Fill in the TNO - PPS Github repository:
      • Committers with write access to the PPS official GitLab repository can use one of the default URLs Git (read-write) or HTTPS (read-write).
      • Contributors can use the HTTPS (read-only, anonymous) URL, as they don't have write access. They will not be able to push to the remote repository, they can instead make a fork of the official Git repository. Then they can fill in the URL of their clone instead, i.e. https://${github.user.id|username}@github.com/<username>/<cloned_repo_name>.git, with <username> replaced by their Eclipse Foundation account username, and <cloned_repo_name> replaced by the name of the cloned repistory, which defaults to PPS.
    • Fill in your Github user ID. This will be used as name for Git commits.
    • Click the Next button.
  • In the fourth wizard window:
    • Select the Finish button.
  • Wait for the setup to complete and the development environment to be launched.
    • If asked, accept any licenses and certificates.
  • Press the Finish button in the Eclipse Installer to close the Eclipse Installer.
  • In the new development environment, observe Oomph executing the startup tasks (such as Git clone, importing projects, etc). If this is not automatically shown, click the rotating arrows icon in the status bar (bottom right) of the new development environment.
  • Wait for the startup tasks to finish successfully.

Note

If you don't open the Oomph dialog, the status bar icon may disappear when the tasks are successfully completed.

If you have any issues during setting up the development environment, consider the following:

You can set the following environment variables to force the use of IPv4, in case of any issues accessing/downloading remote files:

_JAVA_OPTIONS=-Djava.net.preferIPv4Stack=true
_JPI_VM_OPTIONS=-Djava.net.preferIPv4Stack=true

After setting them, make sure to fully close the Eclipse Installer and then start it again, for the changes to be picked up.

In your new development environment, consider changing the following settings:

  • For the Package Explorer view:

    • Enable the Link with Editor setting, using the icon.

    • Enable showing resources (files/folders) with names starting with a period. Open the View Menu ( > Filters...). Uncheck the .* resources option and click the OK button.

Building with Maven

Caution

PPS should be built using a Java 11 VM. The JDK can be downloaded from e.g. Oracle or Adoptium.

To test which Java version is used by Maven, type mvn -version in a command shell.

To build PPS with Maven execute the following command in the root:

mvn clean verify

On a successful build, the built Eclipse products and P2 repository can be found in the target folder of the products/nl.esi.pps.product project.

License header

The Maven build uses license-maven-plugin to determine if the correct license headers are used for source files. If the header is incorrect the build fails.

Handy commands:

  • To only run the check execute: mvn license:check.
  • To automatically add/update execute: mvn license:format.

License

Copyright (c) 2018-2023 TNO and Contributors to the GitHub community

This program and the accompanying materials are made available under the terms of the MIT License.

SPDX-License-Identifier: MIT