Logging options:

This is list of options for logging

These options are inside given virtual database configuration file. For example: postgresTest-vdb_1.conf. The filename depends on the name of the vdb → nameOfVdb.conf.

⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!

Key	Requirements	Conf File field	Description	Possible values	Default
Log Connections	-	logConnections	to log when a JDBC or TCP connection is established by the calling application	Boolean	false
Log All SQL	-	logSql	equivalent to enabling a LOG policy with a .* wildcard. If this is enabled, it will override any log rate control configured on a log policy.	Boolean	false
Log All Portal Sessions SQL	-	logPortalSql	Logs all SQL queries performed via Portal Sessions to heimdallaudit.heimdall_users_activity_audit_trail. If this is enabled, it will override any log rate control configured on a log policy. Available only if Portal Mode is enabled.	Boolean	false
Exclude parameters	Log All Portal Sessions SQL	excludePortalSqlParams	Exclude parameters from Portal Session SQL queries, e.g. 'INSERT INTO table VALUES (?, ?)'.	Boolean	false
AWS CloudWatch Logging	AWS	cloudLogging	If in AWS, and selected, then logs generated by VDB instance will be periodically sent to the CloudWatch as a log stream.	Boolean	false
AWS CloudWatch Metrics	AWS	cloudMetrics	If in AWS, and selected, then multiple metric points will be generated under the Heimdall category for the VDB and AWS instance to allow monitoring of the access layer performance. Note, these metrics are generated on a per-minute basis, so may add to the cost of CloudWatch. Additionally, console logs will be shipped to CloudWatch as well when selected.	Boolean	false
AWS Logs Namespace	AWS	logsNamespace	If in AWS, a name provided as that field will be used as a log group name AND metrics namespace in CloudWatch.	Boolean	false
Aggregate Console Logs	-	shipConsoleLogs	In order to simplify debugging, this option allows console logs from the access layers to be sent to the central manager for logging. When using the "Local proxy" option, this option will be implicitly configured for the management server managed proxy instance, even if not set for other proxies.	Boolean	false
Write Logs to Files	-	writeLogsToFile	When performing SQL logging, the logs are by default written to an internal database for optimal Analytics speed. If the logs should also be written to detailed CSV logs for each query, please select this option. This may result in a large amount of data written to the log directory, although logs will automatically be cleaned up when that filesystem reached 90% full.	Boolean	false
Log Authentications	-	logAuthentications	Each authentication attempt will be logged. We will get information about whether authentication succeeded for a given user with the currently selected authentication mode. You can read more about authentication here Theory->Proxy Authentication.	Boolean	false