# sirupsen/logrus architecture

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

- Interactive diagram: https://gitdiagram.com/sirupsen/logrus
- Repository: https://github.com/sirupsen/logrus

## Overview

Logrus is a structured Go logging library. Applications configure a package-level or instance logger, add fields or context to an entry, and emit at a severity; entries then invoke hooks and format/write output. The graph also preserves text/JSON formatting and the writer, syslog, and bidirectional slog integrations. Main entry and adapter paths are excerpted; some logger and formatter internals are not, so uncertain connections are omitted or marked unverified.

Main entry points: [`entry.go`](https://github.com/sirupsen/logrus/blob/master/entry.go) (Log entry), [`hooks.go`](https://github.com/sirupsen/logrus/blob/master/hooks.go) (Hook dispatch), [`hooks/slog/slog.go`](https://github.com/sirupsen/logrus/blob/master/hooks/slog/slog.go) (slog hook), [`hooks/slog/handler.go`](https://github.com/sirupsen/logrus/blob/master/hooks/slog/handler.go) (slog handler)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Logging API"]
  node_public_api["Package API<br/>[exported.go]"]
  node_logger["Logger<br/>[logger.go]"]
end

subgraph group_runtime["Event Processing"]
  node_entry["Log entry<br/>[entry.go]"]
  node_levels["Levels<br/>[level.go]"]
  node_buffer_pool["Buffer pool<br/>[buffer_pool.go]"]
  node_hooks_core["Hook dispatch<br/>[hooks.go]"]
end

subgraph group_output["Formatting and Output"]
  node_text_formatter["Text formatter<br/>[text_formatter.go]"]
  node_json_formatter["JSON formatter<br/>[json_formatter.go]"]
  node_writer["Output writer<br/>[writer.go]"]
end

subgraph group_integrations["Logging Integrations"]
  node_writer_hook["Writer hook<br/>[writer.go]"]
  node_syslog_hook["Syslog hook<br/>[syslog.go]"]
  node_slog_handler["slog handler<br/>[handler.go]"]
  node_slog_hook["slog hook<br/>[slog.go]"]
  node_slog_levels["Level mapping<br/>[level.go]"]
end

node_application(("Go application"))
node_syslog_service["Syslog"]
node_slog_logger["slog logger"]
node_log_sink["Log destination"]

node_application -->|"calls"| node_public_api
node_public_api -->|"configures"| node_logger
node_logger -.->|"creates entries"| node_entry
node_entry -.->|"checks severity"| node_levels
node_entry -->|"fires hooks"| node_hooks_core
node_entry -->|"formats entry"| node_text_formatter
node_entry -.->|"formats entry"| node_json_formatter
node_entry -->|"writes bytes"| node_writer
node_entry -->|"reuses buffer"| node_buffer_pool
node_writer -.->|"writes output"| node_log_sink
node_writer_hook -->|"writes entry"| node_log_sink
node_syslog_hook -->|"sends severity"| node_syslog_service
node_hooks_core -.->|"fires hook"| node_writer_hook
node_hooks_core -.->|"fires hook"| node_syslog_hook
node_hooks_core -.->|"fires hook"| node_slog_hook
node_slog_handler -->|"logs record"| node_logger
node_slog_handler -->|"maps severity"| node_slog_levels
node_slog_hook -->|"forwards entry"| node_slog_logger
node_slog_hook -->|"maps severity"| node_slog_levels
node_slog_hook -->|"calls handler"| node_slog_handler

click node_public_api "https://github.com/sirupsen/logrus/blob/master/exported.go"
click node_logger "https://github.com/sirupsen/logrus/blob/master/logger.go"
click node_entry "https://github.com/sirupsen/logrus/blob/master/entry.go"
click node_levels "https://github.com/sirupsen/logrus/blob/master/level.go"
click node_text_formatter "https://github.com/sirupsen/logrus/blob/master/text_formatter.go"
click node_json_formatter "https://github.com/sirupsen/logrus/blob/master/json_formatter.go"
click node_writer "https://github.com/sirupsen/logrus/blob/master/writer.go"
click node_buffer_pool "https://github.com/sirupsen/logrus/blob/master/buffer_pool.go"
click node_hooks_core "https://github.com/sirupsen/logrus/blob/master/hooks.go"
click node_writer_hook "https://github.com/sirupsen/logrus/blob/master/hooks/writer/writer.go"
click node_syslog_hook "https://github.com/sirupsen/logrus/blob/master/hooks/syslog/syslog.go"
click node_slog_handler "https://github.com/sirupsen/logrus/blob/master/hooks/slog/handler.go"
click node_slog_hook "https://github.com/sirupsen/logrus/blob/master/hooks/slog/slog.go"
click node_slog_levels "https://github.com/sirupsen/logrus/blob/master/hooks/slog/level.go"

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_public_api,node_logger toneBlue
class node_entry,node_levels,node_buffer_pool,node_hooks_core toneAmber
class node_text_formatter,node_json_formatter,node_writer toneMint
class node_writer_hook,node_syslog_hook,node_slog_handler,node_slog_hook,node_slog_levels toneRose
class node_application,node_syslog_service,node_slog_logger,node_log_sink toneIndigo
```

## Components

### Logging API

- [Package API](https://github.com/sirupsen/logrus/blob/master/exported.go): `exported.go`
- [Logger](https://github.com/sirupsen/logrus/blob/master/logger.go): `logger.go`

### Event Processing

- [Log entry](https://github.com/sirupsen/logrus/blob/master/entry.go): `entry.go`
- [Levels](https://github.com/sirupsen/logrus/blob/master/level.go): `level.go`
- [Buffer pool](https://github.com/sirupsen/logrus/blob/master/buffer_pool.go): `buffer_pool.go`
- [Hook dispatch](https://github.com/sirupsen/logrus/blob/master/hooks.go): `hooks.go`

### Formatting and Output

- [Text formatter](https://github.com/sirupsen/logrus/blob/master/text_formatter.go): `text_formatter.go`
- [JSON formatter](https://github.com/sirupsen/logrus/blob/master/json_formatter.go): `json_formatter.go`
- [Output writer](https://github.com/sirupsen/logrus/blob/master/writer.go): `writer.go`

### Logging Integrations

- [Writer hook](https://github.com/sirupsen/logrus/blob/master/hooks/writer/writer.go): `hooks/writer/writer.go`
- [Syslog hook](https://github.com/sirupsen/logrus/blob/master/hooks/syslog/syslog.go): `hooks/syslog/syslog.go`
- [slog handler](https://github.com/sirupsen/logrus/blob/master/hooks/slog/handler.go): `hooks/slog/handler.go`
- [slog hook](https://github.com/sirupsen/logrus/blob/master/hooks/slog/slog.go): `hooks/slog/slog.go`
- [Level mapping](https://github.com/sirupsen/logrus/blob/master/hooks/slog/level.go): `hooks/slog/level.go`

### Other components

- **Go application**
- **Syslog**
- **slog logger**
- **Log destination**

## Connections

- Go application → Package API: calls (evidence: `README.md`)
- Package API → Logger: configures (evidence: `exported.go`)
- Logger → Log entry: creates entries
- Log entry → Levels: checks severity
- Log entry → Hook dispatch: fires hooks (evidence: `entry.go`)
- Log entry → Text formatter: formats entry (evidence: `entry.go`)
- Log entry → JSON formatter: formats entry
- Log entry → Output writer: writes bytes (evidence: `entry.go`)
- Log entry → Buffer pool: reuses buffer (evidence: `entry.go`)
- Output writer → Log destination: writes output
- Writer hook → Log destination: writes entry (evidence: `hooks/writer/writer.go`)
- Syslog hook → Syslog: sends severity (evidence: `hooks/syslog/syslog.go`)
- Hook dispatch → Writer hook: fires hook
- Hook dispatch → Syslog hook: fires hook
- Hook dispatch → slog hook: fires hook
- slog handler → Logger: logs record (evidence: `hooks/slog/handler.go`)
- slog handler → Level mapping: maps severity (evidence: `hooks/slog/handler.go`)
- slog hook → slog logger: forwards entry (evidence: `hooks/slog/slog.go`)
- slog hook → Level mapping: maps severity (evidence: `hooks/slog/slog.go`)
- slog hook → slog handler: calls handler (evidence: `hooks/slog/slog.go`)
