# bellyachx/masking-logger architecture

> Architecture diagram of the GitHub repository bellyachx/masking-logger, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bellyachx/masking-logger
- Repository: https://github.com/bellyachx/masking-logger

## Overview

Masking Logger is a Java logging library that emits structured logs while masking sensitive data. Applications log through WLogger or Spring interception; the Logback encoder assembles structured events and applies configured masking before encoding output. The README documents JSON/XML masking configuration, request logging, and custom logging APIs. Request and method interception are separate entry paths into WLogger. Some internal wiring is not shown in the excerpts, so uncertain links are omitted or marked dashed.

Main entry points: [`masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java) (Logback Encoder), [`masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java) (Masker Factory), [`masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java`](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java) (WLogger API), [`masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java`](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java) (HTTP Logging)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Logging API"]
  node_wlogger["WLogger API<br/>[WLogger.java]"]
  node_logger_specs["Logger Specs"]
  node_annotations["Logging Annotations<br/>[Mask.java]"]
end

subgraph group_spring["Spring Integration"]
  node_method_advice["Method Logging"]
  node_request_interceptor["HTTP Logging"]
  node_autoconfig["Spring Autoconfiguration"]
end

subgraph group_masking["Masking Engine"]
  node_mask_factory["Masker Factory"]
  node_mask_support["Mask Support<br/>[MaskSupport.java]"]
  node_json_v1["JSON Masker V1<br/>[JsonMaskerV1.java]"]
  node_json_v2["JSON Masker V2<br/>[JsonMaskerV2.java]"]
  node_xml_masker["XML Masker<br/>[XmlMasker.java]"]
  node_maskers["Specialized Maskers"]
end

subgraph group_encoding["Encoding and Context"]
  node_logback_encoder["Logback Encoder"]
  node_log_model["Structured Log Model<br/>[LogModel.java]"]
  node_message_encoder["Body Encoders"]
  node_headers["Header Providers"]
  node_property_provider["Property Providers"]
  node_spring_context["Spring Context"]
end

node_application(("Application"))
node_log_output(("Logging Backend"))

node_application -->|"logs through"| node_wlogger
node_wlogger -.->|"builds log specs"| node_logger_specs
node_method_advice -->|"logs method events"| node_wlogger
node_request_interceptor -->|"logs request and response"| node_wlogger
node_autoconfig -->|"registers interceptor"| node_request_interceptor
node_method_advice -->|"reads annotations"| node_annotations
node_request_interceptor -->|"reads annotations"| node_annotations
node_wlogger -.->|"emits events to"| node_logback_encoder
node_logback_encoder -->|"builds"| node_log_model
node_logback_encoder -->|"creates body encoder"| node_message_encoder
node_logback_encoder -->|"creates masker factory"| node_mask_factory
node_logback_encoder -->|"reads configuration"| node_property_provider
node_logback_encoder -->|"gets detailed headers"| node_headers
node_mask_factory -->|"reads mask settings"| node_property_provider
node_mask_factory -->|"selects JSON masker"| node_json_v1
node_mask_factory -->|"selects JSON masker"| node_json_v2
node_mask_factory -->|"selects XML masker"| node_xml_masker
node_json_v1 -->|"uses masking support"| node_mask_support
node_maskers -->|"uses masking support"| node_mask_support
node_spring_context -.->|"provides Spring context"| node_logback_encoder
node_logback_encoder -->|"encodes log output"| node_log_output

