Caché Monitoring Guide - InterSystems Documentation

Monitoring Performance Using ^pButtons
To run the ^pButtons utility:
1. Enter the following command, which is case-sensitive and must be run in the %SYS namespace, in the Caché Terminal:
%SYS> do ^pButtons
2. From the main menu that is displayed, enter the number of the profile you want to run, or press Enter to exit the main
menu:
Current log directory: c:\intersystems\cache20101\mgr\
Available profiles:
1 30mins A half hour detail run sampling every 5 seconds
2 day A full day long run, sampling every 60 seconds
3 test A 5 minute test run sampling every 30 seconds
4 test30mins A half hour run sampling every 30 seconds
select profile number to run:
3. After you enter the profile you want to run, the utility displays information about the data it is collecting:
select profile number to run: 1
Please run the Windows performance monitor with the html provided
Collection of this sample data will be available in 1920 seconds.
The runid for this data is 20101007_1041_30mins.
The generated log files are located in the output directory. The files are uniquely identified by the , which is
uniquely named as follows: YYYYMMDD_HHMM_.log, where YYYYMMDD_HHMM is the year, month,
day, hour, and minute the utility started to collect data; and is the name of the profile you selected.
After the utility finishes collecting data (that is, at the end of the period of time specified in the profile), you can generate
a readable performance report; for information, see the Generating the ^pButtons Performance Reports section in this
chapter.
8.1.1 Run ^pButtons Programmatically
Alternatively, you can run the ^pButtons utility programmatically using entry points for the start and collect functions as
described in the following table.
Note:
You can run multiple profiles concurrently.
Command
set sc=$$run^pButtons()
set sc=$$Collect^pButtons()
Description
Starts the specified profile. If successful, returns the
; if unsuccessful, returns 0.
Produces a readable HTML performance report file for
the specified ; if is not specified,
generates a error. If successful, returns
1; if unsuccessful, returns 0 followed by a carat and
the reason for the failure.
8.2 Generating the ^pButtons Performance Reports
The Collect^pButtons command is an entry point that lets you generate a readable HTML performance report from the
log files produced by the ^pButtons utility. The report encapsulates the log files in the output directory into an HTML file.
The generated report file is located in the output directory which, by default, is the manager's directory of the Caché instance
(install-dir\mgr). The files are uniquely identified by names, which are in the following format:
68 Caché Monitoring Guide