# cheisesu/loggerkit architecture

> Architecture diagram of the GitHub repository cheisesu/loggerkit, 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/cheisesu/loggerkit
- Repository: https://github.com/cheisesu/loggerkit

## Overview

LoggerKit is a Swift logging library. A caller submits a message through the LoggerEngine API; concrete engines format and emit it, with StreamedLogger applying a log-level threshold and writing to a stream. The package also provides console and combined logger implementations, configurable message construction and log-type conversion, and file-stream rotation policies. Several concrete-engine and file-stream relationships are supported by the source index but not shown in excerpts, so those links are marked unverified rather than asserted as confirmed calls.

Main entry points: [`Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift) (Default message builder), [`Sources/LoggerKit/Engine/LoggerEngine.swift`](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/LoggerEngine.swift) (LoggerEngine API), [`Sources/LoggerKit/Engine/StreamedLogger.swift`](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/StreamedLogger.swift) (Streamed logger), [`Sources/LoggerKit/LoggerStream/FileLoggerStream.swift`](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerStream/FileLoggerStream.swift) (File logger stream)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_engines["Logger engines"]
  node_engine_api["LoggerEngine API<br/>[LoggerEngine.swift]"]
  node_streamed["Streamed logger"]
  node_console["Console logger"]
  node_combined["Combined logger"]
  node_loggable["Loggable support<br/>[Loggable.swift]"]
end

subgraph group_format["Message formatting"]
  node_message_api["Message constructor API"]
  node_message_default["Default message builder"]
  node_engine_options["Engine options"]
end

subgraph group_streams["Output streams"]
  node_stream_api["Logger stream API<br/>[LoggerStream.swift]"]
  node_file_stream["File logger stream"]
  node_file_policy["File transfer policy"]
  node_count_policy["Counting rotation"]
  node_file_limits["File size limits"]
end

subgraph group_types["Logging types"]
  node_log_type["Log levels<br/>[LogType.swift]"]
  node_type_string_api["Log type converter API"]
  node_type_string_default["Default type converter"]
  node_category["Log categories"]
end

node_caller(("Logging caller"))

node_caller -->|"submits logs"| node_engine_api
node_streamed -->|"constructs messages"| node_message_api
node_streamed -->|"writes messages"| node_stream_api
node_streamed -.->|"implements"| node_engine_api
node_console -.->|"implements"| node_engine_api
node_combined -.->|"delegates logs"| node_engine_api
node_loggable -.->|"uses engine"| node_engine_api
node_message_default -->|"implements"| node_message_api
node_message_default -->|"checks options"| node_engine_options
node_message_default -->|"converts level"| node_type_string_api
node_message_default -->|"formats category"| node_category
node_message_default -->|"formats level"| node_log_type
node_file_stream -.->|"implements"| node_stream_api
node_file_stream -.->|"uses policy"| node_file_policy
node_count_policy -->|"implements"| node_file_policy
node_type_string_default -->|"implements"| node_type_string_api
node_type_string_default -->|"converts levels"| node_log_type

click node_engine_api "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/LoggerEngine.swift"
click node_streamed "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/StreamedLogger.swift"
click node_console "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/ConsoleLogger.swift"
click node_combined "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/CombinedLogger.swift"
click node_loggable "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/Loggable.swift"
click node_message_api "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/MessageConstructor/LoggerMessageConstructor.swift"
click node_message_default "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift"
click node_engine_options "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/LoggerEngineOption.swift"
click node_stream_api "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerStream/LoggerStream.swift"
click node_file_stream "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerStream/FileLoggerStream.swift"
click node_file_policy "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/FileRotation/FileTransferPolicy.swift"
click node_count_policy "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/FileRotation/CountingFileTransferPolicy.swift"
click node_file_limits "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Extensions/Number%2BFileLimitsPolitics.swift"
click node_log_type "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType.swift"
click node_type_string_api "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType/LogTypeStringConvertible.swift"
click node_type_string_default "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType/DefaultLogTypeStringConverter.swift"
click node_category "https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerCategory.swift"

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_engine_api,node_streamed,node_console,node_combined,node_loggable toneBlue
class node_message_api,node_message_default,node_engine_options toneAmber
class node_stream_api,node_file_stream,node_file_policy,node_count_policy,node_file_limits toneMint
class node_log_type,node_type_string_api,node_type_string_default,node_category toneRose
class node_caller toneIndigo
```

## Components

### Logger engines

- [LoggerEngine API](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/LoggerEngine.swift): `Sources/LoggerKit/Engine/LoggerEngine.swift`
- [Streamed logger](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/StreamedLogger.swift): `Sources/LoggerKit/Engine/StreamedLogger.swift`
- [Console logger](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/ConsoleLogger.swift): `Sources/LoggerKit/Engine/ConsoleLogger.swift`
- [Combined logger](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/CombinedLogger.swift): `Sources/LoggerKit/Engine/CombinedLogger.swift`
- [Loggable support](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/Loggable.swift): `Sources/LoggerKit/Engine/Loggable.swift`

### Message formatting

- [Message constructor API](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/MessageConstructor/LoggerMessageConstructor.swift): `Sources/LoggerKit/MessageConstructor/LoggerMessageConstructor.swift`
- [Default message builder](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift): `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`
- [Engine options](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Engine/LoggerEngineOption.swift): `Sources/LoggerKit/Engine/LoggerEngineOption.swift`

### Output streams

- [Logger stream API](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerStream/LoggerStream.swift): `Sources/LoggerKit/LoggerStream/LoggerStream.swift`
- [File logger stream](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerStream/FileLoggerStream.swift): `Sources/LoggerKit/LoggerStream/FileLoggerStream.swift`
- [File transfer policy](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/FileRotation/FileTransferPolicy.swift): `Sources/LoggerKit/FileRotation/FileTransferPolicy.swift`
- [Counting rotation](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/FileRotation/CountingFileTransferPolicy.swift): `Sources/LoggerKit/FileRotation/CountingFileTransferPolicy.swift`
- [File size limits](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/Extensions/Number%2BFileLimitsPolitics.swift): `Sources/LoggerKit/Extensions/Number+FileLimitsPolitics.swift`

### Logging types

- [Log levels](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType.swift): `Sources/LoggerKit/LogType.swift`
- [Log type converter API](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType/LogTypeStringConvertible.swift): `Sources/LoggerKit/LogType/LogTypeStringConvertible.swift`
- [Default type converter](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LogType/DefaultLogTypeStringConverter.swift): `Sources/LoggerKit/LogType/DefaultLogTypeStringConverter.swift`
- [Log categories](https://github.com/cheisesu/loggerkit/blob/master/Sources/LoggerKit/LoggerCategory.swift): `Sources/LoggerKit/LoggerCategory.swift`

### Other components

- **Logging caller**

## Connections

- Logging caller → LoggerEngine API: submits logs (evidence: `Sources/LoggerKit/Engine/LoggerEngine.swift`)
- Streamed logger → Message constructor API: constructs messages (evidence: `Sources/LoggerKit/Engine/StreamedLogger.swift`)
- Streamed logger → Logger stream API: writes messages (evidence: `Sources/LoggerKit/Engine/StreamedLogger.swift`)
- Streamed logger → LoggerEngine API: implements (evidence: `Sources/LoggerKit/Engine/StreamedLogger.swift`)
- Console logger → LoggerEngine API: implements (evidence: `Sources/LoggerKit/Engine/ConsoleLogger.swift`)
- Combined logger → LoggerEngine API: delegates logs (evidence: `Sources/LoggerKit/Engine/CombinedLogger.swift`)
- Loggable support → LoggerEngine API: uses engine (evidence: `Sources/LoggerKit/Engine/Loggable.swift`)
- Default message builder → Message constructor API: implements (evidence: `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`)
- Default message builder → Engine options: checks options (evidence: `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`)
- Default message builder → Log type converter API: converts level (evidence: `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`)
- Default message builder → Log categories: formats category (evidence: `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`)
- Default message builder → Log levels: formats level (evidence: `Sources/LoggerKit/MessageConstructor/DefaultLoggerMessageConstructor.swift`)
- File logger stream → Logger stream API: implements (evidence: `Sources/LoggerKit/LoggerStream/FileLoggerStream.swift`)
- File logger stream → File transfer policy: uses policy (evidence: `Sources/LoggerKit/LoggerStream/FileLoggerStream.swift`)
- Counting rotation → File transfer policy: implements (evidence: `Sources/LoggerKit/FileRotation/CountingFileTransferPolicy.swift`)
- Default type converter → Log type converter API: implements (evidence: `Sources/LoggerKit/LogType/DefaultLogTypeStringConverter.swift`)
- Default type converter → Log levels: converts levels (evidence: `Sources/LoggerKit/LogType/DefaultLogTypeStringConverter.swift`)
