# puneet-swarup/api-audit-logging architecture

> Architecture diagram of the GitHub repository puneet-swarup/api-audit-logging, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/puneet-swarup/api-audit-logging
- Repository: https://github.com/puneet-swarup/api-audit-logging

## Overview

API Audit Logging is a Spring Boot starter and modular library for capturing inbound and outbound HTTP exchanges, redacting sensitive data, and persisting or publishing audit records. The principal flow is an annotated inbound request through capture, event publication, masking, and a selected sink; searchable sinks also serve the internal audit-log endpoint. The README documents client integrations and storage choices, while some implementations were not sampled, so those branches are shown at module-directory level. Edges cite the README or excerpts that establish the relationship.

Main entry points: [`api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java`](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java) (Inbound filter), [`api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java) (Audit event), [`api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java) (Store SPI), [`api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java`](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java) (Common autoconfiguration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_capture["Capture"]
  node_incoming["Inbound filter"]
  node_annotation["Audit annotation<br/>[AuditLog.java]"]
  node_metadata["HTTP metadata"]
  node_correlation["Correlation context"]
end

subgraph group_processing["Record processing"]
  node_event["Audit event<br/>[ApiLogEvent.java]"]
  node_record["Audit record"]
  node_listener["Async listener"]
  node_masker["Payload masking<br/>[JsonMasker.java]"]
  node_properties["Audit settings"]
  node_commonconfig["Common autoconfiguration"]
  node_metrics["Audit metrics"]
end

subgraph group_clients["Outbound clients"]
  node_feign["Feign capture"]
  node_feignconfig["Feign setup"]
  node_resttemplate["RestTemplate capture"]
  node_restconfig["Rest client setup"]
  node_webclient["WebClient capture"]
end

subgraph group_storage["Storage and search"]
  node_storeapi["Store SPI<br/>[AuditLogStore.java]"]
  node_jpa[("JPA storage")]
  node_jpaentity["JPA entity<br/>[ApiAuditLog.java]"]
  node_jparepo["JPA repository"]
  node_jdbc[("JDBC storage")]
  node_memory["Memory storage"]
  node_kafka["Kafka sink"]
  node_searchspi["Search SPI"]
  node_controller["Internal search API"]
  node_jpasearch["JPA search store"]
  node_jparepoquery["JPA query repository"]
end

node_caller(("API caller"))

node_caller -->|"sends request"| node_incoming
node_annotation -->|"opts in"| node_incoming
node_incoming -->|"publishes event"| node_event
node_incoming -.->|"captures metadata"| node_metadata
node_incoming -.->|"uses correlation ID"| node_correlation
node_event -->|"carries record"| node_record
node_event -->|"consumed by"| node_listener
node_listener -->|"masks payloads"| node_masker
node_listener -->|"persists asynchronously"| node_storeapi
node_commonconfig -->|"registers filter"| node_incoming
node_commonconfig -.->|"configures capture"| node_properties
node_commonconfig -.->|"configures metrics"| node_metrics
node_feignconfig -->|"configures logger"| node_feign
node_feign -->|"publishes capture"| node_event
node_restconfig -->|"registers interceptor"| node_resttemplate
node_resttemplate -->|"publishes capture"| node_event
node_webclient -->|"publishes capture"| node_event
node_storeapi -->|"implemented by"| node_jpa
node_storeapi -->|"implemented by"| node_jdbc
node_storeapi -->|"implemented by"| node_memory
node_storeapi -->|"implemented by"| node_kafka
node_jpa -.->|"maps records"| node_jpaentity
node_jpa -.->|"persists entities"| node_jparepo
node_controller -->|"queries records"| node_searchspi
node_searchspi -->|"implemented by"| node_jpasearch
node_jpasearch -->|"queries repository"| node_jparepoquery
node_caller -->|"searches logs"| node_controller

click node_incoming "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java"
click node_annotation "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java"
click node_metadata "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/util/AuditMetadataFormatter.java"
click node_correlation "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/context/CorrelationContext.java"
click node_event "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java"
click node_record "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/model/AuditLogRecord.java"
click node_listener "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/listener/ApiLogListener.java"
click node_masker "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/util/JsonMasker.java"
click node_properties "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/config/AuditLoggingProperties.java"
click node_commonconfig "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java"
click node_metrics "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/MicrometerAuditMetrics.java"
click node_feign "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-feign/src/main/java/com/api/audit/feign/CustomFeignLogger.java"
click node_feignconfig "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java"
click node_resttemplate "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/AuditRestTemplateInterceptor.java"
click node_restconfig "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java"
click node_webclient "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-webclient/src/main/java/com/api/audit/webclient/WebClientAuditAutoConfiguration.java"
click node_storeapi "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java"
click node_jpa "https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa"
click node_jpaentity "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/entity/ApiAuditLog.java"
click node_jparepo "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java"
click node_jdbc "https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-jdbc/src/main/java/com/api/audit/storage/jdbc"
click node_memory "https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-memory/src/main/java/com/api/audit/storage/memory"
click node_kafka "https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-kafka/src/main/java/com/api/audit/storage/kafka"
click node_searchspi "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java"
click node_controller "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java"
click node_jpasearch "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java"
click node_jparepoquery "https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_incoming,node_annotation,node_metadata,node_correlation toneBlue
class node_event,node_record,node_listener,node_masker,node_properties,node_commonconfig,node_metrics toneAmber
class node_feign,node_feignconfig,node_resttemplate,node_restconfig,node_webclient,node_caller toneMint
class node_storeapi,node_jpa,node_jpaentity,node_jparepo,node_jdbc,node_memory,node_kafka,node_searchspi,node_controller,node_jpasearch,node_jparepoquery toneRose
```

## Components

### Capture

- [Inbound filter](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java): `api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java`
- [Audit annotation](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java): `api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java`
- [HTTP metadata](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/util/AuditMetadataFormatter.java): `api-audit-logging-core/src/main/java/com/api/audit/util/AuditMetadataFormatter.java`
- [Correlation context](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/context/CorrelationContext.java): `api-audit-logging-core/src/main/java/com/api/audit/context/CorrelationContext.java`

### Record processing

- [Audit event](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java): `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`
- [Audit record](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/model/AuditLogRecord.java): `api-audit-logging-core/src/main/java/com/api/audit/model/AuditLogRecord.java`
- [Async listener](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/listener/ApiLogListener.java): `api-audit-logging-core/src/main/java/com/api/audit/listener/ApiLogListener.java`
- [Payload masking](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/util/JsonMasker.java): `api-audit-logging-core/src/main/java/com/api/audit/util/JsonMasker.java`
- [Audit settings](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/config/AuditLoggingProperties.java): `api-audit-logging-core/src/main/java/com/api/audit/config/AuditLoggingProperties.java`
- [Common autoconfiguration](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java): `api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java`
- [Audit metrics](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/MicrometerAuditMetrics.java): `api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/MicrometerAuditMetrics.java`

### Outbound clients

- [Feign capture](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-feign/src/main/java/com/api/audit/feign/CustomFeignLogger.java): `api-audit-logging-client-feign/src/main/java/com/api/audit/feign/CustomFeignLogger.java`
- [Feign setup](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java): `api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java`
- [RestTemplate capture](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/AuditRestTemplateInterceptor.java): `api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/AuditRestTemplateInterceptor.java`
- [Rest client setup](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java): `api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java`
- [WebClient capture](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-client-webclient/src/main/java/com/api/audit/webclient/WebClientAuditAutoConfiguration.java): `api-audit-logging-client-webclient/src/main/java/com/api/audit/webclient/WebClientAuditAutoConfiguration.java`

### Storage and search

- [Store SPI](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java): `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`
- [JPA storage](https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa): `api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa`
- [JPA entity](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/entity/ApiAuditLog.java): `api-audit-logging-storage-jpa/src/main/java/com/api/audit/entity/ApiAuditLog.java`
- [JPA repository](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java): `api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java`
- [JDBC storage](https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-jdbc/src/main/java/com/api/audit/storage/jdbc): `api-audit-logging-storage-jdbc/src/main/java/com/api/audit/storage/jdbc`
- [Memory storage](https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-memory/src/main/java/com/api/audit/storage/memory): `api-audit-logging-storage-memory/src/main/java/com/api/audit/storage/memory`
- [Kafka sink](https://github.com/puneet-swarup/api-audit-logging/tree/main/api-audit-logging-storage-kafka/src/main/java/com/api/audit/storage/kafka): `api-audit-logging-storage-kafka/src/main/java/com/api/audit/storage/kafka`
- [Search SPI](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java): `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java`
- [Internal search API](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java): `api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java`
- [JPA search store](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java): `api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java`
- [JPA query repository](https://github.com/puneet-swarup/api-audit-logging/blob/main/api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java): `api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java`

### Other components

- **API caller**

## Connections

- API caller → Inbound filter: sends request (evidence: `README.md`)
- Audit annotation → Inbound filter: opts in (evidence: `api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java`)
- Inbound filter → Audit event: publishes event (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- Inbound filter → HTTP metadata: captures metadata
- Inbound filter → Correlation context: uses correlation ID
- Audit event → Audit record: carries record (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- Audit event → Async listener: consumed by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- Async listener → Payload masking: masks payloads (evidence: `README.md`)
- Async listener → Store SPI: persists asynchronously (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`)
- Common autoconfiguration → Inbound filter: registers filter (evidence: `api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java`)
- Common autoconfiguration → Audit settings: configures capture (evidence: `api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java`)
- Common autoconfiguration → Audit metrics: configures metrics
- Feign setup → Feign capture: configures logger (evidence: `api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java`)
- Feign capture → Audit event: publishes capture (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- Rest client setup → RestTemplate capture: registers interceptor (evidence: `api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java`)
- RestTemplate capture → Audit event: publishes capture (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- WebClient capture → Audit event: publishes capture (evidence: `api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java`)
- Store SPI → JPA storage: implemented by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`)
- Store SPI → JDBC storage: implemented by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`)
- Store SPI → Memory storage: implemented by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`)
- Store SPI → Kafka sink: implemented by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java`)
- JPA storage → JPA entity: maps records (evidence: `api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java`)
- JPA storage → JPA repository: persists entities (evidence: `api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java`)
- Internal search API → Search SPI: queries records (evidence: `api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java`)
- Search SPI → JPA search store: implemented by (evidence: `api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java`)
- JPA search store → JPA query repository: queries repository (evidence: `api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java`)
- API caller → Internal search API: searches logs (evidence: `README.md`)
