1. Introduction
2. How to use the Performance Report Tab
• Open CET Developer Studio
• 1. Open the Performance Report Tab
• 2. Select the extension to test
• Enable Interaction Tests (Optional)
• 3. Running the Tests
3. Understanding the Report
• Report Overview
• Startup Time
• Memory Performance
• Graphics Performance
• Parts Performance
• Interaction Performance
4. The Report Folder
5. Exporting the Report

CET Developer Performance Report Tab

Introduction

Testing the performance of an entire extension in CET can be a time consuming task, for this reason CET Developer provides a tool to help automate the process. This Performance Report Tab allows you to run a series of tests on an extension, and then generate a report to help identify performance issues.

How to use the Performance Report Tab

Open CET Developer Studio

The performance report tab is launched from the CET Developer application. To access it, open CET Developer and click on the Dev Studio button in the bottom left corner of the workspace which has the extension you wish to test. This will open the Developer Studio window.

1. Open the Performance Report Tab

This tab can be accessed by selecting the Performance tab in the top of the developer studio window. This will open the performance report tab.

2. Select the extension to test

Once the performance report tab is open, you will need to select the extension you wish to test. To do this, you can either select the extension from the list of extensions, or you can search for the extension by name using the Filter box. It is possible to select more than one extension to test by holding the Ctrl key while selecting the extensions.

Enable Interaction Tests (Optional)

For further metrics on the performance of the tested extension(s), you can enable interaction tests. Interaction tests will run your extension through a series of click, move, rotate, delete, connect, and disconnect operations. This will give an indication of how responsive the extension is to user interaction. These tests are enabled by clicking the Include Interaction Tests checkbox. These tests can take a long time to run, so it may not be necessary to run them every time you test the extension.

3. Running the Tests

Once you have selected the extension(s) you wish to test, you can run the tests by clicking the Go button. This will run the tests and generate a report. Once the tests are complete, the report will display to the right of the extension list.

Understanding the Report

The report generated by the performance report tab is split into a few different sections shown below.

Report Overview

The overview contains a few basic pieces of information about the test that was ran. 

Extension Name

The name of the extension being tested.

Performance Class

The performance class is the target performance level for your extension. Your extensions performance class represents the number of objects expected to be in the drawings your extension is used in. A performance class of 10k+ would mean that your extension is targeting use in drawings of 10k snappers or more. This value will be used to inform how closely your extension comes to meeting the performance goals for a drawing of that size.

Performance Score

The performance score is a percentage based score which indicates how closely you meet the criteria for your performance class. The score is chosen from the various performance tests that are ran. The lowest scoring test is used to determine the overall performance score. For example, if you have a performance class of 10k+ and a performance score of 50%, this means that some part of your extension may perform poorly in drawings with 10,000 or more snappers and it should be reworked to improve performance.

Startup Time

The startup time is the time it takes for the extension to load and be ready for user interaction. Code that runs during the initialize and start methods of the extension can affect the extensions score.

Memory Performance

The memory performance of an extension is defined by the amount of memory used in various situations by individual snappers.

Graphics Performance

The graphics performance of an extension is its combined 2D and 3D model efficiency as well as timing for bound and initial graphics creation.

Parts Performance

The parts performance of an extension is the time required to generate parts for each snapper in the extensions library.

Interaction Performance

The interaction performance of an extension is the time it takes to perform various user interactions with the snappers in the extensions library.

The Report Folder

The performance report tab will generate a folder containing all generated reports. This folder can be accessed by clicking the Show Report Folder button in the top right corner of the performance report tab.

Exporting the Report

Performance reports can be exported to a HTML file by clicking the Export button in the top right corner of the performance report tab.

When the report is exported, the reports will be saved to the performance report folder. The exported report will be named after the extension being tested and will have a .html extension.