3.2.16 Operands related to troubleshooting information

31) pd_cancel_dump = put | noput
This operand is designed to reduce the amount of troubleshooting information to be output.
Specifies whether troubleshooting information is to be collected in the following cases:
  • When SQL does not terminate within the monitoring time specified by the PDCWAITTIME operand in the client environment definition
  • When a UAP being executed is canceled by the pdcancel command
For details about the troubleshooting information to be collected, see the HiRDB Version 9 System Operation Guide and Table 3-2 Error information that is displayed in the event of abnormal termination in the section on the pd_dump_suppress_watch_time operand.
put:
Troubleshooting information is collected. Because the troubleshooting information is output to files under $PDDIR/spool, a space shortage might occur in the file system.
Note that the troubleshooting information that has been collected is automatically deleted by HiRDB at the following timings.
  • Every 24 hours while HiRDB is running (the deletion interval can be changed using the pd_spool_cleanup_interval operand).
  • When HiRDB is started (whether to delete the troubleshooting information can be changed using the pd_spool_cleanup operand).
For the HiRDB administrator to delete troubleshooting information, the administrator must execute the pdcspool command.
noput:
Do not collect troubleshooting information. Because no troubleshooting information will be collected, the load on the file system is reduced. Specify this option if UAP cancellation occurs frequently during normal operation and there is no need to investigate the causes.
Troubleshooting information might be acquired even though noput is specified in this operand. For details, see Table 3-2 Error information that is displayed in the event of abnormal termination in the section on the pd_dump_suppress_watch_time operand.
For details about error information that is output in the event of abnormal termination, see Table 3-2 Error information that is displayed in the event of abnormal termination in the section on the pd_dump_suppress_watch_time operand.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is put.
Notes
If a UAP is canceled by the pdcancel command with the -d option specified, troubleshooting information is collected regardless of the option specified for this operand.
32) pd_dump_suppress_watch_time = troubleshooting-information-output-suppression-time
~<unsigned integer>((0-3600)) (seconds)
This operand is designed to reduce the amount of troubleshooting information to be output.
This operand specifies the amount of time (in seconds) during which to suppress outputting again the troubleshooting information (files under $PDDIR/spool) that is output when any of the following situations occurs.
  • The time specified in PDCWAITTIME is exceeded.
  • The UAP being executed is cancelled by the pdcancel command (except when the -d option is specified).
  • A process terminates abnormally.
Once troubleshooting information is output, no troubleshooting information is output again until the time specified by this operand has elapsed. For example, if 60 is specified for this operand, no troubleshooting information is output again until 60 seconds have passed because troubleshooting information was previously output.
Note that if 0 is specified for this operand, outputting of troubleshooting information is not suppressed.
Advantage
When there are multiple HiRDB server processes, timing out, for example, might cause them to terminate abnormally one after the other. If abnormal terminations of server processes occur successively, troubleshooting information, such as core files and simple dumps, are repeatedly collected, thus causing a space shortage on the disk on which the HiRDB directory is located. If such a shortage occurs, HiRDB might terminate abnormally. Therefore, specify this operand to make sure that no disk space shortage occurs.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is 0.
Notes
  • When the -d option is specified for the pdcancel command, if abnormal termination is caused by an internal conflict, or if a signal is received from outside, troubleshooting information is collected regardless of the value specified for this operand.
  • Table 3-1 lists the error information that is displayed in the event of abnormal termination.

    Table 3-2 Error information that is displayed in the event of abnormal termination

    Cause of abnormal terminationError informationpd_dump_suppress_watch_time value
    0Not 0
    pd_cancel_dump value
    putnoputputnoput
    PDSWAITTIME exceededSave core fileNNNN
    Snapshot of errorNNNN
    Simple dump fileNNNN
    KFPA20009-W messageNNNN
    SQL runtime warning information fileNNNN
    PDSWATCHTIME exceededSave core fileNNNN
    Snapshot of errorNNNN
    Simple dump fileNNNN
    KFPA20009-W messageNNNN
    SQL runtime warning information fileNNNN
    PDCWAITTIME exceededpd_client_waittime
    _over_abort = Y
    Save core fileYYY+Y+
    Snapshot of errorYYY+Y+
    Snapshot 2 of errorYYY+Y+
    Simple dump fileYYY+Y+
    KFPA20009-W messageYYY+Y+
    SQL runtime warning information fileYYY+Y+
    Shared memory dump fileFFFF
    pd_client_waittime
    _over_abort = N
    Save core fileNNNN
    Snapshot of errorYNY+N
    Snapshot 2 of errorNNNN
    Simple dump fileYNY+N
    KFPA20009-W messageYNY+N
    SQL runtime warning information fileYNY+N
    Shared memory dump fileNNNN
    pdcancel command
    (-d option specified)
    Save core fileYYYY
    Snapshot of errorYYYY
    Simple dump fileYYYY
    KFPA20009-W messageYYYY
    SQL runtime warning information fileYYYY
    pdcancel command
    (-d option not specified)
    Save core fileNNNN
    Snapshot of errorYNY+N
    Simple dump fileYNY+N
    KFPA20009-W messageYNY+N
    SQL runtime warning information fileYNY+N
    Internal kill9#1Save core fileNNNN
    Snapshot of errorYNY+N
    Simple dump fileYNY+N
    KFPA20009-W messageYNY+N
    SQL runtime warning information fileYNY+N
    Internal kill3#2Save core fileYYY+Y+
    Snapshot of errorYYY+Y+
    Simple dump fileYYY+Y+
    KFPA20009-W messageYYY+Y+
    SQL runtime warning information fileYYY+Y+
    Abort#3Save core fileYYY+Y+
    Snapshot of errorYYY+Y+
    Simple dump fileYYY+Y+
    KFPA20009-W messageYYY+Y+
    SQL runtime warning information fileYYY+Y+
    Abort information fileYYY+Y+
    Other#4Save core fileDDDD
    Snapshot of errorYYYY
    Simple dump fileDDDD
    KFPA20009-W messageDDDD
    SQL runtime warning information fileDDDD
