Couchbase Audit Store

The Couchbase audit store (CouchbaseSyncAuditStore) enables Flamingock to record execution history and ensure safe coordination across distributed deployments using Couchbase as the storage backend.

For a conceptual explanation of the audit store vs target systems, see Audit store vs target system.

Version Compatibility

Component	Version Requirement
Couchbase Java Client	3.6.0+

Couchbase Java Client 3.6.0+ is required and must be included in your project dependencies.

Installation

Add the Couchbase Java Client dependency to your project:

Gradle

implementation("com.couchbase.client:java-client:3.7.0")

Maven

<dependency>
    <groupId>com.couchbase.client</groupId>
    <artifactId>java-client</artifactId>
    <version>3.7.0</version> <!-- 3.6.0+ supported -->
</dependency>

Basic setup

Configure the audit store:

var auditStore = new CouchbaseSyncAuditStore(cluster, bucket);

The constructor requires the Couchbase cluster and bucket. Optional configurations can be added via .withXXX() methods.

Register Audit Store

Once created, you need to register this audit store with Flamingock. See Registering the community audit store for details.

Audit Store Configuration

The Couchbase audit store uses explicit configuration with no global context fallback.

Constructor Dependencies (Mandatory)

These dependencies must be provided at audit store creation time with no global context fallback:

Dependency	Constructor Parameter	Description
Cluster	cluster	Couchbase cluster connection - required for audit store configuration
Bucket	bucket	Target bucket instance - required for storing audit data

Configuration example

Here's a comprehensive example showing the configuration:

// Audit store configuration (mandatory via constructor)
var auditStore = new CouchbaseSyncAuditStore(cluster, bucket)
    .withScopeName("custom-scope")     // Optional configuration
    .withAutoCreate(true);             // Optional configuration

// Register with Flamingock
Flamingock.builder()
    .setAuditStore(auditStore)
    .addTargetSystems(targetSystems...)
    .build();

Audit store configuration resolution:

• Cluster: Must be provided via constructor
• Bucket: Must be provided via constructor
• Scope settings: Uses explicit configuration via properties

This architecture ensures explicit audit store configuration with no fallback dependencies.

Optional Configuration (.withXXX() methods)

These configurations can be customized via .withXXX() methods with no global context fallback:

Configuration	Method	Default	Description
Auto Create	.withAutoCreate(enabled)	true	Auto-create collections and indexes
Scope Name	.withScopeName(name)	_default	Scope where audit collections will be created
Audit Repository Name	.withAuditRepositoryName(name)	flamingockAuditLog	Collection name for audit entries
Lock Repository Name	.withLockRepositoryName(name)	flamingockLock	Collection name for distributed locks

⚠️ Warning: Ensure your Couchbase user has permissions to create collections if autoCreate is enabled.

Next steps

• Learn about Target systems
• 👉 See a full example project