Limit log file payload (-limitLgPayload)
- Last Updated: January 16, 2024
- 2 minute read
- OpenEdge
- Version 12.8
- Documentation
Use Limit log file payload (-limitLgPayload) to prevent message payload from being written to the
client or database log file. Message payload is
defined as the user name, device, tty name, IP address, and connection hostname in a
message.
| Operating system and syntax | UNIX / Windows |
|
||
|---|---|---|---|---|
| Use with | Maximum value | Minimum value | Single-user default | Multi-user default |
| Database Server, Client Session | 1 | 0 | 0 | 0 |
- n
- Specify if payload is included or omitted.
- 0 — Limit payload is off; the complete contents of messages is written to the client or database log file.
- 1 — Limit payload is on;
payload data within a message is not written to the client or
database log file, and is replaced with the string, "
<omitted>".
If limit log file payload (-limitLgPayload) is turned on,
the lock wait timeout error message in a client log is affected, such that the
username and device are omitted. The following example displays the difference in
messages written to the client log file when -limitLgPayload is enabled and disabled.
| Error | Limit payload enabled | Limit payload disabled |
|---|---|---|
| Lock wait timeout |
|
|
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.
The following examples displays the difference in messages written
to the database log file when -limitLgPayload is
enabled and disabled.
| Command or action | Limit payload enabled | Limit payload disabled |
|---|---|---|
| Server startup |
|
|
| Login |
|
|
| Logout |
|
|
| Remote login |
|
|
The value specified at startup is available via the _DbParams VST. The values can be read and updated.
- To view the current setting, select from the Promon Main Menu,
- To change the current setting, select from the Server Options menu, 9 (Limit .lg message payload). The value is toggled between Enabled and Disabled.
To change this parameter while the database is running, use PROMON or the _DbParams VST.
You can use this parameter to support continuous operation of the database. For more information, see Change database parameters while the database is running.