Legend:
Y: Outputs error information. The specification of the pd_dump_suppress_watch_time operand is invalid.
N: Does not output error information.
Y+: Outputs error information. The specification of the pd_dump_suppress_watch_time operand is valid.
D: Error information might not be output depending on how the process is terminated.
F: After the unit is started, error information is output during the first dump. The units that output shared memory dumps can be restricted by specifying shm_fesonly in the pd_clt_waittime_over_dump_level operand.
#1
This refers to SIGKILL being issued internally, as occurs when a UAP is abnormally terminated by OpenTP1. It does not include abnormal termination due to exceeding the PDCWAITTIME value or due to issuance of the pdcancel command.
#2
This refers to SIGQUIT being issued internally, as occurs when an abnormality is detected. It does not include abnormal termination due to exceeding the PDCWAITTIME value or due to issuance of the pdcancel command.
#3
This refers to HiRDB detecting an inconsistency and calling abort().
#4
This refers to an unforeseen error, such as SIGSEGV, SIGBUS, receiving an external signal, or exit.
33) pd_spool_cleanup_interval = troubleshooting-information-deletion-interval
~<unsigned integer>((0-744)) (times)
This operand is used for deleting the troubleshooting information and temporary work files that have been output. If these items are not deleted, they might cause a space shortage on the disk on which the HiRDB directory is located. If such a shortage occurs, HiRDB might terminate abnormally. Therefore, HiRDB regularly deletes the following files:
  • Troubleshooting information file (files in $PDDIR/spool)
  • Temporary work files (files in $PDDIR/tmp)
This operand specifies the deletion interval (hours). For example, if 48 is specified for this operand, these files are deleted every 48 hours. Normally, (if this operand is omitted) files are deleted every 24 hours.
Note that time counting begins when HiRDB is normally started. When HiRDB is normally terminated, time counting also stops. Then, the count returns to 0 during the next normal startup.
Specify the files to be deleted using the pd_spool_cleanup_interval_level operand explained as follows.
Operand rule
If 0 is specified, files are not deleted.
Specification guidelines
If 24, 48, 72, and so on are specified for this operand, files are deleted at the predetermined time. Specify the time so that files are deleted during the time period that does not overload the system.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is 24.
Notes
Even while HiRDB is stopped because of planned termination, forced termination, or abnormal termination, time counting continues. However, if the deletion time arrives while HiRDB is stopped, files are not deleted. Files are not deleted until the next deletion time. To restart HiRDB after deleting the files, execute the pdcspool command.
Remarks
The difference between the pd_spool_cleanup_interval and pd_spool_cleanup operands is as follows:
  • The pd_spool_cleanup_interval operand is related to regular deletion of troubleshooting information.
  • The pd_spool_cleanup operand is related to the deletion of troubleshooting information during HiRDB startup.
