SureLogic

Downloading and Installing the Eclipse-based SureLogic Tools

The current SureLogic tool release is version 5.6.0.201504201353. You must be running Eclipse on a Java 7 VM (see below).

It should take no more than 5 minutes for you to get up and running if you already have a working Eclipse installed on your machine. If you do not have Eclipse please go to the Eclipse Download Site and download and install a copy. If you have any problems getting up and running, please call Tim Halloran at (412) 722-3338 for help. We want you to have a good experience with our product and are ready to help. We realize that it can be difficult to navigate the Eclipse plug-in installation and management user interface. Feel free to also file any problems or questions on Bugzilla at our website.

Click to download an archived update site for SureLogic tools version 5.6.0.201504201353 you can load into Eclipse

or

point your Eclipse at the SureLogic update site:

http://surelogic.com/static/eclipse

The SureLogic tools contained in the Zip download are an archived Eclipse update site you can use to install the tools in your Eclipse IDE. The release is installed (and uninstalled) via the normal Eclipse mechanisms. Detailed instructions are given below. The following tools are available as Eclipse features:

Flashlight Client
Flashlight is a dynamic analysis tools for Java focused on understanding, diagnosing, and correcting concurrency issues. It can be thought of as a "concurrency-focused profiler" as it also helps the developer to improve program responsiveness and performance.
Flashlight Client Android (Optional)
Flashlight is a runtime profiler that illuminates threading behavior and access to shared state in Android applications. Your Eclipse must have the Android Development Tools (ADT) installed for this feature to install successfully. The normal Flashlight Client is also required for this feature to install successfully.
JSure Client
JSure is a model-based static analysis tool that helps developers gain confidence in their code, regardless of scale or complexity. JSure produces analysis-based verification results of consistency between programmer annotations (e.g., @ThreadSafe or @NonNull) and code.
Sierra Client
Sierra is a bug management tool that helps developers deal with the often overwhelming number of findings produced by popular source code analysis tools (e.g., FindBugs and PMD) when analyzing large codebases.
Sierra Local Team Server (Optional)
Install the Sierra Local Team Server feature if you want to try out the local team server, used in the tutorials. Installing this feature is recommended. The normal Sierra Client is required for this feature to install successfully.

The tools may be installed and used in versions 3.7.2 and higher of Eclipse (higher being recommend). Eclipse 4.4 (or higher) is needed for Java 8 support. If you are not sure if your version of Eclipse is supported please contact SureLogic. The Eclipse-based IBM Rational Application Developer for WebSphere Software (RAD) 8.0 is supported.

The current release of SureLogic Tools requires a Java 7 VM be used to run the Eclipse that the tools are installed in. Note: Eclipse will unfortunately allow the tools to be installed even if it is running in a Java 1.6 VM, but on restart the SureLogic Tools will not show up in the menu. If you need more information on how to setup your Eclipse with multiple virtual machines, this video may prove useful.

Before you begin: Make sure that your operating system user has read/write access to the Eclipse directory. Plugin installation fails on some systems if Eclipse is unable to write to its installation directory. We also recommend that you allow roughly 1 GB of heap space for your Eclipse JVM. You can change this setting by modifying the -Xmx arguments in your eclipse.ini file located in your Eclipse installation directory. For example, under Eclipse 3.7 under Windows, you would change the last few lines of the eclipse.ini file from

-vmargs
-Xms40m
-Xmx384m

to

-vmargs
-Xms40m
-Xmx1g

If you are not using a Java 8 VM you should also consider setting Perm Gen to 512 MB. To do this change --launcher.XXMaxPermSize in eclipse.ini (there might be two entries in the file) as as below

--launcher.XXMaxPermSize
512m

Most modern Eclipse releases set this to 265 MB which might be okay for most uses. The best solution is to use a Java 8 VM (in which Oracle removed this as a setting).

  1. We find that installing the tools, especially for the first time, is better done from an archived update site, which you can find here (the same file downloaded by the above button). This archive contains the Sierra, JSure, and Flashlight features. If you are an advanced Eclipse user, you can choose to use our update site, located at http://surelogic.com/static/eclipse, and skip to step 3.

  2. Select 'Help | Install New Software…' to open the 'Install' dialog. Click the 'Add…' button in the upper-right of the dialog. In the dialog that opens select the 'Archive…' button and point the file selection dialog that appears to the to the SureLogic archived update site file downloaded in step 1, then press 'Open' followed by 'OK'. The 'Install' dialog should appear as shown in the figure below.

    Selecting features to install in Eclipse

    Choose the features you want to install (or simply press 'Select All'), and press 'Next >' and step through the remaining wizard dialog steps. The features you are installing are not digitally signed, however, you should allow them to be installed if you are warned by Eclipse that it can't verify them. Finally, you should restart Eclipse when the installation is completed.

    Do not check 'Flashlight Client Android (Optional)' if you do not have the Android Development Tools (ADT) installed in your Eclipse.. Please uncheck this optional feature as shown in the figure below.

    Don't select the Flashlight Client Android feature if you don't have the Android SDK
  3. When Eclipse restarts you should see an item on the Eclipse main menu for each tool that you installed. The first thing you need to do is to install the license provided to you by SureLogic. To do this select the 'Manage SureLogic Licenses' menu choice from the Eclipse main menu from any of the tools (they all open a common dialog) as shown in the figure below.

    Main menu choice to install your license

    In the dialog that appears, press the 'Install from File' if you saved your license in a file or 'Install from Clipboard' if you copied the text of your license from an email, respectively.

    SureLogic license management dialog showing a license to use Flashlight has been installed

    Once your license is loaded it may need to be activated. If so, highlight your license in the list of licenses and press 'Activate' to activate it. This step requires Internet access because the tool contacts SureLogic to verify your license is authentic.

    See the 'Getting started' chapter of any of the tool User Guides for information on how you install your license and get up and running with the tool. The tool User Guides can by opened by selecting 'Help | Help Contents' from the Eclipse main menu

  4. To run the tutorials for Sierra, Flashlight, or JSure select the 'Run Tool Tutorials' menu choice from the Eclipse main menu for that tool. For example, For the JSure tool you would select 'JSure | Run JSure Tutorials' from the Eclipse main menu as shown in the figure below.

    Main menu choice to install and run the JSure tutorials

    This action will import the tutorial projects into your workspace and open the Eclipse help up to the beginning of the first tutorial. We recommend that you take the time to step through each tutorial.

    Also notice the 'Send Tip for Improvement' and 'Send Problem Report' menu items in the figure above. These menu items are your direct link to interact with the SureLogic engineers about your ideas to improve our tools and to report any problems you encounter.

  5. To learn more about how to use the tools select 'Help | Help Contents' and open the Sierra, Flashlight, or JSure User Guides. If you have installed JSure, you should also read the JSure Annotation Guide. These guides contain tutorial and reference information about how to use the tools effectively.

  6. You can stay current with the latest versions of all of the SureLogic tools by checking for updates from Eclipse. If you have not configured Eclipse to periodically check for updates, you can check for tool updates by selecting 'Help | Check For Updates'. This will check the SureLogic update site at http://surelogic.com/static/eclipse for any updates, regardless of whether you installed the tools from the archive site or from the remote site.

Valid XHTML 1.0 Strict