Skip to main content

Audit Sink Configuration

Kadeck stores audit log entries in its internal database by default. For Enterprise environments, the audit log module can also be configured to publish audit events to an Apache Kafka topic.

Overview​

Audit logging behavior is controlled through environment variables.

By default, audit events are persisted in the Kadeck database. When Kafka-based audit logging is enabled, Kadeck additionally publishes audit events to a configured Apache Kafka topic.

Environment Variables​

xeotek_kadeck_audit_mode​

Defines where audit log entries are stored.

Default: DB Stores audit log entries in the Kadeck database.

Supported value: KAFKA Publishes audit log events to an Apache Kafka topic in addition to database storage.

Example:

xeotek_kadeck_audit_mode=KAFKA

xeotek_kadeck_audit_topic​

Specifies the Kafka topic used for audit log events when audit mode is set to KAFKA.

Default: _kadeck.audit

Example:

xeotek_kadeck_audit_topic=my_kadeck_audit_topic

xeotek_kadeck_audit_connection​

Specifies the ID of the configured Kafka connection that Kadeck should use for audit log publishing.

This setting is required when xeotek_kadeck_audit_mode=KAFKA.

Default: 0

Example:

xeotek_kadeck_audit_connection=1

Example Configuration​

xeotek_kadeck_audit_mode=KAFKA
xeotek_kadeck_audit_topic=my_kadeck_audit_topic
xeotek_kadeck_audit_connection=1

Notes​

  • If audit mode is not set, Kadeck stores audit log entries in its database.
  • Kafka-based audit publishing requires a valid Kafka connection configuration in Kadeck.
  • Ensure that the configured Kafka topic exists and that the selected connection has permission to publish to it.