Broadleaf Microservices
  • v1.0.0-latest-prod

Audit Services Configuration Properties

This document covers the miscellaneous configuration properties used by Audit Services.

Service-Level Properties

Name Description Default

broadleaf.audit.ingestion.*

Configuration controlling the behavior of ingestion of AuditEvent batches into the AuditServices bounded context. See javadoc for the AuditIngestionProperties class for more details.

broadleaf.audit.prune.*

Configuration controlling the behavior for pruning of AuditHeader and AuditDetail. This includes concepts such as retention period for entries. See javadoc for the AuditPruneProperties class for more details.

Client Properties

Name Description Default

broadleaf.audit.processing.*

Configuration related to the multithreaded processing of AuditEvent`s. See javadoc for the `AuditProcessingProperties class for more details.

broadleaf.audit.processing.storage.filesystem.*

Config related to the FileSystemStorageProvider. Assumes the target directories provided exist on a shared filesystem across the entire application cluster. This allows many microservices to contribute to audit recording with final ingestion into the audit service as the bounded context of audit data. See javadoc for the FileSystemStorageProviderProperties class for more details.

broadleaf.basic.audit.group

Enable or disable the AuditProcessingProperties#isEnabled() and FileSystemStorageProviderProperties#isEnabled() as a group.

false

Data Source Properties

Tip
 Most of the time, datasource related configuration is handled automatically by the Broadleaf starter architecture at runtime.

These properties are for configuring the datasource.

General Data Source

This exposes all of the Spring DataSourceProperties under broadleaf.audit.datasource. This is to allow the regular property structure to be restricted to a specific Broadleaf data route.

Liquibase

This exposes all of the Spring LiquibaseProperties under broadleaf.audit.liquibase. This is to allow the regular property structure to be restricted to a specific Broadleaf data route.

JPA

This exposes all of the Spring JpaProperties under broadleaf.audit.jpa in addition to the Spring HibernateProperties under broadleaf.audit.jpa.hibernate. This is to allow the regular property structure to be restricted to a specific Broadleaf data route.

Delegating Data Source

These are additional properties that define datasource configuration that employs SchemaDelegatingDataSource. This allows through configuration alone a setup that declares multiple datasources (each tied to a schema) backed by a common base datasource. This config is generally employed as part of a flex-package installation where multiple services run together in a single JVM.

Tip
 See the javadocs for SchemaDelegatingProperties.

  • broadleaf.audit.delegating.schema: The schema that borrowed connections should be initialized to in SchemaDelegatingDataSource.

  • broadleaf.audit.delegating.delegateRef: The back-reference to another section of configuration that fully describes the base datasource backing the SchemaDelegatingDataSource.