click node_wlogger "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java"
click node_logger_specs "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-api/src/main/java/me/maxhub/logger/api/LoggerSpecImpl.java"
click node_method_advice "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-spring/src/main/java/me/maxhub/logger/aop/LogAroundAdvice.java"
click node_request_interceptor "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java"
click node_autoconfig "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-autoconfig/src/main/java/me/maxhub/logger/RequestMappingInterceptorAutoconfiguration.java"
click node_annotations "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-annotations/src/main/java/me/maxhub/logger/Mask.java"
click node_logback_encoder "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java"
click node_log_model "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/model/LogModel.java"
click node_message_encoder "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/MessageEncoderFactory.java"
click node_headers "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/headers/impl/DetailedHeadersProvider.java"
click node_property_provider "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/properties/provider/PropertyProvider.java"
click node_mask_factory "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java"
click node_mask_support "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/MaskSupport.java"
click node_json_v1 "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV1.java"
click node_json_v2 "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV2.java"
click node_xml_masker "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/XmlMasker.java"
click node_maskers "https://github.com/bellyachx/masking-logger/blob/main/maskers/src/main/java/me/maxhub/logger/IdentityNumberMasker.java"
click node_spring_context "https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/spring/SpringContextHolder.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_wlogger,node_logger_specs,node_annotations toneBlue
class node_method_advice,node_request_interceptor,node_autoconfig toneAmber
class node_mask_factory,node_mask_support,node_json_v1,node_json_v2,node_xml_masker,node_maskers toneMint
class node_logback_encoder,node_log_model,node_message_encoder,node_headers,node_property_provider,node_spring_context toneRose
class node_application,node_log_output toneIndigo
```

## Components

### Logging API

- [WLogger API](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java): `masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java`
- [Logger Specs](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-api/src/main/java/me/maxhub/logger/api/LoggerSpecImpl.java): `masking-logger-api/src/main/java/me/maxhub/logger/api/LoggerSpecImpl.java`
- [Logging Annotations](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-annotations/src/main/java/me/maxhub/logger/Mask.java): `masking-logger-annotations/src/main/java/me/maxhub/logger/Mask.java`

### Spring Integration

- [Method Logging](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-spring/src/main/java/me/maxhub/logger/aop/LogAroundAdvice.java): `masking-logger-spring/src/main/java/me/maxhub/logger/aop/LogAroundAdvice.java`
- [HTTP Logging](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java): `masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java`
- [Spring Autoconfiguration](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-autoconfig/src/main/java/me/maxhub/logger/RequestMappingInterceptorAutoconfiguration.java): `masking-logger-autoconfig/src/main/java/me/maxhub/logger/RequestMappingInterceptorAutoconfiguration.java`

### Masking Engine

- [Masker Factory](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`
- [Mask Support](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/MaskSupport.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/MaskSupport.java`
- [JSON Masker V1](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV1.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV1.java`
- [JSON Masker V2](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV2.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV2.java`
- [XML Masker](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/XmlMasker.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/XmlMasker.java`
- [Specialized Maskers](https://github.com/bellyachx/masking-logger/blob/main/maskers/src/main/java/me/maxhub/logger/IdentityNumberMasker.java): `maskers/src/main/java/me/maxhub/logger/IdentityNumberMasker.java`

### Encoding and Context

- [Logback Encoder](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java): `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`
- [Structured Log Model](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/model/LogModel.java): `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/model/LogModel.java`
- [Body Encoders](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/mask/MessageEncoderFactory.java): `masking-logger-core/src/main/java/me/maxhub/logger/mask/MessageEncoderFactory.java`
- [Header Providers](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/headers/impl/DetailedHeadersProvider.java): `masking-logger-core/src/main/java/me/maxhub/logger/headers/impl/DetailedHeadersProvider.java`
- [Property Providers](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/properties/provider/PropertyProvider.java): `masking-logger-core/src/main/java/me/maxhub/logger/properties/provider/PropertyProvider.java`
- [Spring Context](https://github.com/bellyachx/masking-logger/blob/main/masking-logger-core/src/main/java/me/maxhub/logger/spring/SpringContextHolder.java): `masking-logger-core/src/main/java/me/maxhub/logger/spring/SpringContextHolder.java`

### Other components

- **Application**
- **Logging Backend**

## Connections

- Application → WLogger API: logs through (evidence: `README.md`)
- WLogger API → Logger Specs: builds log specs (evidence: `masking-logger-api/src/main/java/me/maxhub/logger/api/WLogger.java`)
- Method Logging → WLogger API: logs method events (evidence: `masking-logger-spring/src/main/java/me/maxhub/logger/aop/LogAroundAdvice.java`)
- HTTP Logging → WLogger API: logs request and response (evidence: `masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java`)
- Spring Autoconfiguration → HTTP Logging: registers interceptor (evidence: `masking-logger-autoconfig/src/main/java/me/maxhub/logger/RequestMappingInterceptorAutoconfiguration.java`)
- Method Logging → Logging Annotations: reads annotations (evidence: `masking-logger-spring/src/main/java/me/maxhub/logger/aop/LogAroundAdvice.java`)
- HTTP Logging → Logging Annotations: reads annotations (evidence: `masking-logger-spring/src/main/java/me/maxhub/logger/aop/http/RequestMappingInterceptor.java`)
- WLogger API → Logback Encoder: emits events to
- Logback Encoder → Structured Log Model: builds (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Logback Encoder → Body Encoders: creates body encoder (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Logback Encoder → Masker Factory: creates masker factory (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Logback Encoder → Property Providers: reads configuration (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Logback Encoder → Header Providers: gets detailed headers (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Masker Factory → Property Providers: reads mask settings (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`)
- Masker Factory → JSON Masker V1: selects JSON masker (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`)
- Masker Factory → JSON Masker V2: selects JSON masker (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`)
- Masker Factory → XML Masker: selects XML masker (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/mask/DataMaskerFactory.java`)
- JSON Masker V1 → Mask Support: uses masking support (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/mask/impl/JsonMaskerV1.java`)
- Specialized Maskers → Mask Support: uses masking support (evidence: `maskers/src/main/java/me/maxhub/logger/IdentityNumberMasker.java`)
- Spring Context → Logback Encoder: provides Spring context (evidence: `masking-logger-core/src/main/java/me/maxhub/logger/logback/encoder/MaskingJsonEncoder.java`)
- Logback Encoder → Logging Backend: encodes log output (evidence: `README.md`)
