Logging

Kind: mechanism

Layer: Observability

Record: architecture:logging

Severity: mandatory

Scope: application, service

Canonical: Ontology

A mechanism that records structured events with their context as the code runs.

Listed in Architecture principles, after Observability and before Monitoring.

Requires

• Structured Events
• Context

Reinforces

• Traceability
• Debugging

Enables

• Incident Analysis

Conflicts with

• Silent Failure
• Log-as-Control-Flow

In tension with

• Noise/Personal Data Leakage

Tensions

• Logging / Noise/Personal Data Leakage

Violated by

• Unobservable Failure

Refactored by

• Structured Log
• Pass Context Explicitly

Severity

• mandatory

Category

• Observability / Auditability / Traceability

Linked from

• Anti-patterns
• Model Architecture
• Observability / Auditability / Traceability
• Core Vocabulary
• Correctness / Determinism / Verification
• Observability / Auditability / Traceability
• Severity levels
• The resolutions