The optional WRAP control statement defines the action to be taken by the C\Prof collection server when the CICS internal trace has wrapped during a recording session. This can occur if the size of your CICS internal trace is too small, or if there is a surge in activity in the CICS region and the C\Prof collection server can no longer keep up.
When wrapping occurs, user can instruct the C\Prof collection server to automatically retry the recording (default), or the server can be instructed to stop the recording completely.
These options are described below:
WRAP=(RETRY,wait,tolerance,period)
If the CICS internal trace has wrapped during a recording session, automatically attempt to restart the recording. This is the default behavior when WRAP is not specified in your C\Prof configuration file. To override the default behavior, supply the following values:
wait parameter
The amount of time, in seconds, that the C\Prof collection server will wait prior to attempting to restart the recording.
The value of wait must be a number in the range of 0 (no wait time - retry immediately) to 900 (15 minutes). Small wait times (such as zero) may result in additional wrapping if the surge in CICS activity has not yet cleared. Conversely, large wait times will result in longer periods where data is not being collected from the trace. By specifying a wait time of a few seconds, you may be giving CICS an opportunity to clear the activity that caused the surge in trace events.
The default value for wait is 1 (second).
tolerance and period parameters
The number of wrap conditions tolerated (tolerance) over a certain number of seconds (period) before no further retries will be attempted. If the number of wrap conditions that occur within a period exceeds the tolerance, the recording will end. The tolerance and period parameters mitigate against wrap conditions occurring too often, thus preventing meaningful collection.
The value of tolerance must be a number in the range 1 to 60. The default value of tolerance is 2.
The value of period must be a number in the range 1 (1 second) to 3600 (1 hour). The value of period must be greater than the value of wait * (tolerance + 1). This will ensure that the tolerance period will include at least some active trace collection. The default value of period is 60 (seconds).
Example 1
To retry all recordings that have stopped due to wrapping after 1 second, and to stop retrying if more than 2 wrap conditions occur in the space of 1 minutes (60 seconds) , use the following control statement:
WRAP=(RETRY,1,2,60)
Note: This is the default setting if WRAP is not specified.
Example 2
To retry all recordings that have stopped due to wrapping after 15 seconds, and to stop retrying if more than 5 wrap conditions occur in the space of 2 minutes (120 seconds), use the following control statement:
WRAP=(RETRY,15,5,120)
Note: In this example, if the worst occurs and 5 retries are attempted over a two minute period (120 seconds), it will result in a total pause in recording time of 75 seconds (5 retries * 15 seconds) and only 45 seconds of active recording time (75 second wait time + 45 seconds recording = 120 seconds).
WRAP=(ERROR)
When a wrap condition occurs, this option instructs the C\Prof collection server to stop recording the CICS internal trace on the affected region and to not attempt to restart the recording. When a wrap occurs, user's must manually restart the recording via the user interface.