Therefore, if you plan to run HiRDB continuously for 24 hours, consider specifying the pd_spool_cleanup_interval operand. If you plan to terminate HiRDB every day, consider specifying the pd_spool_cleanup operand.
34) pd_spool_cleanup_interval_level = number-of-days [, deletion-type]
This operand is used for deleting the troubleshooting information and temporary work files that have been output, and specifies the condition for regularly deleting the troubleshooting information and temporary work files.
number-of-days: ~<unsigned integer>((1-24855)) (days)
Troubleshooting information files that are older than the number of days specified here are deleted. For example, if 3 is specified, all troubleshooting information files, except for those created within the last 3 days (or 3 days [Figure] 24 hours = 72 hours), are deleted.
deletion-type: <character string>
Specifies the type of troubleshooting information file to be deleted.
all: All files are to be deleted.
dump: Only the files internally acquired by HiRDB are to be deleted.
The following are the types of troubleshooting information files that are deleted.
Troubleshooting information file typeDirectory namealldumpRemarks
Deadlock and timeout informationpdlckinfYNOutput when an error occurs during locking.
Access path informationpdsqldumpYNOutput when the access path display utility is used.
Save core filesaveYYOutput when a process is abnormally terminated.
Shared memory dump filepdshmdumpYYOutput when a process or unit is abnormally terminated.
Simple dump filepdsysdumpYYNone
pdsdsdumpYYNonexistent in a HiRDB parallel server configuration
pdfesdump
pddicdump
pdbesdump
YYNonexistent in a HiRDB single server configuration
System log file status information filepdjnlinfYNFiles under /pdjnlinf/errinf are not deleted.
Transaction information filepdtrninfYNOutput when Real Time SAN Replication is used.
Y: File is deleted.
N: File is not deleted.
Note: Directory names under $PDDIR/spool are shown.
All temporary work files, except for those listed as follows, are deleted regardless of the deletion type specification. Parentheses indicate directory names under $PDDIR/tmp.
  • Current working directory (home) of the process in which HiRDB is to start
  • Shared memory information file (pdommenv)
  • Differential information files of the pdbufls command (files with names that begin with CMb)
Condition
A value other than 0 must be specified for the pd_spool_cleanup_interval operand.
Specification guidelines
  • Specify a value that is longer than the execution time of commands (including utilities). For example, if the execution of the pdcopy command, which collects backup data, requires 24 hours (1 day), specify at least 2 for the number of days. If you do not specify a value that is longer than the execution time of the command, the temporary work files being used by the command are deleted, and thus the command might not run correctly.
  • If the specified value is too large, disk space might fill up; if the specified value is too small, information files needed for troubleshooting might be deleted.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the following values are assumed:
  • number-of-days: 7
  • deletion-type: all
Operand rule
If you specify a deletion type, you must also specify a number of days.
Note
If the TMPDIR environment variable is specified but the pd_tmp_directory operand is not specified, temporary work files used by commands and utilities will be output to the directory specified in the TMPDIR environment variable. Because temporary work files output to this directory are not subject to regular deletion, use the OS's rm command to delete them.
Remarks
The difference between the pd_spool_cleanup_interval_level and pd_spool_cleanup_level operands is as follows:
  • The pd_spool_cleanup_interval_level operand is related to regular deletion of troubleshooting information.
  • The pd_spool_cleanup_level operand is related to the deletion of troubleshooting information during HiRDB startup.
Therefore, if you plan to run HiRDB continuously for 24 hours, consider specifying the pd_spool_cleanup_interval_level operand. If you plan to terminate HiRDB every day, consider specifying the pd_spool_cleanup_level operand.
35) pd_spool_cleanup = normal | force | no
This operand is used for deleting the troubleshooting information that has been output.
Specifies whether troubleshooting information files (files under $PDDIR/spool) that were output previously by HiRDB are to be deleted when HiRDB is started. This operand is related to the pd_spool_cleanup_level operand, described as follows.
normal:
Delete the files when HiRDB is started normally or is restarted following a planned termination.
force:
Delete the files whenever HiRDB is started, regardless of the HiRDB activation mode.
no:
Do not delete the files.
Specification guidelines
If troubleshooting information files take up too much disk space, specify normal or force.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is force.
Note
Troubleshooting information that is output by a command or utility executed by a user other than the HiRDB administrator might not be deleted. In this case, a user who is authorized to delete troubleshooting information files will have to use the OS's rm command to delete the files.
Remarks
The difference between the pd_spool_cleanup_interval and pd_spool_cleanup operands is as follows:
  • The pd_spool_cleanup_interval operand is related to regular deletion of troubleshooting information.
  • The pd_spool_cleanup operand is related to the deletion of troubleshooting information during HiRDB startup.
