Quill¶

Getting Started

• Overview
  • Thread Safety
  • Logging types
  • Reliable Logging Mechanism
  • Manual Log Flushing
  • Synchronized Logs for Debugging
  • Handling Application Crashes
  • Log Messages Timestamp Order
  • Number of Backend Threads
  • Latency of the First Log Message
  • Configuration
  • Frontend (caller-thread)
  • Backend
  • Design
• Installing
  • Package Managers
  • CMake-Integration
• Quick Start
  • Quickest Setup
  • Architecture Overview
  • Detailed Setup
• Cheat Sheet
  • Introduction
  • Preprocessor Configuration Flags
  • Hiding File Names and Functions From Build Binaries
  • LOGV Macros
  • Logging Built-in Types and Strings
  • Logging Arithmetic C-style Arrays
  • Logging Enums
  • Logging Strings Without Additional Copy
  • Logging STL Library Types
  • Logging Nested STL Library Types
  • Logging Wide Strings
  • Logging User Defined Types
  • Helper Macros for Logging User Defined Types
• Frequently Asked Questions (FAQ)
  • Getting Started
  • Core Concepts & Behavior
  • Logging Different Types
  • Performance & Optimization
  • Advanced Configuration

Tutorial

• Backend Options
  • Example Usage
  • Character Sanitization
• Backtrace Logging
  • Store messages in the ring buffer and display them when LOG_ERROR is logged
  • Store messages in the ring buffer and display them on demand
• Basic Example
• Binary Protocols
  • Logging Binary Protocols with Deferred Formatting
  • Implementation Steps
  • Using with SBE (Simple Binary Encoding)
  • Binary Protocol Logging with Custom Message Types
  • Raw Binary File Writing
• CSV Writing
  • CSV Writing To File
  • CSV Writing To Existing Sink
• Filters
  • Filtering Logs with the Built-In Filter
  • Creating a Custom Log Filter
• Formatters
  • Customising the timestamp
  • Customizing Log Message Formats
  • Advanced Pattern Formatter Configuration
• Frontend Options
  • Error Notifications
  • Queue Memory Management
  • Example Usage
• JSON Logging
  • Logging Json to Console
  • Logging Json to File
  • Customising Json Format
  • Combining JSON and Standard Log Patterns
• Log Tagging
  • Tag Processing in Sinks
• Loggers
  • Logger Creation
  • Logger Retrieval
  • Logger Removal
  • Simplifying Logger Usage for Single Root Logger Applications
• Log Levels
  • Runtime Log Level Control
  • Compile-Time Log Level Control
  • Interaction Between Runtime and Compile-Time Controls
  • Available Log Levels
• Logging Macros
  • Compile-Time Log Level Filtering
  • Standard Logging Macros
  • Value-based Macros (LOGV)
  • JSON Logging Macros (LOGJ)
  • Dynamic Logging Macros
  • Runtime Metadata Logging Macro
• Sinks
  • Sharing Sinks Between Loggers
  • Customizing the Library with User-Defined Sinks
  • Routing Log Messages to Multiple Sinks
• Sink Types
  • ConsoleSink
  • FileSink
  • RotatingFileSink
  • JsonFileSink/JsonConsoleSink
  • RotatingJsonFileSink
  • SyslogSink
  • SystemdSink
  • StreamSink
  • StreamSink
  • AndroidSink
  • NullSink
  • SystemdSink
• Timestamp Types
  • Timestamp Recording
  • Timestamp Methods
  • Providing a Custom Timestamp
  • Getting a Synchronized Timestamp with the Backend Thread TSC Clock
• Wide Strings
  • How It Works
  • Wide String Logging Example
• Macro-Free Mode
  • Performance Trade-offs
  • Available Functions
  • Usage

User API

• User’s API
  • Backend Options
  • Backend Class
  • BackendTscClock Class
  • SignalHandler Options
  • Frontend Options
  • Frontend Class
  • Log Levels
  • LoggerImpl Class
  • PatternFormatter Class
  • PatternFormatterOptions Class
  • Sink Class
  • Filter Class
  • FileSinkConfig Class
  • FileSink Class
  • RotatingSink Class
  • RotatingFileSinkConfig Class
  • JsonFileSink Class
  • JsonConsoleSink Class
  • SyslogSink Class
  • SyslogSinkConfig Class
  • SystemdSink Class
  • SystemdSinkConfig Class
  • CsvWriter Class