Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Logging

This document describes the logging model used across the framework crates.

Overview

Logging is designed around structured events, session awareness, and optional subscription-style consumption.

Flow

flowchart LR
    EVENT[Runtime event] --> LOGGER[Logger]
    LOGGER --> STORE[Session log storage]
    LOGGER --> STREAM[Optional subscriber stream]
    STORE --> QUERY[Query or export logs]

Characteristics

CapabilityPurpose
Structured entriesKeep logs machine-readable
Session groupingTrace activity by session or context
Subscriber supportStream events in real time when needed
Export supportPersist logs for later inspection

Guidance

  • Use structured metadata whenever possible.
  • Keep session identifiers stable enough to trace one workflow end to end.
  • Export logs when debugging long-running or multi-step flows.