Therefore, if you plan to run HiRDB continuously for 24 hours, consider specifying the pd_spool_cleanup_interval operand. If you plan to terminate HiRDB every day, consider specifying the pd_spool_cleanup operand.
36) pd_spool_cleanup_level = number-of-days [, deletion-type]
This operand is used for deleting the troubleshooting information that has been output, and specifies the condition for deleting the troubleshooting information files during HiRDB startup.
number-of-days: ~<unsigned integer>((0-24855)) (days)
Specifies a number of days when troubleshooting information that is older than the specified number of days is to be deleted. For example, if 3 is specified, all troubleshooting information will be deleted except for the information that is fewer than 3 days old (3 days [Figure] 24 hours = 72 hours).
If 0 is specified, all troubleshooting information files are deleted.
deletion-type: <character string>
Specifies the type of troubleshooting information to be deleted.
all: Delete all file types.
dump: Delete only files collected internally by HiRDB.
The following are the types of troubleshooting information files that are deleted:
Troubleshooting information file typeDirectory namealldumpRemarks
Deadlock and timeout informationpdlckinfYNOutput when an error occurs during locking.
Access path informationpdsqldumpYNOutput when the access path display utility is used.
Save core filesaveYYOutput when a process is abnormally terminated.
Shared memory dump filepdshmdumpYYOutput when a process or unit is abnormally terminated.
Simple dump filepdsysdumpYYNone
pdsdsdumpYYNonexistent in a HiRDB parallel server configuration
pdfesdump
pddicdump
pdbesdump
YYNonexistent in a HiRDB single server configuration
System log file status information filepdjnlinfYNFiles under /pdjnlinf/errinf are not deleted.
Transaction information filepdtrninfYNOutput when Real Time SAN Replication is used.
Y: File is deleted.
N: File is not deleted.
Note: Directory names under $PDDIR/spool are shown.
Condition
normal or force (default value) must be specified for the pd_spool_cleanup operand.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the following values are assumed:
  • number-of-days: 7
  • deletion-type: all
Operand rule
A number of days and a deletion type must both be specified.
Remarks
The difference between the pd_spool_cleanup_interval_level and pd_spool_cleanup_level operands is as follows:
  • The pd_spool_cleanup_interval_level operand is related to regular deletion of troubleshooting information.
  • The pd_spool_cleanup_level operand is related to the deletion of troubleshooting information during HiRDB startup.
Therefore, if you plan to run HiRDB continuously for 24 hours, consider specifying the pd_spool_cleanup_interval_level operand. If you plan to terminate HiRDB every day, consider specifying the pd_spool_cleanup_level operand.
37) pd_module_trace_max = maximum-number-of-module-traces-that-can-be-stored
~<unsigned integer>((126-16383))
A HiRDB process records the history of the executed functions and macros inside the process private memory. This history is called a module trace. This operand specifies the number of module trace records. The content of this history is loaded into the core file and is output when a process error occurs.
Specification guidelines
Normally, there is no need to specify this operand. If a maintenance engineer asks you to specify this operand for a performance check purpose or the like, follow the maintenance engineer's instructions.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is 126.
Note
Process private memory of the following size is allocated to each process:
In the 32-bit mode: 64 + 48 [Figure] pd_module_trace_max operand value (bytes)
In the 64-bit mode: 64 + 64 [Figure] pd_module_trace_max operand value (bytes)
38) pd_module_trace_timer_level = 0 | 10 | 20
Specifies how to acquire the time to be output in module traces. The following table explains the meaning of the value specified for this operand.
Specified valueTime acquisition method
0Time is output in seconds at every module trace output location.
10Time is output in microseconds only at performance-critical module trace output locations, such as those before and after input/output processing, and time is output in seconds at other locations.
20Time is output in microseconds at every module trace output location.
Specification guidelines
Normally, there is no need to specify this operand. If a maintenance engineer asks you to specify this operand for a performance check purpose or the like, follow the maintenance engineer's instructions.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is 0.
Note
If you specify a value other than 0 for this operand, a function for acquiring time in microseconds is issued, and as a result, system performance might decline.
39) pd_pth_trace_max = maximum-number-of-stored-communication-traces
~<unsigned integer> ((1024-8388608))
Specifies the maximum number of communication trace records to be used as troubleshooting information.
Specification guidelines
Normally, there is no need to specify this operand. If a maintenance engineer asks you to specify this operand for a reason such as performance checking, follow the maintenance engineer's instructions.
Operand default
When this operand is omitted, the specification of the same operand in the system common definition is assumed. When the same operand is also omitted in the system common definition, the default is 1024.
Notes
Increasing the value of this operand increases the process private memory secured by HiRDB processes.
Process private memory for communication traces is calculated based on this operand's value rounded up to the power of two. For details about memory requirements, see Calculation of required memory in the HiRDB Version 9 Installation and Design Guide.
Effects on individual estimation formulas
If the value of the pd_pth_trace_max operand is changed, the following estimation formulas are affected:
HiRDB Version 9 Installation and Design Guide:
  • Calculation of required memory under Estimating the memory size required for a HiRDB single server configuration
  • Calculation of required memory under Estimating the memory size required for a HiRDB parallel server configuration