Diagnostics database configuration properties
- Last Updated: January 16, 2024
- 1 minute read
- OpenEdge
- Version 12.8
- Documentation
| Property | Description |
|---|---|
| Diagnostic directory (-diagDir) | Specifies the directory where the subdirectories for
each diagnostic event are created and the diagnostic tracking log file is written. This is a fully-qualified directory specification. The directory
name can be a maximum of 255 bytes. If you do not specify a directory with Though you can specify an absolute path or a relative path, the property validates only an absolute path. It skips the validation of relative path. |
| Diagnostic events value (-diagEvent) | Specifies the database events for collecting
diagnostic data. This is a character string of comma-separated keywords specifying triggering events and levels. |
| Diagnostic event level (-diagEvtLevel) | Specifies the level of diagnostic data to collect. The minimum and maximum values (integer) are -15 and 15 respectively. |
| Diagnostic field separator (-diagFS) | Specifies the separator to use when writing
diagnostic data to a CSV-formatted file. The available options are:
comma, tab, semi-colon, and
pipe. If you need any options other than
the ones specified here, you can add them in |
| Diagnostic data format (-diagFormat) | Specifies the format of the diagnostic data files. The available formats are CSV and JSON. |
| Diagnostic pause length (-diagPause) | Specifies the number of seconds to pause after
recording data for a diagnostic event and before processing the event. The minimum and maximum values are 0 and 1920 (30 minutes) respectively. |
| Diagnostic prefix value (-diagPrefix) | Specifies a common prefix to standard diagnostic data
files. This is a string of printable ASCII characters that can be used to prefix standard diagnostic data files. The prefix can be a maximum of 16 bytes. The fully-specified file name cannot exceed 300 bytes, which includes the specification of diagnostic directory, event sub-directory, and the data file. For example, prefixlocktable_summary.csv. |
| Omit log messages (-omitLgMsgs) | Specifies the messages you do not want written to the
database log file. You can specify up to 16 message numbers in a comma-separated list, with no embedded spaces in the list. The message omission list is on a per database basis, and only applies to messages being written to the database .lg file. Messages written to the screen are not suppressed. The values specified at startup are available via the _DbParams VST. The values can be read and updated. |
| Log file truncate time (-lgTruncateTime) | Specifies a time to truncate the log file in HH:MM format. You must specify both |
| Log file truncate frequency (-lgTruncateFrequency) | Specifies how often to truncate your log file. You
must specify both |
| Log file truncate size (-lgTruncateSize) | Specifies a size, in MB, for truncating the log file. The default value is 0. |
| Log file archive enable (-lgArchiveEnable) | Specifies whether the database log file should be
archived before it is truncated. If the archive file can not be created for any reason, the log file is not truncated. This ensures that no log file entries are lost. |
| Log file archive directory (-lgArchiveDir) | Specifies a directory for the archived log
file. The maximum size of a fully-qualified directory specification is 255 characters. |
| Limit log file payload (-limitLgPayload) | Prevents message payload from being written to the
database log file. Message payload is defined as the user name, tty name, IP address,
and connection hostname in a message. Specify if payload is included or omitted.
All messages written to the database log file (dbname.lg), and messages that are written to both the log file and the screen, honor the -limitLgPayload setting. Messages only written to the screen, do not check the payload setting. Other log files, such as for SQL or Replication, honor the payload setting when the information written to the log file is obtained from the database connection information. |