Home > Articles > Home & Office Computing > Mac OS X

This chapter is from the book

This chapter is from the book

Running an Instrument

To use an instrument, you follow three steps: configuration, recording, and, optionally, saving the results.

Instrument Configuration

Configuration inspectors vary by instrument, but some elements are used frequently.

There is a Target pop-up that initially points to the document's default target (set with the Default Target menu in the toolbar). If no default target has been selected, or if the Default Target menu has been set to Instrument Specific, the instrument's Target is active. You can select from processes already running, applications that Instruments had sampled before, a new application or tool of your choice, or, with many instruments, the system as a whole.

The ability to set a target for each instrument is important: It allows you to examine the behavior of an application and other processes with which it communicates, simultaneously.

In the Track Display section, there are three controls: A Style pop-up, a Type pop-up, and a Zoom slider.

The usual Style menu selects among graphing styles for the numeric data the instrument records. These may include the following:

  • Point. Each datum is displayed as a discrete symbol in the track. You can choose the symbols in the list of available series in the inspector.
  • Line. The track is displayed as a colored line connecting each datum in the series. You can choose the color in the list of the available series.
  • Filled Line is the same as Line, but the area under the line is colored.
  • Peak shows the data collected by an instrument that records events (such as the Core Data instruments) as a vertical line at each event. Every time something happens, the trace shows a blip.
  • Block is a bar graph, showing each datum as a colored rectangle. In instruments that record events, the block will be as wide as the time to the next event.

The Type menu offers two choices for instruments that can record more than one data series. Overlay displays all series on a single graph. The displayed data will probably overlap, but in point and line displays this probably doesn't matter, and filled displays are drawn translucently, so the two series don't obscure each other. Stacked displays each series in separate strips, one above the other.

Zoom increases the height of the instrument's track. This is especially handy in stacked displays, enabling you to view multiple traces without squishing them into illegibility. The slider clicks to integer multiples of the standard track height, from 1 to 10 units.

You can change the Track Display settings even after the instrument has collected its data. You can find a shortcut for the Zoom slider in the View menu, as Increase Deck Size (stard.gif+) and Decrease Deck Size (stard.gif-).

One disadvantage of the inspector system is that inspectors are of fixed size, and can be quite tall. If a track is low on the screen (which it may have to be, if it is low in a multitrack document), it might run off the bottom, obscuring the Done button that dismisses the inspector. Fortunately, you can also dismiss an inspector by pressing the i button again. The only workaround that allows you to get at the options at the bottom of the inspector is to drag the track to the top of the document, make the setting, and, if you want, drag it back.

Recording

There is more than one way to start recording in Instruments.

The most obvious is to create a trace document and click the Record button in the toolbar. Recording starts, you switch to the target application, perform your test, switch back to Instruments, and click the same button, now labeled Stop.

The first time you record into a document that contains a User Interface instrument, the recording button will be labeled Record, as usual. Once the UI track contains events, the recording button is labeled Drive & Record. When you click it, no new events are not recorded into the UI track; instead, the events already there are replayed so you can reproduce your tests.

If you want to record a fresh User Interface track, open the configuration inspector (with the i button in the instrument's label) and select Capture from the Action pop-up. The recording button will revert to Record.

A second way to record is through the Quick Start feature, which allows you to start recording with a systemwide hotkey combination. To set a hotkey, open Instruments' Preferences window and select the Quick Start tab. This tab includes a table listing every system- and user-supplied template. Double-click in the column next to the template you choose, and press your desired hotkey combination. The combination must include at least two modifier keys (such as Command, Shift, and so on).

With the hotkey set, move the cursor over a window belonging to the application you want to target, and then press the key combination. Instruments will launch if it is not running already, open a new trace document behind your application with the template you selected, target it on your application, and start recording. To stop, make sure your cursor is over one of the target's windows, and press the key combination again (or switch to Instruments and click Stop).

The requirement to point the cursor at one of the target's windows allows you to run simultaneous traces on more than one application.

To remove a hotkey, select the template in the Quick Start table, and press the Delete key.

The third way to record is through the Mini Instruments window. Selecting View > Mini Instruments, or clicking the Mini button in the toolbar of any document window, hides all of Instruments' windows and substitutes a floating heads-up window listing all of the open trace documents (see Figure 26.8).

Figure 26.8

Figure 26.8 The Mini Instruments heads-up window. It lists each open trace document next to a clock and a recording button. Scroll through the list using the arrowheads at top and bottom.

The window lists all of the trace documents that were open when you switched to Mini mode; scroll through by clicking the up or down arrowheads above and below the list. At the left of each item is a button for starting (round icon) or stopping (square icon) recording, and a clock to show how long recording has been going on. Stopping and restarting a recording adds a new run to the document.

As with Quick Start keys, Mini Instruments has the advantages that it's convenient to start recording in the middle of an application's run (handy if you are recording a User Interface track that you want to loop) and that you can control recording without switching out of the target application (which can also impair a UI recording).

You return to the full display of Instruments by clicking the close (X) button in the upper-left corner of the Mini Instruments window.

Saving and Reopening

As with any other Macintosh document, you can save a trace document. The document will contain its instruments and all the data they've collected. There can be a lot of data, so expect a trace document to be large—on the order of tens of megabytes.

It's likely that you will come to need a uniform layout of instruments that isn't included in the default templates provided by Apple. You can easily create templates of your own, which will appear in the template sheet presented when you create a new trace document. Configure a document as you want it, and select File > Save as Template....

The ensuing save-file sheet is the standard one, focused on the directory in which Instruments looks for your templates, ~/Library/Application Support/Instruments/Templates. The name you give your file will be the label shown in the template-choice sheet. At the lower left of the sheet is a well into which you can drag an icon (for instance, if your template is for testing your application, you'd want to drop your application's icon file here), or you can click and hold the mouse button over the well to choose Apple-provided icons from a pop-up. The panel provides a text area for the description to be shown in the template-choice sheet.

  • The document's suite of instruments, and their configurations, will be saved in the template.
  • The template will include the default and instrument-specific targets you set.
  • If you include a prerecorded User Interface track, the contents will be saved. This way you can produce uniform test documents simply by creating a new trace document and selecting the template.

As you'd expect, you can reopen a trace document by double-clicking it in the Finder, or through File > Open.... All the data is as it was when the document was saved. Clicking Record adds a new run to the document.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020