How puneet-swarup/api-audit-logging works
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: IncomingLoggingFilter.java Inbound filter · ApiLogEvent.java Audit event · AuditLogStore.java Store SPI · LoggingAutoConfiguration.java Common autoconfiguration
Components 28
Capture
- Inbound filter
api-audit-logging-core/src/main/java/com/api/audit/filter/IncomingLoggingFilter.java - Audit annotation
api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java - HTTP metadata
api-audit-logging-core/src/main/java/com/api/audit/util/AuditMetadataFormatter.java - Correlation context
api-audit-logging-core/src/main/java/com/api/audit/context/CorrelationContext.java
Record processing
- Audit event
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - Audit record
api-audit-logging-core/src/main/java/com/api/audit/model/AuditLogRecord.java - Async listener
api-audit-logging-core/src/main/java/com/api/audit/listener/ApiLogListener.java - Payload masking
api-audit-logging-core/src/main/java/com/api/audit/util/JsonMasker.java - Audit settings
api-audit-logging-core/src/main/java/com/api/audit/config/AuditLoggingProperties.java - Common autoconfiguration
api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java - Audit metrics
api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/MicrometerAuditMetrics.java
Outbound clients
- Feign capture
api-audit-logging-client-feign/src/main/java/com/api/audit/feign/CustomFeignLogger.java - Feign setup
api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java - RestTemplate capture
api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/AuditRestTemplateInterceptor.java - Rest client setup
api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java - WebClient capture
api-audit-logging-client-webclient/src/main/java/com/api/audit/webclient/WebClientAuditAutoConfiguration.java
Storage and search
- Store SPI
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - JPA storage
api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa - JPA entity
api-audit-logging-storage-jpa/src/main/java/com/api/audit/entity/ApiAuditLog.java - JPA repository
api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java - JDBC storage
api-audit-logging-storage-jdbc/src/main/java/com/api/audit/storage/jdbc - Memory storage
api-audit-logging-storage-memory/src/main/java/com/api/audit/storage/memory - Kafka sink
api-audit-logging-storage-kafka/src/main/java/com/api/audit/storage/kafka - Search SPI
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java - Internal search API
api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java - JPA search store
api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java - JPA query repository
api-audit-logging-storage-jpa/src/main/java/com/api/audit/repository/ApiAuditLogRepository.java
Other components
- API caller
Connections 27
- API caller → Inbound filter: sends request
README.md - Audit annotation → Inbound filter: opts in
api-audit-logging-core/src/main/java/com/api/audit/annotation/AuditLog.java - Inbound filter → Audit event: publishes event
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
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - Audit event → Async listener: consumed by
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - Async listener → Payload masking: masks payloads
README.md - Async listener → Store SPI: persists asynchronously
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - Common autoconfiguration → Inbound filter: registers filter
api-audit-logging-autoconfigure/src/main/java/com/api/audit/config/LoggingAutoConfiguration.java - Common autoconfiguration → Audit settings: configures capture
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
api-audit-logging-client-feign/src/main/java/com/api/audit/feign/FeignAuditAutoConfiguration.java - Feign capture → Audit event: publishes capture
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - Rest client setup → RestTemplate capture: registers interceptor
api-audit-logging-client-resttemplate/src/main/java/com/api/audit/resttemplate/RestTemplateAuditAutoConfiguration.java - RestTemplate capture → Audit event: publishes capture
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - WebClient capture → Audit event: publishes capture
api-audit-logging-core/src/main/java/com/api/audit/event/ApiLogEvent.java - Store SPI → JPA storage: implemented by
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - Store SPI → JDBC storage: implemented by
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - Store SPI → Memory storage: implemented by
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - Store SPI → Kafka sink: implemented by
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogStore.java - JPA storage → JPA entity: maps records
api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java - JPA storage → JPA repository: persists entities
api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java - Internal search API → Search SPI: queries records
api-audit-logging-core/src/main/java/com/api/audit/controller/ApiLogController.java - Search SPI → JPA search store: implemented by
api-audit-logging-core/src/main/java/com/api/audit/spi/AuditLogSearchStore.java - JPA search store → JPA query repository: queries repository
api-audit-logging-storage-jpa/src/main/java/com/api/audit/storage/jpa/JpaAuditLogSearchStore.java - API caller → Internal search API: searches logs
README.md