Skip to content

Examples ​

Examples are the primary BitLogger learning path. Each page starts from an application concern, shows the complete minimum code, and then points to the API reference for exact contracts.

Choose A Flow ​

NeedStart hereThen extend with
Print structured logs to a terminalConsole and fieldsText formatting
Keep local logs with bounded disk useFile rotationTarget boundaries
Build logging from app configurationConfigurationQueueing
Avoid blocking a native application on writesAsync lifecycleSink composition

Repository Examples ​

The runnable sources live under examples/. The guides below explain their intended use instead of duplicating every API detail:

  • examples/console_basic for terminal and JSON records
  • examples/config_build for parsed configuration
  • examples/file_rotation for native file output
  • examples/async_basic for the async lifecycle
  • examples/presets, examples/text_formatter, and examples/style_tags for follow-on customization

Use the API reference when a guide links to a symbol and you need its full signature or edge-case behavior.

Published from the repository docs folder with VitePress.