User and Permission Audit

audit_login_logout

Parameter description: Specifies whether to audit users' login (including login success and failure) and logout.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: an integer ranging from 0 to 7.

• 0 indicates that the function of auditing users' logins and logouts is disabled.
• 1 indicates that only successful user logins are audited.
• 2 indicates that only failed user logins are audited.
• 3 indicates that successful and failed user logins are audited.
• 4 indicates that only user logouts are audited.
• 5 indicates that successful user logouts and logins are audited.
• 6 indicates that failed user logouts and logins are audited.
• 7 indicates that successful user logins, failed user logins, and logouts are audited.

Default value: 7

audit_database_process

Parameter description: Specifies whether to audit the database startup, stop, switchover, and recovery.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: an integer, 0 or 1.

• 0 indicates that the function of auditing database startup, stop, switchover, and recovery is disabled.
• 1 indicates that the function of auditing database startup, stop, switchover, and recovery is enabled.

Default value: 1

When the database is started, the standby DN is promoted to primary. Therefore, the DN type in the audit log is system_switch when the DN is started.

audit_user_locked

Parameter description: Specifies whether to audit the users' locking and unlocking.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: an integer, 0 or 1.

• 0 indicates that the function of auditing user's locking and unlocking is disabled.
• 1 indicates that the function of auditing user's locking and unlocking is enabled.

Default value: 1

audit_user_violation

Parameter description: Specifies whether to audit the access violation operations of a user.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: an integer, 0 or 1.

• 0 indicates that the function of auditing the access violation operations of a user is disabled.
• 1 indicates that the function of auditing the access violation operations of a user is enabled.

Default value: 0

audit_grant_revoke

Parameter description: Specifies whether to audit the granting and revoking of user permissions.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: an integer, 0 or 1.

• 0 indicates that the function of auditing the granting and recycling of a user's permission is disabled.
• 1 indicates that the function of auditing the granting and recycling of a user's permission is enabled.

Default value: 1

audit_security_label

Parameter description: Specifies whether to audit the creation, deletion, and application of user security labels.

Parameter type: integer.

Unit: none

Value range: 0 or 1

• 0 indicates that the creation, deletion, and application of user security labels are not audited.
• 1 indicates that the creation, deletion, and application of user security labels are audited.

Default value: 0

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value. If this parameter is enabled, the system performance may be affected.

audit_internal_event

Parameter description: Specifies whether to audit the connections and operations of internal tools CM Agent, gs_clean, and WDRXdb.

Parameter type: Boolean.

Unit: none

Value range:

• off: The login, logout, and operations of internal tools CM Agent, gs_clean, and WDRXdb are not audited.
• on: The login, logout, and operations of internal tools CM Agent, gs_clean, and WDRXdb are audited.

Default value: off

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value.

Internal tools on the database server also generate audit logs. By default, audit_internal_event is disabled to reduce space occupied by audit logs and improve audit log query performance.

full_audit_users

Parameter description: Specifies the full audit user list. Audit logs are recorded for all auditable operations performed by users in the list.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. Use commas (,) to separate multiple usernames.

Default value: an empty string.

no_audit_client

Parameter description: Specifies the names and IP addresses of clients that do not need to be audited. The parameter format is client name@IP address, which is the same as that of the client_conninfo column in the pg_query_audit function, for example, cm_agent@127.0.0.1 or gs_clean@127.0.0.1.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. Use commas (,) to separate multiple configuration items.

Default value: an empty string.

• If the executed SQL statement meets the configuration requirements of full_audit_users and no_audit_client, the no_audit_client is preferentially configured and no audit logs are recorded.
• Audit logs are generated for communication among tools or nodes in the database server. To save space occupied by audit logs and improve the query performance of audit logs, you can configure the no_audit_client parameter not to audit the low-risk scenarios.