Start Performance Collection (STRPFRCOL)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Start Performance Collection (STRPFRCOL) command starts the system-level collection of performance data by Collection Services. The properties of the system-level collection are controlled by the Collection Services configuration, which can be changed using the Configure Performance Collection (CFGPFRCOL) command. The data included in the system-level collection is determined by the value specified on the Collection profile parameter.
Performance data collection is conducted by the Collection Services server job (QYPSPFRCOL). If this job is not active, it will be started as a result of this command. If the job is active, any change to the collection profile will take effect immediately and the collection will continue uninterrupted.
QYPSPFRCOL creates a management collection object (*MGTCOL) to store performance data. Data collected will include both the system-level collection profile categories as well as data collected on behalf of client applications (for example, IBM System i Navigator monitors or Performance Collector APIs). All data is stored in the current management collection object. This data may be processed using the Create Performance Data (CRTPFRDTA) command to generate the performance database files.
Cycling the performance collection will cause the Collection Services server job to create a new management collection object prior to implementing the specified Collection profile. Note: cycling may result in the loss of one interval of data and will also impact any client applications that are using Collection Services.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| COLPRF | Collection profile | *CFG, *MINIMUM, *STANDARD, *STANDARDP, *ENHCPCPLN, *CUSTOM | Optional, Positional 1 |
| CYCCOL | Cycle collection | *NO, *YES | Optional, Positional 2 |
| Top |
Default collection profile (COLPRF)
Specifies the collection profile. This will determine which categories will be included in the system-level collection. Specifying a profile for this parameter will change the default collection profile in the Collection Services configuration. The default collection profile may also be changed using the Configure Performance Collection (CFGPFRCOL) command.
- *CFG
- The collection will use the currently configured value. If the configured value has never been modified, the collection profile will be *STANDARDP.
- *MINIMUM
- The minimum data collection recommended. Includes the following categories: *SYSBUS, *POOL, *HDWCFG, *SYSCPU, *SYSLVL, *JOBMI, *JOBOS, and *DISK.
- *STANDARD
- The standard profile includes all categories which are typically needed by the IBM Performance Tools for i, with the exception of communications data. It includes all categories in the *MINIMUM profile, as well as the following categories: *POOLTUNE, *SUBSYSTEM, *SNADS, *LCLRSP, *APPN, *SNA, *TCPBASE, *USRTNS, *LPAR, *EXTSTG, *SYSINT, *RMVSTG, and *SQL. The category *DOMINO will be included if the product IBM Domino for i has been installed on the system. The category *HTTP will be included if the product IBM HTTP Server for i (powered by Apache) has been installed on the system.
- *STANDARDP
- The standard plus profile includes all categories which are typically needed by the IBM Performance Tools for i, including communications data. It includes all categories in the *STANDARD profile, as well as the following categories: *IPCS, *CMNBASE, *CMNSTN, *CMNSAP, *TCPIFC, and *DPS.
- *ENHCPCPLN
- The enhanced capacity planner profile includes all categories in the *STANDARDP profile, with the addition of *INTPEX.
- *CUSTOM
- The custom profile includes categories as defined by the user. This profile must be defined using the Configure Collection Services task within the IBM Navigator for i.
| Top |
Cycle collection (CYCCOL)
Specifies whether the collection should be cycled. Cycling the collection will cause data to be collected in a new management collection object (*MGTCOL).
- *NO
- Data will continue to be collected in the current collection object.
- *YES
- Data will be collected in a new collection object.
| Top |
Examples
Example 1: Starting the Performance Collection
STRPFRCOL
This command will cause the Collection Services server job (QYPSPFRCOL) to start the system-level collection of performance data using the currently configured default collection profile.
Example 2: Starting with Collection Profile and Cycle Collection
STRPFRCOL COLPRF(*MINIMUM) CYCCOL(*YES)
This command will cause the Collection Services server job (QYPSPFRCOL) to cycle and begin collecting performance data in a new management collection object (*MGTCOL) using the *MINIMUM collection profile. Note: this command will also change the configured default collection profile to *MINIMUM.
| Top |
Error messages
*ESCAPE Messages
- CPF3CF2
- Error(s) occurred during running of &1 API.
- CPFB94A
- Collector communications error. Reason code &1.
| Top |