Audit setup

Infrastructure prerequisites

The Audit service requires the following components to be set up before it can be started:

Docker engine
Kafka
Elasticsearch

Dependencies

The Audit service is built as a Docker image and runs on top of Kafka and Elasticsearch. Therefore, these services must be set up and running before starting the Audit service.

Configuration

Configuring Kafka

To configure the Kafka server for the Audit service, set the following environment variables:

Connection settings

Variable	Description	Example Value
`SPRING_KAFKA_BOOTSTRAPSERVERS`	Address of the Kafka server(s)	`localhost:9092`
`SPRING_KAFKA_SECURITYPROTOCOL`	Protocol used to communicate with brokers	`PLAINTEXT`

Consumer configuration

Variable	Description	Example Value
`SPRING_KAFKA_CONSUMER_GROUPID`	Consumer group ID for audit logs	`audit-gid`
`SPRING_KAFKA_CONSUMER_PROPERTIES_MAX_PARTITION_FETCH_BYTES`	Maximum data size per partition	`${KAFKA_MESSAGE_MAX_BYTES:52428800}`
`KAFKA_CONSUMER_THREADS`	Number of consumer threads	`1`
`KAFKA_AUTHEXCEPTIONRETRYINTERVAL`	Retry interval after auth failure (seconds)	`10`

Topic naming configuration

Variable	Description	Example Value
`DOT`	Reference to primary separator	`${kafka.topic.naming.separator}`
`DASH`	Reference to secondary separator	`${kafka.topic.naming.separator2}`
`KAFKA_TOPIC_NAMING_SEPARATOR`	Primary separator for topic names	`.`
`KAFKA_TOPIC_NAMING_SEPARATOR2`	Secondary separator for topic names	`-`
`KAFKA_TOPIC_NAMING_PACKAGE`	Base namespace for topics	`ai${dot}flowx${dot}`
`KAFKA_TOPIC_NAMING_ENVIRONMENT`	Environment indicator	`dev${dot}`
`KAFKA_TOPIC_NAMING_VERSION`	Version component	`${dot}v1`
`KAFKA_TOPIC_NAMING_PREFIX`	Combined prefix	`${kafka.topic.naming.package}${kafka.topic.naming.environment}`
`KAFKA_TOPIC_NAMING_SUFFIX`	Combined suffix	`${kafka.topic.naming.version}`
`KAFKA_TOPIC_AUDIT_IN`	Topic for receiving audit logs	`${kafka.topic.naming.prefix}core${dot}trigger${dot}save${dot}audit${kafka.topic.naming.suffix}`

With default settings, the KAFKA_TOPIC_AUDIT_IN resolves to: ai.flowx.dev.core.trigger.save.audit.v1

Configuring Elasticsearch

Configure Elasticsearch connection for audit data storage:

Variable	Description	Default Value	Example
`SPRING_ELASTICSEARCH_REST_PROTOCOL`	Connection protocol	`https`	`https`
`SPRING_ELASTICSEARCH_REST_URIS`	URL(s) of Elasticsearch nodes (no protocol)	-	`elasticsearch:9200`
`SPRING_ELASTICSEARCH_REST_DISABLESSL`	Disable SSL verification	`false`	`false`
`SPRING_ELASTICSEARCH_REST_USERNAME`	Authentication username	-	`elastic`
`SPRING_ELASTICSEARCH_REST_PASSWORD`	Authentication password	-	`your-secure-password`
`SPRING_ELASTICSEARCH_INDEXSETTINGS_DATASTREAM`	Audit data stream name	`audit-logs`	`audit-logs`
`SPRING_ELASTICSEARCH_INDEXSETTINGS_SHARDS`	Number of primary shards	`2`	`2`
`SPRING_ELASTICSEARCH_INDEXSETTINGS_REPLICAS`	Number of replica shards	`2`	`2`

The Elasticsearch index settings determine how your audit data is distributed and replicated across the cluster. The number of shards affects search performance and indexing, while replicas provide redundancy.

Configuring logging

To control the log levels, set the following environment variables:

Variable	Description	Example Value
`LOGGING_LEVEL_ROOT`	Log level for root service	`INFO`
`LOGGING_LEVEL_APP`	Log level for application	`INFO`

Microservices

Plugins

Observability

Microservices access rights

Plugins access rights

Audit setup

Infrastructure prerequisites

Dependencies

Configuration

Configuring Kafka

Connection settings

Consumer configuration

Topic naming configuration

Configuring Elasticsearch

Configuring logging

​Infrastructure prerequisites

​Dependencies

​Configuration

​Configuring Kafka

​Connection settings

​Consumer configuration

​Topic naming configuration

​Configuring Elasticsearch

​Configuring logging

Infrastructure prerequisites

Dependencies

Configuration

Configuring Kafka

Connection settings

Consumer configuration

Topic naming configuration

Configuring Elasticsearch

Configuring logging