Interceptors¶

Interceptors provide a pluggable mechanism to hook into every Aerospike operation performed through the bundle. They follow a chain-of-responsibility pattern -- each interceptor can execute logic before and after an operation, then delegate to the next interceptor in the chain.

How Interceptors Work¶

sequenceDiagram
    participant App as Your Code
    participant Metrics as MetricInterceptor
    participant Custom as Your Interceptor
    participant Terminal as TerminalOperationInterceptor
    participant AS as Aerospike

    App->>Metrics: put(key, bins)
    Metrics->>Metrics: preProcess() - start timer
    Metrics->>Custom: delegate
    Custom->>Custom: preProcess()
    Custom->>Terminal: delegate
    Terminal->>AS: actual put()
    AS-->>Terminal: result
    Terminal->>Custom: return
    Custom->>Custom: postProcess()
    Custom-->>Metrics: return
    Metrics->>Metrics: postProcess() - record duration
    Metrics-->>App: result

Built-in Interceptors¶

Interceptor	Role
`MetricInterceptor`	Always the outermost interceptor. Records operation timing and counts using Dropwizard Metrics.
`TerminalOperationInterceptor`	Always the innermost interceptor. Executes the actual Aerospike client call.

Writing a Custom Interceptor¶

Implement the AerospikeInterceptor interface:

import com.phonepe.aerospike.interceptors.AerospikeInterceptor;
import com.phonepe.aerospike.interceptors.AerospikeInterceptorContext;

public class LoggingInterceptor extends AerospikeInterceptor {

    @Override
    public void preProcess(AerospikeInterceptorContext context) {
        log.info("Operation: {} on namespace: {}, set: {}",
            context.getOperation(),
            context.getNamespace(),
            context.getSetName());
    }

    @Override
    public void postProcess(AerospikeInterceptorContext context) {
        log.info("Operation completed: {}", context.getOperation());
    }
}

Registering Interceptors¶

Register interceptors before the bundle's run() method is called (typically in initialize()), or immediately after:

aerospikeBundle.registerInterceptor(new LoggingInterceptor());
aerospikeBundle.registerInterceptor(new AuditInterceptor());

Interceptors are invoked in the order they are registered (outermost to innermost), with MetricInterceptor always wrapping them all.

AerospikeInterceptorContext¶

The context object passed to each interceptor contains:

Field	Description
`operation`	The `AerospikeOperation` enum (GET, PUT, DELETE, etc.)
`namespace`	Target namespace
`setName`	Target set
`keys`	Keys involved (if `interceptorContextKeyPopulationEnabled` is true)
`requestInfo`	Additional request metadata

Size Metrics¶

When sizeMetricsEnabled: true in your configuration, the client emits size metrics for String and byte[] bins, helping you monitor record sizes.