User Guide
Welcome to the XenoAtom.Logging documentation.
This section is organized as a practical map: start quickly, then go deeper by topic based on your use case.
Start here
- Getting Started: install packages, configure logging, and run your first sync/async setup.
- Migration from Microsoft.Extensions.Logging: API mapping and rollout guidance.
- Package Consumption Guide: package layout and when to use each package.
Core runtime topics
- Filtering and Routing: logger hierarchy, writer fan-out, and filters.
- File and JSON Writers: rolling files, retention, JSONL output, and failure handling.
- Shutdown Semantics: flushing and lifecycle behavior at app exit.
- Thread Safety: what is safe concurrently and what must be configured carefully.
Formatting and generated APIs
- Log Formatters: built-in formatters, template syntax, and custom formatter generation.
- Source-generated Logging:
[LogMethod]and diagnostics.
Terminal and UI output
- Terminal Integration:
TerminalLogWriter,TerminalLogControlWriter, markup, and styling. - Terminal Visual Examples: rendered examples and styling walkthrough.
Performance and deployment
- Benchmarks: benchmark setup, scenarios, and interpretation guidance.
- Native AOT and Trimming: AOT/trimming-oriented behavior and constraints.