Skip to content

Add architecture documentation #56

Closed

Description

@markbac

There is no architecture documentation. Contributors have to read the 800 line log_setup.py to learn how records flow, where context is attached and how the optional pieces fit.

Add docs/architecture.md, linked from the README, covering:

  1. Module layout and public API.
  2. How a record flows from a logging call to each output, including the queue path.
  3. How context is layered (global context, adapter, extra) and why it uses contextvars.
  4. The design decisions and constraints that are not obvious from the code: filters per handler, optional dependencies, python-json-logger version differences, colour handling and the formats.
  5. How to extend the package, and the testing and release approach.

Use Mermaid diagrams.


Generated by Claude Code

Activity

  1. added
    documentationImprovements or additions to documentation
    in progressWork has started on this issue
    on Oct 3, 2026
  2. markbac commented on Oct 3, 2026

    @markbac
    OwnerAuthor

    Work started on branch docs/56-architecture.


    Generated by Claude Code

  3. markbac commented on Oct 3, 2026

    @markbac
    OwnerAuthor

    Fixed in #57 and merged to main.


    Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions