Caché Monitoring Guide - InterSystems Documentation

Customizing the ^pButtons Utility
set rc=$$addprofile^pButtons("2minrun","A 2-minute run sampling every 10 seconds",10,12)
The next time you run the ^pButtons utility, the list of profiles includes the following profile name and description:
2minrun
A 2-minute run sampling every 10 seconds
Generate Profile
Alternatively, you can quickly generate new profiles (with a meaningful name and description) with the following API
command:
set rc=$$genprofile^pButtons([,])
where ( * ), which is required, must be in the format "hh:mm", "hh:", or mm; and ,
which is optional, is the frequency with which to run each sample.
Note:
The maximum is 24 hours (86400 seconds); if you specify a longer duration, ^pButtons reduces it
to 24 hours. The must be double-quoted only if it contains a colon (:); the colon denotes hours.
The minimum , if specified, is 2 seconds, unless the duration (that is, * ) is less
than one hour, in which case the minimum is 1 second). If you specify an invalid , ^pButtons
increases it to the required minimum. If the is not specified, it defaults to 10 seconds.
For example, to generate a profile named 12hours (with a generated profile name and description) that runs samples every
5 minutes (300 seconds) over 12 hours, enter the following:
set rc=$$genprofile^pButtons("12:",300)
In addition, to generate a profile named 90mins that runs samples every 10 seconds for 90 minutes, enter the following:
set rc=$$genprofile^pButtons(90)
The next time you run the ^pButtons utility, the list of profiles includes the following profile names and descriptions:
12hours
90mins
A 12 hour run sampling every 300 seconds
A 90 minute run sampling every 10 seconds
8.4.3.2 Edit Profiles
You can edit an existing profile (except for the pre-defined “test” profile) with the following API command:
set rc=$$editprofile^pButtons(,,[],[])
where , which is required, must be unique and cannot contain spaces or white-noise characters; ,
which is required, should be meaningful because it displayed in the menu when you run the ^pButtons utility; ,
which is optional, is the time to run each sample, in seconds (in the range of 2 seconds to 300 seconds); and ,
which is optional, is the number of times to run the profile.
Note:
The arguments are positional; if, for example, to edit the argument (and keep the value specified in the
argument), you must include the comma separator, as follows: set
rc=$$editprofile^pButtons("2minrun","A 5-minute run sampling every 30
seconds",,50).
If the duration exceeds 24 hours (86400 seconds), it is automatically reduced to 24 hours.
For example, to modify the 2minrun profile to run a sampling every 30 seconds until it runs 10 samplings (for a total of 300
seconds, or five minutes), enter the following:
set rc=$$editprofile^pButtons("2minrun","A 5-minute run sampling every 30 seconds",30,10)
The next time you run the ^pButtons utility, the list of profiles includes the following profile name and description:
Caché Monitoring Guide 73